OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::FilterFunctionValues Class Reference

#include <otbFilterFunctionValues.h>

+ Inheritance diagram for otb::FilterFunctionValues:
+ Collaboration diagram for otb::FilterFunctionValues:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef FilterFunctionValues Self
 
typedef itk::DataObject Superclass
 
typedef std::vector
< WavelengthSpectralBandType
ValuesVectorType
 
typedef float WavelengthSpectralBandType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- 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
 
WavelengthSpectralBandType GetCenterSpectralValue () const
 
const ValuesVectorTypeGetFilterFunctionValues () const
 
const ValuesVectorTypeGetFilterFunctionValues6S () const
 
virtual WavelengthSpectralBandType GetMaxSpectralValue ()
 
virtual WavelengthSpectralBandType GetMinSpectralValue ()
 
virtual const char * GetNameOfClass () const
 
virtual WavelengthSpectralBandType GetUserStep ()
 
void SetFilterFunctionValues (const ValuesVectorType &vect)
 
void SetFilterFunctionValues6S (const ValuesVectorType &vect)
 
virtual void SetMaxSpectralValue (WavelengthSpectralBandType _arg)
 
virtual void SetMinSpectralValue (WavelengthSpectralBandType _arg)
 
virtual void SetUserStep (WavelengthSpectralBandType _arg)
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- 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 (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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 itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 ()
 

Protected Member Functions

 FilterFunctionValues ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 ~FilterFunctionValues ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 ()
 

Private Member Functions

 FilterFunctionValues (const Self &)
 
void operator= (const Self &)
 

Private Attributes

ValuesVectorType m_FilterFunctionValues
 
ValuesVectorType m_FilterFunctionValues6S
 
WavelengthSpectralBandType m_MaxSpectralValue
 
WavelengthSpectralBandType m_MinSpectralValue
 
WavelengthSpectralBandType m_UserStep
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

This class contains the values of the filter function for the processed spectral band.

The step between 2 values is 0.0025 micro meter. The class contains the min and the max value. Those value can be directly read from the image metadatas.

Examples:
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 40 of file otbFilterFunctionValues.h.

Member Typedef Documentation

Definition at line 47 of file otbFilterFunctionValues.h.

Definition at line 46 of file otbFilterFunctionValues.h.

Standard typedefs

Definition at line 44 of file otbFilterFunctionValues.h.

Definition at line 45 of file otbFilterFunctionValues.h.

Definition at line 56 of file otbFilterFunctionValues.h.

Definition at line 53 of file otbFilterFunctionValues.h.

Constructor & Destructor Documentation

otb::FilterFunctionValues::FilterFunctionValues ( )
protected

Constructor

otb::FilterFunctionValues::~FilterFunctionValues ( )
inlineprotected

Destructor

Definition at line 110 of file otbFilterFunctionValues.h.

otb::FilterFunctionValues::FilterFunctionValues ( const Self )
private

Member Function Documentation

virtual::itk::LightObject::Pointer otb::FilterFunctionValues::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

WavelengthSpectralBandType otb::FilterFunctionValues::GetCenterSpectralValue ( ) const

Compute the center wavelength value for the filter

const ValuesVectorType& otb::FilterFunctionValues::GetFilterFunctionValues ( ) const
inline

Get vector that contains the filter function value.

Definition at line 66 of file otbFilterFunctionValues.h.

const ValuesVectorType& otb::FilterFunctionValues::GetFilterFunctionValues6S ( ) const
inline

Get vector that contains the filter function value 6S.

Definition at line 79 of file otbFilterFunctionValues.h.

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetMaxSpectralValue ( )
virtual

Get maximum spectral value. This value is automatically computed.

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetMinSpectralValue ( )
virtual

Get minimum spectral value.

virtual const char* otb::FilterFunctionValues::GetNameOfClass ( ) const
virtual

Type macro

Reimplemented from itk::DataObject.

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetUserStep ( )
virtual

Get user step between each wavelength spectral band values.

static Pointer otb::FilterFunctionValues::New ( )
static

Creation through object factory macro

void otb::FilterFunctionValues::operator= ( const Self )
private
void otb::FilterFunctionValues::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

void otb::FilterFunctionValues::SetFilterFunctionValues ( const ValuesVectorType vect)
inline

Set vector that contains the filter function value.

Definition at line 59 of file otbFilterFunctionValues.h.

void otb::FilterFunctionValues::SetFilterFunctionValues6S ( const ValuesVectorType vect)
inline

Get vector that contains the filter function value 6S.

Definition at line 72 of file otbFilterFunctionValues.h.

virtual void otb::FilterFunctionValues::SetMaxSpectralValue ( WavelengthSpectralBandType  _arg)
virtual

Set maximum spectral value. This value is automatically computed.

virtual void otb::FilterFunctionValues::SetMinSpectralValue ( WavelengthSpectralBandType  _arg)
virtual

Set minimum spectral value.

virtual void otb::FilterFunctionValues::SetUserStep ( WavelengthSpectralBandType  _arg)
virtual

Set user step between each wavelength spectral band values.

Member Data Documentation

ValuesVectorType otb::FilterFunctionValues::m_FilterFunctionValues
private

Vector that contains the filter function value.

Definition at line 120 of file otbFilterFunctionValues.h.

ValuesVectorType otb::FilterFunctionValues::m_FilterFunctionValues6S
private

Vector that contains the filter function value in 6S format (step of 0.0025 micro m). There values a computed by 6S. If the UserStep is 0.0025 micro m, then m_FilterFunctionValues is identical as m_FilterFunctionValues6S

Definition at line 125 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType otb::FilterFunctionValues::m_MaxSpectralValue
private

Maximum spectral value (in micro m).

Definition at line 131 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType otb::FilterFunctionValues::m_MinSpectralValue
private

Minimum spectral value (in micro m).

Definition at line 128 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType otb::FilterFunctionValues::m_UserStep
private

User step between each wavelength spectral band values. (in micro micro m)

Definition at line 134 of file otbFilterFunctionValues.h.


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