OTB  9.0.0
Orfeo Toolbox
List of all members
otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbReflectanceToImageImageFilter.h>

+ Inheritance diagram for otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >:
typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef Functor::ReflectanceToImageImageFunctor< typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType > FunctorType
 
typedef ReflectanceToImageImageFilter Self
 
typedef UnaryImageFunctorWithVectorImageFilter< InputImageType, OutputImageType, FunctorTypeSuperclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputPixelType
 
typedef InputImageType::InternalPixelType InputInternalPixelType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef OutputImageType::InternalPixelType OutputInternalPixelType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef itk::VariableLengthVector< double > VectorType
 
typedef InputImageType::SizeType SizeType
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
VectorType m_Alpha
 
VectorType m_Beta
 
double m_ZenithalSolarAngle
 
double m_FluxNormalizationCoefficient
 
VectorType m_SolarIllumination
 
bool m_IsSetFluxNormalizationCoefficient
 
int m_Day
 
int m_Month
 
double m_SolarDistance
 
bool m_IsSetSolarDistance
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetAlpha (VectorType _arg)
 
virtual const VectorTypeGetAlpha () const
 
virtual void SetBeta (VectorType _arg)
 
virtual const VectorTypeGetBeta () const
 
virtual void SetSolarIllumination (VectorType _arg)
 
virtual const VectorTypeGetSolarIllumination () const
 
virtual void SetZenithalSolarAngle (double _arg)
 
virtual const double & GetZenithalSolarAngle () const
 
virtual void SetElevationSolarAngle (double elevationAngle)
 
virtual double GetElevationSolarAngle () const
 
void SetFluxNormalizationCoefficient (double coef)
 
void SetSolarDistance (double value)
 
virtual const double & GetSolarDistance () const
 
virtual void SetIsSetSolarDistance (bool _arg)
 
virtual const bool & GetIsSetSolarDistance () const
 
virtual void SetDay (int _arg)
 
virtual const int & GetDay () const
 
virtual void SetMonth (int _arg)
 
virtual const int & GetMonth () const
 
 ReflectanceToImageImageFilter ()
 
 ~ReflectanceToImageImageFilter () override
 
void BeforeThreadedGenerateData (void) override
 

Additional Inherited Members

- Public Types inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef UnaryImageFunctorWithVectorImageFilter Self
 
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage > Superclass
 
typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > FunctorType
 
typedef InputImageType::PixelType InputPixelType
 
typedef InputImageType::InternalPixelType InputInternalPixelType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef OutputImageType::InternalPixelType OutputInternalPixelType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef InputImageType::SizeType SizeType
 
typedef std::vector< FunctorTypeFunctorVectorType
 
- Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
FunctorVectorTypeGetFunctorVector (void)
 
- Static Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static Pointer New ()
 
- Static Public Attributes inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Protected Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToImageImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
 UnaryImageFunctorWithVectorImageFilter ()
 
 ~UnaryImageFunctorWithVectorImageFilter () override
 
void GenerateOutputInformation () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >

Convert a reflectance into a raw value value.

Transform a reflectance image into a classical image image. For this it uses the functor ReflectanceToImageFunctor calling for each component of each pixel. The flux normalization coefficient (that is the ratio solar distance over mean solar distance) can be directly set, as well as the solar distance (in AU), or the user can give the day and the month of the observation and the class will used a coefficient given by a 6S routine that will give the corresponding coefficient. To note that in the case, 6S gives the square of the distances ratio.

For Spot image in the dimap format, the correction parameters are retrieved automatically from the metadata

Definition at line 130 of file otbReflectanceToImageImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::ConstPointer

"typedef" to simplify the variables definition and the declaration.

Definition at line 150 of file otbReflectanceToImageImageFilter.h.

◆ FunctorType

template<class TInputImage , class TOutputImage >
typedef Functor::ReflectanceToImageImageFunctor<typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType> otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::FunctorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 144 of file otbReflectanceToImageImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::InputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 161 of file otbReflectanceToImageImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
typedef TInputImage otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::InputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 142 of file otbReflectanceToImageImageFilter.h.

◆ InputInternalPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::InternalPixelType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 160 of file otbReflectanceToImageImageFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::InputPixelType

Supported images definition.

Definition at line 156 of file otbReflectanceToImageImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 164 of file otbReflectanceToImageImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
typedef TOutputImage otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::OutputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 143 of file otbReflectanceToImageImageFilter.h.

◆ OutputInternalPixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::InternalPixelType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 163 of file otbReflectanceToImageImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::OutputPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 162 of file otbReflectanceToImageImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::Pointer

"typedef" to simplify the variables definition and the declaration.

Definition at line 149 of file otbReflectanceToImageImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
typedef ReflectanceToImageImageFilter otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::Self

"typedef" for standard classes.

Definition at line 147 of file otbReflectanceToImageImageFilter.h.

◆ SizeType

template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SizeType

Image size "typedef" definition.

Definition at line 169 of file otbReflectanceToImageImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef UnaryImageFunctorWithVectorImageFilter<InputImageType, OutputImageType, FunctorType> otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::Superclass

"typedef" to simplify the variables definition and the declaration.

Definition at line 148 of file otbReflectanceToImageImageFilter.h.

◆ VectorType

template<class TInputImage , class TOutputImage >
typedef itk::VariableLengthVector<double> otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::VectorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 166 of file otbReflectanceToImageImageFilter.h.

Constructor & Destructor Documentation

◆ ReflectanceToImageImageFilter()

template<class TInputImage , class TOutputImage >
otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::ReflectanceToImageImageFilter ( )
inlineprotected

Constructor

Definition at line 252 of file otbReflectanceToImageImageFilter.h.

◆ ~ReflectanceToImageImageFilter()

template<class TInputImage , class TOutputImage >
otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::~ReflectanceToImageImageFilter ( )
inlineoverrideprotected

Destructor

Definition at line 268 of file otbReflectanceToImageImageFilter.h.

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
inlineoverrideprotected

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

"typedef" to simplify the variables definition and the declaration.

◆ GetAlpha()

template<class TInputImage , class TOutputImage >
virtual const VectorType& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetAlpha ( ) const
virtual

Give the absolute calibration gains.

◆ GetBeta()

template<class TInputImage , class TOutputImage >
virtual const VectorType& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetBeta ( ) const
virtual

Give the absolute calibration bias.

◆ GetDay()

template<class TInputImage , class TOutputImage >
virtual const int& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetDay ( ) const
virtual

Get the acquisition day.

◆ GetElevationSolarAngle()

template<class TInputImage , class TOutputImage >
virtual double otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetElevationSolarAngle ( ) const
inlinevirtual

"typedef" to simplify the variables definition and the declaration.

Definition at line 207 of file otbReflectanceToImageImageFilter.h.

◆ GetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >
virtual const bool& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetIsSetSolarDistance ( ) const
virtual

Give the IsSetSolarDistance boolean.

◆ GetMonth()

template<class TInputImage , class TOutputImage >
virtual const int& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetMonth ( ) const
virtual

Set the acquisition month.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

return class name.

◆ GetSolarDistance()

template<class TInputImage , class TOutputImage >
virtual const double& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetSolarDistance ( ) const
virtual

Give the solar distance.

◆ GetSolarIllumination()

template<class TInputImage , class TOutputImage >
virtual const VectorType& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetSolarIllumination ( ) const
virtual

Give the solar illumination value.

◆ GetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >
virtual const double& otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::GetZenithalSolarAngle ( ) const
virtual

Give the zenithal solar angle.

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::New ( )
static

object factory method.

◆ SetAlpha()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetAlpha ( VectorType  _arg)
virtual

Set the absolute calibration gains.

◆ SetBeta()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetBeta ( VectorType  _arg)
virtual

Set the absolute calibration bias.

◆ SetDay()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetDay ( int  _arg)
virtual

Set the acquisition day.

◆ SetElevationSolarAngle()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetElevationSolarAngle ( double  elevationAngle)
inlinevirtual

Set/Get the sun elevation angle (internally handled by the zenithal angle)

Definition at line 196 of file otbReflectanceToImageImageFilter.h.

◆ SetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetFluxNormalizationCoefficient ( double  coef)
inline

Set the flux normalization coefficient.

Definition at line 213 of file otbReflectanceToImageImageFilter.h.

◆ SetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetIsSetSolarDistance ( bool  _arg)
virtual

Set the IsSetSolarDistance boolean.

◆ SetMonth()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetMonth ( int  _arg)
virtual

Set the acquisition month.

◆ SetSolarDistance()

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetSolarDistance ( double  value)
inline

Set the solar distance.

Definition at line 222 of file otbReflectanceToImageImageFilter.h.

◆ SetSolarIllumination()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetSolarIllumination ( VectorType  _arg)
virtual

Set the solar illumination value.

◆ SetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::SetZenithalSolarAngle ( double  _arg)
virtual

Set the zenithal solar angle.

Member Data Documentation

◆ InputImageDimension

template<class TInputImage , class TOutputImage >
const unsigned int otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
static

Extract input and output images dimensions.

Definition at line 137 of file otbReflectanceToImageImageFilter.h.

◆ m_Alpha

template<class TInputImage , class TOutputImage >
VectorType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_Alpha
private

Ponderation declaration

Definition at line 357 of file otbReflectanceToImageImageFilter.h.

◆ m_Beta

template<class TInputImage , class TOutputImage >
VectorType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_Beta
private

"typedef" to simplify the variables definition and the declaration.

Definition at line 358 of file otbReflectanceToImageImageFilter.h.

◆ m_Day

template<class TInputImage , class TOutputImage >
int otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_Day
private

Acquisition Day

Definition at line 374 of file otbReflectanceToImageImageFilter.h.

◆ m_FluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >
double otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_FluxNormalizationCoefficient
private

Flux normalization coefficient.

Definition at line 364 of file otbReflectanceToImageImageFilter.h.

◆ m_IsSetFluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_IsSetFluxNormalizationCoefficient
private

Used to know if the user has set a value for the FluxNormalizationCoefficient parameter or if the class has to compute it

Definition at line 371 of file otbReflectanceToImageImageFilter.h.

◆ m_IsSetSolarDistance

template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_IsSetSolarDistance
private

Used to know if the user has set a value for the SolarDistance parameter or if the class has to compute it

Definition at line 384 of file otbReflectanceToImageImageFilter.h.

◆ m_Month

template<class TInputImage , class TOutputImage >
int otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_Month
private

Acquisition Month

Definition at line 377 of file otbReflectanceToImageImageFilter.h.

◆ m_SolarDistance

template<class TInputImage , class TOutputImage >
double otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_SolarDistance
private

Solar distance.

Definition at line 380 of file otbReflectanceToImageImageFilter.h.

◆ m_SolarIllumination

template<class TInputImage , class TOutputImage >
VectorType otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_SolarIllumination
private

Solar illumination value.

Definition at line 367 of file otbReflectanceToImageImageFilter.h.

◆ m_ZenithalSolarAngle

template<class TInputImage , class TOutputImage >
double otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::m_ZenithalSolarAngle
private

Set the zenithal soalr angle.

Definition at line 361 of file otbReflectanceToImageImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage >
const unsigned int otb::ReflectanceToImageImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

"typedef" to simplify the variables definition and the declaration.

Definition at line 138 of file otbReflectanceToImageImageFilter.h.


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