OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members

#include <otbMeanRatioImageFilter.h>

+ Inheritance diagram for otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >:
+ Collaboration diagram for otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef MeanRatioImageFilter Self
 
typedef BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< typename itk::ConstNeighborhoodIterator< TInputImage1 >, typename itk::ConstNeighborhoodIterator< TInputImage2 >, typename TOutputImage::PixelType > > Superclass
 
- Public Types inherited from otb::BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > FunctorType
 
typedef Input1ImageType::ConstPointer Input1ImageConstPointer
 
typedef Input1ImageType::PixelType Input1ImagePixelType
 
typedef Input1ImageType::Pointer Input1ImagePointer
 
typedef Input1ImageType::RegionType Input1ImageRegionType
 
typedef TInputImage1 Input1ImageType
 
typedef Input2ImageType::ConstPointer Input2ImageConstPointer
 
typedef Input2ImageType::PixelType Input2ImagePixelType
 
typedef Input2ImageType::Pointer Input2ImagePointer
 
typedef Input2ImageType::RegionType Input2ImageRegionType
 
typedef TInputImage2 Input2ImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef BinaryFunctorNeighborhoodImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage1, TOutputImage > Superclass
 
typedef itk::ConstNeighborhoodIterator< TInputImage1 > NeighborhoodIteratorType1
 
typedef itk::ConstNeighborhoodIterator< TInputImage2 > NeighborhoodIteratorType2
 
typedef NeighborhoodIteratorType1::RadiusType RadiusType1
 
typedef NeighborhoodIteratorType2::RadiusType RadiusType2
 
typedef itk::Size< Input1ImageType::ImageDimension > RadiusSizeType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetInput1 (const TInputImage1 *image1)
 
void SetInput2 (const TInputImage2 *image2)
 
const TInputImage1 * GetInput1 ()
 
const TInputImage2 * GetInput2 ()
 
FunctorTypeGetFunctor ()
 
void SetFunctor (const FunctorType &functor)
 
virtual void SetRadius (RadiusSizeType _arg)
 
void SetRadius (unsigned int radius)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > >
static Pointer New ()
 

Protected Member Functions

 MeanRatioImageFilter ()
 
 ~MeanRatioImageFilter () override
 
- Protected Member Functions inherited from otb::BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > >
 BinaryFunctorNeighborhoodImageFilter ()
 
 ~BinaryFunctorNeighborhoodImageFilter () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void GenerateInputRequestedRegion (void) override
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from otb::BinaryFunctorNeighborhoodImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio< itk::ConstNeighborhoodIterator< TInputImage1 >, itk::ConstNeighborhoodIterator< TInputImage2 >, TOutputImage::PixelType > >
RadiusSizeType m_Radius
 

Detailed Description

template<class TInputImage1, class TInputImage2, class TOutputImage>
class otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >

Implements neighborhood-wise the computation of mean ratio.

This filter is parametrized over the types of the two input images and the type of the output image.

Numeric conversions (castings) are done by the C++ defaults.

The filter will walk over all the pixels in the two input images, and for each one of them it will do the following:

The filter expect all images to have the same dimension (e.g. all 2D, or all 3D, or all ND)

Definition at line 54 of file otbMeanRatioImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer

Definition at line 67 of file otbMeanRatioImageFilter.h.

◆ Pointer

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
typedef itk::SmartPointer<Self> otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer

Definition at line 66 of file otbMeanRatioImageFilter.h.

◆ Self

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
typedef MeanRatioImageFilter otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self

Standard class typedefs.

Definition at line 61 of file otbMeanRatioImageFilter.h.

◆ Superclass

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
typedef BinaryFunctorNeighborhoodImageFilter<TInputImage1, TInputImage2, TOutputImage, Functor::MeanRatio<typename itk::ConstNeighborhoodIterator<TInputImage1>, typename itk::ConstNeighborhoodIterator<TInputImage2>, typename TOutputImage::PixelType> > otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

Definition at line 65 of file otbMeanRatioImageFilter.h.

Constructor & Destructor Documentation

◆ MeanRatioImageFilter() [1/2]

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::MeanRatioImageFilter ( )
inlineprotected

Definition at line 76 of file otbMeanRatioImageFilter.h.

◆ ~MeanRatioImageFilter()

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::~MeanRatioImageFilter ( )
inlineoverrideprotected

Definition at line 79 of file otbMeanRatioImageFilter.h.

◆ MeanRatioImageFilter() [2/2]

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::MeanRatioImageFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
virtual::itk::LightObject::Pointer otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::CreateAnother ( void  ) const

◆ GetNameOfClass()

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
virtual const char* otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::GetNameOfClass ( ) const
virtual

Macro defining the type

◆ New()

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
static Pointer otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage1 , class TInputImage2 , class TOutputImage >
void otb::MeanRatioImageFilter< TInputImage1, TInputImage2, TOutputImage >::operator= ( const Self )
privatedelete

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