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

#include <otbAmplitudeFunctor.h>

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

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

Public Types
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 AmplitudeFunctor	Self
typedef itk::Object	Superclass
typedef itk::VariableLengthVector< ScalarType >	VectorPixelType
Public Types inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
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 const char *	GetNameOfClass () const
Public Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
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 void	SetChannelIndex (unsigned int channelPosition, unsigned int channel)
virtual void	SetChannelList (std::vector< unsigned int > channels)
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 ()

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
static Pointer	New ()
	AmplitudeFunctor ()
	~AmplitudeFunctor () override
const char *	GetDescription () const
unsigned int	GetOutputSize () const override
OutputPixelType	operator() (const VectorPixelType &inPixel) const override
OutputPixelType	operator() (ScalarType) const override
OutputPixelType	operator() (const RGBPixelType &inPixel) const override
OutputPixelType	operator() (const RGBAPixelType &inPixel) const override
ScalarType	ComputeAmplitude (ScalarType a, ScalarType b) const

Additional Inherited Members
Protected Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
	ChannelSelectorFunctor ()
	~ChannelSelectorFunctor () override

Detailed Description

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

Compute the module from the selected channel in the input.

See also

PhaseFunctor ChannelSelectorFunctor

Definition at line 40 of file otbAmplitudeFunctor.h.

Member Typedef Documentation

ConstPointer

template<class TInputPixel >

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

Definition at line 47 of file otbAmplitudeFunctor.h.

OutputPixelType

template<class TInputPixel >

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

Definition at line 61 of file otbAmplitudeFunctor.h.

PixelType

template<class TInputPixel >

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

Definition at line 53 of file otbAmplitudeFunctor.h.

Pointer

template<class TInputPixel >

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

Definition at line 46 of file otbAmplitudeFunctor.h.

RGBAPixelType

template<class TInputPixel >

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

Definition at line 59 of file otbAmplitudeFunctor.h.

RGBPixelType

template<class TInputPixel >

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

Definition at line 58 of file otbAmplitudeFunctor.h.

ScalarType

template<class TInputPixel >

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

Definition at line 56 of file otbAmplitudeFunctor.h.

Self

template<class TInputPixel >

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

Standard class typedefs

Definition at line 44 of file otbAmplitudeFunctor.h.

Superclass

template<class TInputPixel >

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

Definition at line 45 of file otbAmplitudeFunctor.h.

VectorPixelType

template<class TInputPixel >

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

Definition at line 57 of file otbAmplitudeFunctor.h.

Constructor & Destructor Documentation

AmplitudeFunctor()

template<class TInputPixel >

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

inline

Constructor

Definition at line 64 of file otbAmplitudeFunctor.h.

References otb::Function::ChannelSelectorFunctor< TInputPixel >::SetChannelList().

~AmplitudeFunctor()

template<class TInputPixel >

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

inlineoverride

Destructor

Definition at line 74 of file otbAmplitudeFunctor.h.

Member Function Documentation

ComputeAmplitude()

template<class TInputPixel >

ScalarType otb::Function::AmplitudeFunctor< TInputPixel >::ComputeAmplitude ( ScalarType  a, ScalarType  b  ) const

inlineprivate

Constructor

Definition at line 132 of file otbAmplitudeFunctor.h.

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

CreateAnother()

template<class TInputPixel >

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

(

void

)

const

GetDescription()

template<class TInputPixel >

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

inline

Constructor

Definition at line 78 of file otbAmplitudeFunctor.h.

GetNameOfClass()

template<class TInputPixel >

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

virtual

Runtime information

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

GetOutputSize()

template<class TInputPixel >

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

inlineoverridevirtual

Constructor

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

Definition at line 83 of file otbAmplitudeFunctor.h.

New()

template<class TInputPixel >

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

static

Method for creation through the object factory

operator()() [1/4]

template<class TInputPixel >

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

inlineoverridevirtual

Constructor

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

Definition at line 118 of file otbAmplitudeFunctor.h.

References otb::Function::AmplitudeFunctor< TInputPixel >::ComputeAmplitude(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelList().

operator()() [2/4]

template<class TInputPixel >

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

inlineoverridevirtual

Constructor

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

Definition at line 105 of file otbAmplitudeFunctor.h.

References otb::Function::AmplitudeFunctor< TInputPixel >::ComputeAmplitude(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelList().

operator()() [3/4]

template<class TInputPixel >

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

inlineoverridevirtual

Constructor

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

Definition at line 88 of file otbAmplitudeFunctor.h.

References otb::Function::AmplitudeFunctor< TInputPixel >::ComputeAmplitude(), and otb::Function::ChannelSelectorFunctor< TInputPixel >::GetChannelList().

operator()() [4/4]

template<class TInputPixel >

OutputPixelType otb::Function::AmplitudeFunctor< TInputPixel >::operator() ( ScalarType  ) const

inlineoverridevirtual

Constructor

Reimplemented from otb::Function::ChannelSelectorFunctor< TInputPixel >.

Definition at line 99 of file otbAmplitudeFunctor.h.

---

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

• otbAmplitudeFunctor.h