otb::Function::ChannelSelectorFunctor< TInputPixel > Class Template Reference

#include <otbChannelSelectorFunctor.h>

Inheritance diagram for otb::Function::ChannelSelectorFunctor< TInputPixel >:

Collaboration diagram for otb::Function::ChannelSelectorFunctor< TInputPixel >:

Public Types
typedef std::vector< unsigned int >	ChannelListType
typedef itk::SmartPointer< const Self >	ConstPointer
typedef VectorPixelType	OutputPixelType
typedef TInputPixel	PixelType
typedef itk::SmartPointer< Self >	Pointer
typedef itk::RGBAPixel< ScalarType >	RGBAPixelType
typedef itk::RGBPixel< ScalarType >	RGBPixelType
typedef itk::NumericTraits< PixelType >::ValueType	ScalarType
typedef ChannelSelectorFunctor	Self
typedef itk::Object	Superclass
typedef itk::VariableLengthVector< ScalarType >	VectorPixelType

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual unsigned int	GetChannelIndex (unsigned int channelPosition) const
virtual std::vector< unsigned int >	GetChannelList () const
const char *	GetDescription () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetOutputSize () const
virtual OutputPixelType	operator() (const RGBAPixelType &inPixel) const
virtual OutputPixelType	operator() (const RGBPixelType &inPixel) const
virtual OutputPixelType	operator() (const VectorPixelType &inPixel) const
virtual OutputPixelType	operator() (ScalarType inPixel) const
virtual void	SetChannelIndex (unsigned int channelPosition, unsigned int channel)
virtual void	SetChannelList (std::vector< unsigned int > channels)

Static Public Member Functions
static Pointer	New ()
ChannelListType	m_ChannelList
bool	usingDefaultParameters
virtual void	SetAllChannels (unsigned int channel)
virtual void	SetRedChannelIndex (unsigned int channel)
virtual void	SetGreenChannelIndex (unsigned int channel)
virtual void	SetBlueChannelIndex (unsigned int channel)
virtual unsigned int	GetRedChannelIndex () const
virtual unsigned int	GetGreenChannelIndex () const
virtual unsigned int	GetBlueChannelIndex () const
virtual bool	IsUsingDefaultParameters ()
	ChannelSelectorFunctor ()
	~ChannelSelectorFunctor () override

Detailed Description

template<class TInputPixel>
class otb::Function::ChannelSelectorFunctor< TInputPixel >

Base class for pixel representation functions.

See also

AmplitudeFunctor PhaseFunctor

Definition at line 45 of file otbChannelSelectorFunctor.h.

Member Typedef Documentation

ChannelListType

template<class TInputPixel >

typedef std::vector<unsigned int> otb::Function::ChannelSelectorFunctor< TInputPixel >::ChannelListType

Definition at line 68 of file otbChannelSelectorFunctor.h.

ConstPointer

template<class TInputPixel >

typedef itk::SmartPointer<const Self> otb::Function::ChannelSelectorFunctor< TInputPixel >::ConstPointer

Definition at line 52 of file otbChannelSelectorFunctor.h.

OutputPixelType

template<class TInputPixel >

typedef VectorPixelType otb::Function::ChannelSelectorFunctor< TInputPixel >::OutputPixelType

Definition at line 66 of file otbChannelSelectorFunctor.h.

PixelType

template<class TInputPixel >

typedef TInputPixel otb::Function::ChannelSelectorFunctor< TInputPixel >::PixelType

Definition at line 58 of file otbChannelSelectorFunctor.h.

Pointer

template<class TInputPixel >

typedef itk::SmartPointer<Self> otb::Function::ChannelSelectorFunctor< TInputPixel >::Pointer

Definition at line 51 of file otbChannelSelectorFunctor.h.

RGBAPixelType

template<class TInputPixel >

typedef itk::RGBAPixel<ScalarType> otb::Function::ChannelSelectorFunctor< TInputPixel >::RGBAPixelType

Definition at line 64 of file otbChannelSelectorFunctor.h.

RGBPixelType

template<class TInputPixel >

typedef itk::RGBPixel<ScalarType> otb::Function::ChannelSelectorFunctor< TInputPixel >::RGBPixelType

Definition at line 63 of file otbChannelSelectorFunctor.h.

ScalarType

template<class TInputPixel >

typedef itk::NumericTraits<PixelType>::ValueType otb::Function::ChannelSelectorFunctor< TInputPixel >::ScalarType

Definition at line 61 of file otbChannelSelectorFunctor.h.

Self

template<class TInputPixel >

typedef ChannelSelectorFunctor otb::Function::ChannelSelectorFunctor< TInputPixel >::Self

Standard class typedefs

Definition at line 49 of file otbChannelSelectorFunctor.h.

Superclass

template<class TInputPixel >

typedef itk::Object otb::Function::ChannelSelectorFunctor< TInputPixel >::Superclass

Definition at line 50 of file otbChannelSelectorFunctor.h.

VectorPixelType

template<class TInputPixel >

typedef itk::VariableLengthVector<ScalarType> otb::Function::ChannelSelectorFunctor< TInputPixel >::VectorPixelType

Definition at line 62 of file otbChannelSelectorFunctor.h.

Constructor & Destructor Documentation

ChannelSelectorFunctor()

template<class TInputPixel >

otb::Function::ChannelSelectorFunctor< TInputPixel >::ChannelSelectorFunctor ( )

inlineprotected

Constructor

Definition at line 225 of file otbChannelSelectorFunctor.h.

References otb::find(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

~ChannelSelectorFunctor()

template<class TInputPixel >

otb::Function::ChannelSelectorFunctor< TInputPixel >::~ChannelSelectorFunctor ( )

inlineoverrideprotected

Destructor

Definition at line 252 of file otbChannelSelectorFunctor.h.

Member Function Documentation

CreateAnother()

template<class TInputPixel >

virtual::itk::LightObject::Pointer otb::Function::ChannelSelectorFunctor< TInputPixel >::CreateAnother

(

void

)

const

GetBlueChannelIndex()

template<class TInputPixel >

virtual unsigned int otb::Function::ChannelSelectorFunctor< TInputPixel >::GetBlueChannelIndex ( ) const

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 213 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

GetChannelIndex()

template<class TInputPixel >

virtual unsigned int otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelIndex ( unsigned int  channelPosition ) const

inlinevirtual

Definition at line 153 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

GetChannelList()

template<class TInputPixel >

virtual std::vector<unsigned int> otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelList ( ) const

inlinevirtual

Definition at line 132 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

Referenced by otb::Function::AmplitudeFunctor< TInputPixel >::operator()(), and otb::Function::PhaseFunctor< TInputPixel >::operator()().

GetDescription()

template<class TInputPixel >

const char* otb::Function::ChannelSelectorFunctor< TInputPixel >::GetDescription ( ) const

inline

Definition at line 70 of file otbChannelSelectorFunctor.h.

GetGreenChannelIndex()

template<class TInputPixel >

virtual unsigned int otb::Function::ChannelSelectorFunctor< TInputPixel >::GetGreenChannelIndex ( ) const

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 209 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

GetNameOfClass()

template<class TInputPixel >

virtual const char* otb::Function::ChannelSelectorFunctor< TInputPixel >::GetNameOfClass ( ) const

virtual

Runtime information

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

GetOutputSize()

template<class TInputPixel >

virtual unsigned int otb::Function::ChannelSelectorFunctor< TInputPixel >::GetOutputSize ( ) const

inlinevirtual

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

Definition at line 127 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

GetRedChannelIndex()

template<class TInputPixel >

virtual unsigned int otb::Function::ChannelSelectorFunctor< TInputPixel >::GetRedChannelIndex ( ) const

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 205 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

IsUsingDefaultParameters()

template<class TInputPixel >

virtual bool otb::Function::ChannelSelectorFunctor< TInputPixel >::IsUsingDefaultParameters ( )

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 218 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

New()

template<class TInputPixel >

static Pointer otb::Function::ChannelSelectorFunctor< TInputPixel >::New ( )

static

Method for creation through the object factory

operator()() [1/4]

template<class TInputPixel >

virtual OutputPixelType otb::Function::ChannelSelectorFunctor< TInputPixel >::operator() ( const RGBAPixelType &  inPixel ) const

inlinevirtual

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

Definition at line 115 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

operator()() [2/4]

template<class TInputPixel >

virtual OutputPixelType otb::Function::ChannelSelectorFunctor< TInputPixel >::operator() ( const RGBPixelType &  inPixel ) const

inlinevirtual

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

Definition at line 103 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

operator()() [3/4]

template<class TInputPixel >

virtual OutputPixelType otb::Function::ChannelSelectorFunctor< TInputPixel >::operator() ( const VectorPixelType &  inPixel ) const

inlinevirtual

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

Definition at line 75 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

operator()() [4/4]

template<class TInputPixel >

virtual OutputPixelType otb::Function::ChannelSelectorFunctor< TInputPixel >::operator() ( ScalarType  inPixel ) const

inlinevirtual

Reimplemented in otb::Function::AmplitudeFunctor< TInputPixel >, and otb::Function::PhaseFunctor< TInputPixel >.

Definition at line 91 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList.

SetAllChannels()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetAllChannels ( unsigned int  channel )

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 163 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

SetBlueChannelIndex()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetBlueChannelIndex ( unsigned int  channel )

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 195 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

SetChannelIndex()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelIndex ( unsigned int  channelPosition, unsigned int  channel  )

inlinevirtual

Definition at line 143 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

SetChannelList()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelList ( std::vector< unsigned int >  channels )

inlinevirtual

Definition at line 137 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

Referenced by otb::Function::AmplitudeFunctor< TInputPixel >::AmplitudeFunctor(), and otb::Function::PhaseFunctor< TInputPixel >::PhaseFunctor().

SetGreenChannelIndex()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetGreenChannelIndex ( unsigned int  channel )

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 185 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

SetRedChannelIndex()

template<class TInputPixel >

virtual void otb::Function::ChannelSelectorFunctor< TInputPixel >::SetRedChannelIndex ( unsigned int  channel )

inlinevirtual

Only for backward compatibility but should not be used

Definition at line 174 of file otbChannelSelectorFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList, and otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters.

Member Data Documentation

m_ChannelList

template<class TInputPixel >

ChannelListType otb::Function::ChannelSelectorFunctor< TInputPixel >::m_ChannelList

private

Only for backward compatibility but should not be used

Definition at line 257 of file otbChannelSelectorFunctor.h.

Referenced by otb::Function::ChannelSelectorFunctor< TInputPixel >::ChannelSelectorFunctor(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetBlueChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelList(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetGreenChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetOutputSize(), otb::Function::ChannelSelectorFunctor< TInputPixel >::GetRedChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::operator()(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetAllChannels(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetBlueChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelList(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetGreenChannelIndex(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::SetRedChannelIndex().

usingDefaultParameters

template<class TInputPixel >

bool otb::Function::ChannelSelectorFunctor< TInputPixel >::usingDefaultParameters

private

Only for backward compatibility but should not be used

Definition at line 258 of file otbChannelSelectorFunctor.h.

Referenced by otb::Function::ChannelSelectorFunctor< TInputPixel >::IsUsingDefaultParameters(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetAllChannels(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetBlueChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelIndex(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelList(), otb::Function::ChannelSelectorFunctor< TInputPixel >::SetGreenChannelIndex(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::SetRedChannelIndex().

---

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

• otbChannelSelectorFunctor.h