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< Self >	Pointer
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 ValuesVectorType &	GetFilterFunctionValues () const
const ValuesVectorType &	GetFilterFunctionValues6S () 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 ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~FilterFunctionValues () override

Private Member Functions
	FilterFunctionValues (const Self &)=delete
void	operator= (const Self &)=delete

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

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::FilterFunctionValues::ConstPointer

Definition at line 51 of file otbFilterFunctionValues.h.

Pointer

typedef itk::SmartPointer<Self> otb::FilterFunctionValues::Pointer

Definition at line 50 of file otbFilterFunctionValues.h.

Self

typedef FilterFunctionValues otb::FilterFunctionValues::Self

Standard typedefs

Definition at line 48 of file otbFilterFunctionValues.h.

Superclass

typedef itk::DataObject otb::FilterFunctionValues::Superclass

Definition at line 49 of file otbFilterFunctionValues.h.

ValuesVectorType

typedef std::vector<WavelengthSpectralBandType> otb::FilterFunctionValues::ValuesVectorType

Definition at line 60 of file otbFilterFunctionValues.h.

WavelengthSpectralBandType

typedef float otb::FilterFunctionValues::WavelengthSpectralBandType

Definition at line 57 of file otbFilterFunctionValues.h.

Constructor & Destructor Documentation

FilterFunctionValues() [1/2]

otb::FilterFunctionValues::FilterFunctionValues ( )

protected

Constructor

~FilterFunctionValues()

otb::FilterFunctionValues::~FilterFunctionValues ( )

inlineoverrideprotected

Destructor

Definition at line 114 of file otbFilterFunctionValues.h.

FilterFunctionValues() [2/2]

otb::FilterFunctionValues::FilterFunctionValues ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::FilterFunctionValues::CreateAnother

(

void

)

const

GetCenterSpectralValue()

WavelengthSpectralBandType otb::FilterFunctionValues::GetCenterSpectralValue

(

)

const

Compute the center wavelength value for the filter

GetFilterFunctionValues()

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

inline

Get vector that contains the filter function value.

Definition at line 70 of file otbFilterFunctionValues.h.

GetFilterFunctionValues6S()

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

inline

Get vector that contains the filter function value 6S.

Definition at line 83 of file otbFilterFunctionValues.h.

GetMaxSpectralValue()

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetMaxSpectralValue ( )

virtual

Get maximum spectral value. This value is automatically computed.

GetMinSpectralValue()

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetMinSpectralValue ( )

virtual

Get minimum spectral value.

GetNameOfClass()

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

virtual

Type macro

GetUserStep()

virtual WavelengthSpectralBandType otb::FilterFunctionValues::GetUserStep ( )

virtual

Get user step between each wavelength spectral band values.

New()

static Pointer otb::FilterFunctionValues::New ( )

static

Creation through object factory macro

Referenced by otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::UpdateAtmosphericRadiativeTerms(), otb::SurfaceReflectanceToReflectanceFilter< TInputImage, TOutputImage >::UpdateAtmosphericRadiativeTerms(), and otb::SurfaceAdjacencyEffectCorrectionSchemeFilter< TInputImage, TOutputImage >::UpdateAtmosphericRadiativeTerms().

operator=()

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

privatedelete

PrintSelf()

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

overrideprotected

PrintSelf method

SetFilterFunctionValues()

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

inline

Set vector that contains the filter function value.

Definition at line 63 of file otbFilterFunctionValues.h.

SetFilterFunctionValues6S()

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

inline

Get vector that contains the filter function value 6S.

Definition at line 76 of file otbFilterFunctionValues.h.

SetMaxSpectralValue()

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

virtual

Set maximum spectral value. This value is automatically computed.

SetMinSpectralValue()

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

virtual

Set minimum spectral value.

SetUserStep()

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

virtual

Set user step between each wavelength spectral band values.

Member Data Documentation

m_FilterFunctionValues

ValuesVectorType otb::FilterFunctionValues::m_FilterFunctionValues

private

Vector that contains the filter function value.

Definition at line 126 of file otbFilterFunctionValues.h.

m_FilterFunctionValues6S

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

m_MaxSpectralValue

WavelengthSpectralBandType otb::FilterFunctionValues::m_MaxSpectralValue

private

Maximum spectral value (in micro m).

Definition at line 137 of file otbFilterFunctionValues.h.

m_MinSpectralValue

WavelengthSpectralBandType otb::FilterFunctionValues::m_MinSpectralValue

private

Minimum spectral value (in micro m).

Definition at line 134 of file otbFilterFunctionValues.h.

m_UserStep

WavelengthSpectralBandType otb::FilterFunctionValues::m_UserStep

private

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

Definition at line 140 of file otbFilterFunctionValues.h.

---

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

• otbFilterFunctionValues.h