OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
otb::Function::PhaseFunctor< TInputPixel > Class Template Reference

#include <otbPhaseFunctor.h>

+ Inheritance diagram for otb::Function::PhaseFunctor< TInputPixel >:
+ Collaboration diagram for otb::Function::PhaseFunctor< TInputPixel >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef VectorPixelType OutputPixelType
 
typedef TInputPixel PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::RGBAPixel
< ScalarType
RGBAPixelType
 
typedef itk::RGBPixel< ScalarTypeRGBPixelType
 
typedef itk::NumericTraits
< PixelType >::ValueType 
ScalarType
 
typedef PhaseFunctor 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< SelfPointer
 
typedef itk::RGBAPixel
< ScalarType
RGBAPixelType
 
typedef itk::RGBPixel< ScalarTypeRGBPixelType
 
typedef itk::NumericTraits
< PixelType >::ValueType 
ScalarType
 
typedef ChannelSelectorFunctor Self
 
typedef itk::Object Superclass
 
typedef
itk::VariableLengthVector
< ScalarType
VectorPixelType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const char * GetDescription () const
 
virtual const char * GetNameOfClass () 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
 
 ~PhaseFunctor () override
 
 PhaseFunctor ()
 
- Public Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
virtual unsigned int GetBlueChannelIndex () const
 
virtual unsigned int GetChannelIndex (unsigned int channelPosition) const
 
virtual std::vector< unsigned int > GetChannelList () const
 
const char * GetDescription () const
 
virtual unsigned int GetGreenChannelIndex () const
 
virtual unsigned int GetRedChannelIndex () const
 
virtual bool IsUsingDefaultParameters ()
 
virtual void SetBlueChannelIndex (unsigned int channel)
 
virtual void SetChannelIndex (unsigned int channelPosition, unsigned int channel)
 
virtual void SetChannelList (std::vector< unsigned int > channels)
 
virtual void SetGreenChannelIndex (unsigned int channel)
 
virtual void SetAllChannels (unsigned int channel)
 
virtual void SetRedChannelIndex (unsigned int channel)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Private Member Functions

ScalarType ComputePhase (ScalarType a, ScalarType b) const
 

Additional Inherited Members

- Protected Member Functions inherited from otb::Function::ChannelSelectorFunctor< TInputPixel >
 ~ChannelSelectorFunctor () override
 
 ChannelSelectorFunctor ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

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

Compute the module from the selected channel in the input.

See Also
AmplitudeFunctor ChannelSelectorFunctor

Definition at line 40 of file otbPhaseFunctor.h.

Member Typedef Documentation

template<class TInputPixel >
typedef itk::SmartPointer<const Self> otb::Function::PhaseFunctor< TInputPixel >::ConstPointer

Definition at line 47 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef VectorPixelType otb::Function::PhaseFunctor< TInputPixel >::OutputPixelType

Definition at line 61 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef TInputPixel otb::Function::PhaseFunctor< TInputPixel >::PixelType

Definition at line 53 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::SmartPointer<Self> otb::Function::PhaseFunctor< TInputPixel >::Pointer

Definition at line 46 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::RGBAPixel<ScalarType> otb::Function::PhaseFunctor< TInputPixel >::RGBAPixelType

Definition at line 59 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::RGBPixel<ScalarType> otb::Function::PhaseFunctor< TInputPixel >::RGBPixelType

Definition at line 58 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::NumericTraits<PixelType>::ValueType otb::Function::PhaseFunctor< TInputPixel >::ScalarType

Definition at line 56 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef PhaseFunctor otb::Function::PhaseFunctor< TInputPixel >::Self

Standard class typedefs

Definition at line 44 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::Object otb::Function::PhaseFunctor< TInputPixel >::Superclass

Definition at line 45 of file otbPhaseFunctor.h.

template<class TInputPixel >
typedef itk::VariableLengthVector<ScalarType> otb::Function::PhaseFunctor< TInputPixel >::VectorPixelType

Definition at line 57 of file otbPhaseFunctor.h.

Constructor & Destructor Documentation

template<class TInputPixel >
otb::Function::PhaseFunctor< TInputPixel >::PhaseFunctor ( )
inline
template<class TInputPixel >
otb::Function::PhaseFunctor< TInputPixel >::~PhaseFunctor ( )
inlineoverride

Destructor

Definition at line 74 of file otbPhaseFunctor.h.

Member Function Documentation

template<class TInputPixel >
ScalarType otb::Function::PhaseFunctor< TInputPixel >::ComputePhase ( ScalarType  a,
ScalarType  b 
) const
inlineprivate
template<class TInputPixel >
virtual::itk::LightObject::Pointer otb::Function::PhaseFunctor< TInputPixel >::CreateAnother ( void  ) const
virtual
template<class TInputPixel >
const char* otb::Function::PhaseFunctor< TInputPixel >::GetDescription ( void  ) const
inline

Definition at line 76 of file otbPhaseFunctor.h.

template<class TInputPixel >
virtual const char* otb::Function::PhaseFunctor< TInputPixel >::GetNameOfClass ( ) const
virtual

Runtime information

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

template<class TInputPixel >
unsigned int otb::Function::PhaseFunctor< TInputPixel >::GetOutputSize ( ) const
inlineoverridevirtual

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

Definition at line 79 of file otbPhaseFunctor.h.

template<class TInputPixel >
static Pointer otb::Function::PhaseFunctor< TInputPixel >::New ( )
static

Method for creation through the object factory

template<class TInputPixel >
OutputPixelType otb::Function::PhaseFunctor< TInputPixel >::operator() ( const VectorPixelType inPixel) const
inlineoverridevirtual
template<class TInputPixel >
OutputPixelType otb::Function::PhaseFunctor< TInputPixel >::operator() ( ScalarType  ) const
inlineoverridevirtual

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

Definition at line 95 of file otbPhaseFunctor.h.

template<class TInputPixel >
OutputPixelType otb::Function::PhaseFunctor< TInputPixel >::operator() ( const RGBPixelType inPixel) const
inlineoverridevirtual
template<class TInputPixel >
OutputPixelType otb::Function::PhaseFunctor< TInputPixel >::operator() ( const RGBAPixelType inPixel) const
inlineoverridevirtual

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