Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
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

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

#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 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)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 FilterFunctionValues ()
 
 ~FilterFunctionValues ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

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
 

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 38 of file otbFilterFunctionValues.h.

Member Typedef Documentation

Definition at line 45 of file otbFilterFunctionValues.h.

Definition at line 44 of file otbFilterFunctionValues.h.

Standard typedefs

Definition at line 42 of file otbFilterFunctionValues.h.

Definition at line 43 of file otbFilterFunctionValues.h.

Definition at line 54 of file otbFilterFunctionValues.h.

Definition at line 51 of file otbFilterFunctionValues.h.

Constructor & Destructor Documentation

otb::FilterFunctionValues::FilterFunctionValues ( )
protected

Constructor

Definition at line 27 of file otbFilterFunctionValues.cxx.

otb::FilterFunctionValues::~FilterFunctionValues ( )
inlineprotected

Destructor

Definition at line 99 of file otbFilterFunctionValues.h.

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

Member Function Documentation

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

Compute the center wavelength value for the filter

Definition at line 38 of file otbFilterFunctionValues.cxx.

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

Get vector that contains the filter function value.

Definition at line 63 of file otbFilterFunctionValues.h.

Referenced by otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S().

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

Get vector that contains the filter function value 6S.

Definition at line 74 of file otbFilterFunctionValues.h.

Referenced by otb::SIXSTraits::ComputeAtmosphericParameters().

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

Get maximum spectral value. This value is automatically computed.

Referenced by otb::SIXSTraits::ComputeAtmosphericParameters(), and otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S().

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetMinSpectralValue ( )
virtual
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.

Referenced by otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S().

static Pointer otb::FilterFunctionValues::New ( )
static
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.

Definition at line 62 of file otbFilterFunctionValues.cxx.

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

Set vector that contains the filter function value.

Definition at line 57 of file otbFilterFunctionValues.h.

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

Get vector that contains the filter function value 6S.

Definition at line 68 of file otbFilterFunctionValues.h.

Referenced by otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S().

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

Set maximum spectral value. This value is automatically computed.

Referenced by otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S().

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 109 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 113 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType otb::FilterFunctionValues::m_MaxSpectralValue
private

Maximum spectral value (in micro m).

Definition at line 117 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType otb::FilterFunctionValues::m_MinSpectralValue
private

Minimum spectral value (in micro m).

Definition at line 115 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 119 of file otbFilterFunctionValues.h.


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