OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbImageToNoDataMaskFilter.h>

+ Inheritance diagram for otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Functor::NoDataFunctor< typename TInputImage::PixelType, typename TOutputImage::PixelType > FunctorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageToNoDataMaskFilter Self
 
typedef itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, FunctorTypeSuperclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetInsideValue (const typename TOutputImage::PixelType &value)
 
void SetNaNIsNoData (bool nanIsNoData)
 
void SetOutsideValue (const typename TOutputImage::PixelType &value)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
 ImageToNoDataMaskFilter ()
 
 ~ImageToNoDataMaskFilter () override
 

Private Member Functions

 ImageToNoDataMaskFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<typename TInputImage, typename TOutputImage>
class otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >

Builds a no-data mask image from no-data flags and values.

This filter reads the no-data flags (a boolean vector indicating for each band if a no-data value exists) and values (the actual value to be used as no-data for each band) from MetaDataDictionary, and builds a binary mask indicating presence or absence of no-data for each pixel.

If NaNIsNoData is true, NaN pixels will also be considered as no-data pixels.

Definition at line 82 of file otbImageToNoDataMaskFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
typedef itk::SmartPointer<const Self> otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 91 of file otbImageToNoDataMaskFilter.h.

◆ FunctorType

template<typename TInputImage , typename TOutputImage >
typedef Functor::NoDataFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType> otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::FunctorType

Definition at line 86 of file otbImageToNoDataMaskFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
typedef itk::SmartPointer<Self> otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::Pointer

Definition at line 90 of file otbImageToNoDataMaskFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
typedef ImageToNoDataMaskFilter otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::Self

Definition at line 88 of file otbImageToNoDataMaskFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
typedef itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, FunctorType> otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::Superclass

Definition at line 89 of file otbImageToNoDataMaskFilter.h.

Constructor & Destructor Documentation

◆ ImageToNoDataMaskFilter() [1/2]

template<typename TInputImage , typename TOutputImage >
otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::ImageToNoDataMaskFilter ( )
inlineprotected

Definition at line 128 of file otbImageToNoDataMaskFilter.h.

◆ ~ImageToNoDataMaskFilter()

template<typename TInputImage , typename TOutputImage >
otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::~ImageToNoDataMaskFilter ( )
inlineoverrideprotected

Definition at line 132 of file otbImageToNoDataMaskFilter.h.

◆ ImageToNoDataMaskFilter() [2/2]

template<typename TInputImage , typename TOutputImage >
otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::ImageToNoDataMaskFilter ( const Self )
privatedelete

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
inlineoverrideprotected

Definition at line 136 of file otbImageToNoDataMaskFilter.h.

References otb::ReadNoDataFlags().

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
virtual const char* otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::New ( )
static

Type macro

◆ operator=()

template<typename TInputImage , typename TOutputImage >
void otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::operator= ( const Self )
privatedelete

◆ SetInsideValue()

template<typename TInputImage , typename TOutputImage >
void otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::SetInsideValue ( const typename TOutputImage::PixelType &  value)
inline

Set inside value of output mask. This value will be used to indicate absence of no-data for the pixel in the output mask

Definition at line 103 of file otbImageToNoDataMaskFilter.h.

References value().

◆ SetNaNIsNoData()

template<typename TInputImage , typename TOutputImage >
void otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::SetNaNIsNoData ( bool  nanIsNoData)
inline

Set the NaN is no data flags

Parameters
nanIsNoDataIf true, NaN values will be considered as no-data as well (default is false)

Definition at line 122 of file otbImageToNoDataMaskFilter.h.

◆ SetOutsideValue()

template<typename TInputImage , typename TOutputImage >
void otb::ImageToNoDataMaskFilter< TInputImage, TOutputImage >::SetOutsideValue ( const typename TOutputImage::PixelType &  value)
inline

Set outside value of output mask. This value will be used to indicate presence of no-data for the pixel in the output mask

Definition at line 112 of file otbImageToNoDataMaskFilter.h.

References value().


The documentation for this class was generated from the following file: