OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter > Class Template Reference

#include <otbImageToProfileFilter.h>

+ Inheritance diagram for otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >:
+ Collaboration diagram for otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef TFilter FilterType
 
typedef Superclass::InputImagePointer InputImagePointerType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputImageListPointerType OutputImageListPointerType
 
typedef Superclass::OutputImageListType OutputImageListType
 
typedef TOutputImage OutputImageType
 
typedef TParameter ParameterType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageToProfileFilter Self
 
typedef ImageToImageListFilter< TInputImage, TOutputImage > Superclass
 
- Public Types inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputImageListType OutputImageListType
 
typedef Superclass::OutputImagePointerType OutputImagePointerType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageToImageListFilter Self
 
typedef InputImageType::SizeType SizeType
 
typedef ImageListSource< TOutputImage > Superclass
 
typedef InputImageType::ValueType ValueType
 
- Public Types inherited from otb::ImageListSource< TOutputImage >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef OutputImageListType::ConstPointer OutputImageListConstPointerType
 
typedef OutputImageListType::Pointer OutputImageListPointerType
 
typedef ImageList< OutputImageTypeOutputImageListType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageListSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual ParameterType GetInitialValue ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetProfileSize ()
 
virtual ParameterType GetStep ()
 
virtual void SetInitialValue (ParameterType _arg)
 
virtual void SetProfileSize (unsigned int _arg)
 
virtual void SetStep (ParameterType _arg)
 
- Public Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void SetInput (const InputImageType *image)
 
InputImageTypeGetInput (void)
 
- Public Member Functions inherited from otb::ImageListSource< TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputImageListTypeGetOutput (void)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageListSource< TOutputImage >
static Pointer New ()
 
FilterPointerType m_Filter
 
unsigned int m_ProfileSize
 
ParameterType m_InitialValue
 
ParameterType m_Step
 
unsigned int m_OutputIndex
 
virtual void SetOutputIndex (unsigned int _arg)
 
virtual unsigned int GetOutputIndex ()
 
virtual void SetProfileParameter (ParameterType)
 
 itkGetObjectMacro (Filter, FilterType)
 
void GenerateData (void) override
 
void GenerateOutputInformation (void) override
 
void GenerateInputRequestedRegion (void) override
 
 ImageToProfileFilter ()
 
 ~ImageToProfileFilter () override=default
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ImageToProfileFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Static Public Attributes inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Protected Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
 ImageToImageListFilter ()
 
 ~ImageToImageListFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from otb::ImageListSource< TOutputImage >
 ImageListSource ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ImageListSource () override
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFilter, class TParameter = unsigned int>
class otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >

Base class to produce a profile of the response of a given filter for a range of parameter.

Let $ f $ denote an image, and $ \phi_{N}$ an image operator with the parameter $ N $ . A profile $ \Pi_{\phi}(f)$ of $ f $ by $ \phi $ is defined as follows:

\[ \Pi_{\phi}(f)= \{\phi_{n}(f), n \in \{n_{1},\ldots, n_{N}\} \} \]

with $ \{n_{1},\ldots, n_{N}\} $ being a range of parameter. This class is a base class templated by the type of the filter $ \phi $. The SetProfileParameter() is a virtual method meant to be rewritten so that the filter can be correctly set up in sub-classes.

See also
MorphologicalOpeningProfileFilter
MorhologicalClosingProfileFilter

Definition at line 47 of file otbImageToProfileFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef itk::SmartPointer<const Self> otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::ConstPointer

Definition at line 54 of file otbImageToProfileFilter.h.

◆ FilterPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef FilterType::Pointer otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::FilterPointerType

Definition at line 67 of file otbImageToProfileFilter.h.

◆ FilterType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef TFilter otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::FilterType

Definition at line 66 of file otbImageToProfileFilter.h.

◆ InputImagePointerType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef Superclass::InputImagePointer otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::InputImagePointerType

Definition at line 70 of file otbImageToProfileFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef TInputImage otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::InputImageType

Template parameters typedefs

Definition at line 60 of file otbImageToProfileFilter.h.

◆ OutputImageListPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef Superclass::OutputImageListPointerType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::OutputImageListPointerType

Definition at line 69 of file otbImageToProfileFilter.h.

◆ OutputImageListType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef Superclass::OutputImageListType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::OutputImageListType

Definition at line 68 of file otbImageToProfileFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef TOutputImage otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::OutputImageType

Definition at line 64 of file otbImageToProfileFilter.h.

◆ ParameterType

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef TParameter otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::ParameterType

Definition at line 65 of file otbImageToProfileFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef itk::SmartPointer<Self> otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::Pointer

Definition at line 53 of file otbImageToProfileFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef ImageToProfileFilter otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::Self

Standard typedefs

Definition at line 51 of file otbImageToProfileFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
typedef ImageToImageListFilter<TInputImage, TOutputImage> otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::Superclass

Definition at line 52 of file otbImageToProfileFilter.h.

Constructor & Destructor Documentation

◆ ImageToProfileFilter() [1/2]

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::ImageToProfileFilter ( )
protected

Constructor

◆ ~ImageToProfileFilter()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::~ImageToProfileFilter ( )
overrideprotecteddefault

Destructor

◆ ImageToProfileFilter() [2/2]

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::ImageToProfileFilter ( const Self )
privatedelete

The filter used to compute the profile

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual::itk::LightObject::Pointer otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GenerateData ( void  )
overrideprotected

GenerateData method

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GenerateInputRequestedRegion ( void  )
overrideprotected

Generate input requested region

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GenerateOutputInformation ( void  )
overrideprotected

GenerateOutputInformation method

◆ GetInitialValue()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual ParameterType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GetInitialValue ( )
virtual

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual const char* otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

Reimplemented from otb::ImageToImageListFilter< TInputImage, TOutputImage >.

◆ GetOutputIndex()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual unsigned int otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GetOutputIndex ( )
virtual

The filter used to compute the profile

◆ GetProfileSize()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual unsigned int otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GetProfileSize ( )
virtual

◆ GetStep()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual ParameterType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::GetStep ( )
virtual

◆ itkGetObjectMacro()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::itkGetObjectMacro ( Filter  ,
FilterType   
)
protected

Get the pointer to the filter

◆ New()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
static Pointer otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::New ( )
static

Type macro

◆ operator=()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::operator= ( const Self )
privatedelete

The filter used to compute the profile

◆ PrintSelf()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

◆ SetInitialValue()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::SetInitialValue ( ParameterType  _arg)
virtual

Get/Set the initial value

◆ SetOutputIndex()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::SetOutputIndex ( unsigned int  _arg)
virtual

Get/Set the output index

◆ SetProfileParameter()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::SetProfileParameter ( ParameterType  )
inlineprotectedvirtual

Set the profile parameter

Definition at line 93 of file otbImageToProfileFilter.h.

◆ SetProfileSize()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::SetProfileSize ( unsigned int  _arg)
virtual

Get/Set the profile size

◆ SetStep()

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
virtual void otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::SetStep ( ParameterType  _arg)
virtual

Get/Set the profile step

Member Data Documentation

◆ m_Filter

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
FilterPointerType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::m_Filter
private

The filter used to compute the profile

Definition at line 123 of file otbImageToProfileFilter.h.

◆ m_InitialValue

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
ParameterType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::m_InitialValue
private

Initial value

Definition at line 129 of file otbImageToProfileFilter.h.

◆ m_OutputIndex

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
unsigned int otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::m_OutputIndex
private

The index of the output of the filter used for the profile

Definition at line 135 of file otbImageToProfileFilter.h.

◆ m_ProfileSize

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
unsigned int otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::m_ProfileSize
private

The profile parameters

Definition at line 126 of file otbImageToProfileFilter.h.

◆ m_Step

template<class TInputImage , class TOutputImage , class TFilter , class TParameter = unsigned int>
ParameterType otb::ImageToProfileFilter< TInputImage, TOutputImage, TFilter, TParameter >::m_Step
private

Step

Definition at line 132 of file otbImageToProfileFilter.h.


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