Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage > Class Template Reference

Calculates the slope, the orientation incidence and exitance radius values for each pixel. More...

#include <otbReflectanceToSurfaceReflectanceImageFilter.h>

+ Inheritance diagram for otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >:

Public Types

typedef
AcquiCorrectionParametersType::Pointer 
AcquiCorrectionParametersPointerType
 
typedef
otb::ImageMetadataCorrectionParameters 
AcquiCorrectionParametersType
 
typedef
AtmoCorrectionParametersType::Pointer 
AtmoCorrectionParametersPointerType
 
typedef
otb::AtmosphericCorrectionParameters 
AtmoCorrectionParametersType
 
typedef
AtmosphericRadiativeTermsType::Pointer 
AtmosphericRadiativeTermsPointerType
 
typedef
otb::AtmosphericRadiativeTerms 
AtmosphericRadiativeTermsType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
otb::RadiometryCorrectionParametersToAtmosphericRadiativeTerms 
CorrectionParametersToRadiativeTermsType
 
typedef otb::FilterFunctionValues FilterFunctionValuesType
 
typedef
Functor::ReflectanceToSurfaceReflectanceImageFunctor
< typename
InputImageType::InternalPixelType,
typename
OutputImageType::InternalPixelType > 
FunctorType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
InputImageType::InternalPixelType 
InputInternalPixelType
 
typedef InputImageType::PixelType InputPixelType
 
typedef itk::MetaDataDictionary MetaDataDictionaryType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef
OutputImageType::InternalPixelType 
OutputInternalPixelType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
ReflectanceToSurfaceReflectanceImageFilter 
Self
 
typedef
UnaryImageFunctorWithVectorImageFilter
< InputImageType,
OutputImageType, FunctorType
Superclass
 
typedef
FilterFunctionValuesType::ValuesVectorType 
ValuesVectorType
 
typedef
FilterFunctionValuesType::WavelengthSpectralBandType 
ValueType
 
typedef
AcquiCorrectionParametersType::WavelengthSpectralBandVectorType 
WavelengthSpectralBandVectorType
 
- Public Types inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToSurfaceReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Functor::ReflectanceToSurfaceReflectanceImageFunctor
< TInputImage::InternalPixelType,
TOutputImage::InternalPixelType > 
FunctorType
 
typedef std::vector< FunctorTypeFunctorVectorType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
InputImageType::InternalPixelType 
InputInternalPixelType
 
typedef InputImageType::PixelType InputPixelType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef
OutputImageType::InternalPixelType 
OutputInternalPixelType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
UnaryImageFunctorWithVectorImageFilter 
Self
 
typedef InputImageType::SizeType SizeType
 
typedef
itk::InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void GenerateParameters ()
 
virtual
AcquiCorrectionParametersType
GetAcquiCorrectionParameters ()
 
virtual
AtmoCorrectionParametersType
GetAtmoCorrectionParameters ()
 
virtual
AtmosphericRadiativeTermsType
GetAtmosphericRadiativeTerms ()
 
virtual bool GetIsSetAtmosphericRadiativeTerms ()
 
virtual const char * GetNameOfClass () const
 
virtual bool GetUseGenerateParameters ()
 
virtual void IsSetAtmosphericRadiativeTermsOff ()
 
virtual void IsSetAtmosphericRadiativeTermsOn ()
 
void SetAcquiCorrectionParameters (AcquiCorrectionParametersPointerType acquiCorrTerms)
 
void SetAtmoCorrectionParameters (AtmoCorrectionParametersPointerType atmoCorrTerms)
 
void SetAtmosphericRadiativeTerms (AtmosphericRadiativeTermsPointerType atmoRadTerms)
 
virtual void SetIsSetAtmosphericRadiativeTerms (bool _arg)
 
virtual void SetUseGenerateParameters (bool _arg)
 
virtual void UseGenerateParametersOff ()
 
virtual void UseGenerateParametersOn ()
 
- Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToSurfaceReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorVectorTypeGetFunctorVector (void)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToSurfaceReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToSurfaceReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Protected Member Functions

 ReflectanceToSurfaceReflectanceImageFilter ()
 
virtual ~ReflectanceToSurfaceReflectanceImageFilter ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void Modified ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void UpdateAtmosphericRadiativeTerms ()
 
void UpdateFunctors ()
 
- Protected Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ReflectanceToSurfaceReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
 UnaryImageFunctorWithVectorImageFilter ()
 
virtual ~UnaryImageFunctorWithVectorImageFilter ()
 
virtual void GenerateOutputInformation ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Attributes

AcquiCorrectionParametersPointerType m_AcquiCorrectionParameters
 
AtmoCorrectionParametersPointerType m_AtmoCorrectionParameters
 
AtmosphericRadiativeTermsPointerType m_AtmosphericRadiativeTerms
 
bool m_FunctorParametersHaveBeenComputed
 
bool m_IsSetAcquiCorrectionParameters
 
bool m_IsSetAtmoCorrectionParameters
 
bool m_IsSetAtmosphericRadiativeTerms
 
bool m_UseGenerateParameters
 

Detailed Description

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

Calculates the slope, the orientation incidence and exitance radius values for each pixel.

Examples:
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 130 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef AcquiCorrectionParametersType::Pointer otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AcquiCorrectionParametersPointerType
template<class TInputImage , class TOutputImage >
typedef otb::ImageMetadataCorrectionParameters otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AcquiCorrectionParametersType
template<class TInputImage , class TOutputImage >
typedef AtmoCorrectionParametersType::Pointer otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AtmoCorrectionParametersPointerType
template<class TInputImage , class TOutputImage >
typedef otb::AtmosphericCorrectionParameters otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AtmoCorrectionParametersType
template<class TInputImage , class TOutputImage >
typedef AtmosphericRadiativeTermsType::Pointer otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AtmosphericRadiativeTermsPointerType
template<class TInputImage , class TOutputImage >
typedef otb::AtmosphericRadiativeTerms otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::AtmosphericRadiativeTermsType
template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef otb::FilterFunctionValues otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::FilterFunctionValuesType
template<class TInputImage , class TOutputImage >
typedef Functor::ReflectanceToSurfaceReflectanceImageFunctor<typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType> otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::FunctorType
template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TInputImage otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::InputImageType

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

Definition at line 144 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::InternalPixelType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::InputInternalPixelType
template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::InputPixelType

Supported images definition.

Definition at line 160 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::MetaDataDictionary otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::MetaDataDictionaryType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TOutputImage otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::OutputImageType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::InternalPixelType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::OutputPixelType
template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef ReflectanceToSurfaceReflectanceImageFilter otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::Self

"typedef" for standard classes.

Definition at line 151 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef UnaryImageFunctorWithVectorImageFilter<InputImageType, OutputImageType, FunctorType> otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::Superclass
template<class TInputImage , class TOutputImage >
typedef FilterFunctionValuesType::ValuesVectorType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ValuesVectorType
template<class TInputImage , class TOutputImage >
typedef FilterFunctionValuesType::WavelengthSpectralBandType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ValueType

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ReflectanceToSurfaceReflectanceImageFilter ( )
protected

Constructor

Definition at line 33 of file otbReflectanceToSurfaceReflectanceImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::~ReflectanceToSurfaceReflectanceImageFilter ( )
inlineprotectedvirtual

Destructor

Definition at line 240 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

Member Function Documentation

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
protectedvirtual

Initialize the parameters of the functor before the threads run.

Definition at line 47 of file otbReflectanceToSurfaceReflectanceImageFilter.txx.

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

Compute radiative terms if necessary and then update functors attributs.

Definition at line 67 of file otbReflectanceToSurfaceReflectanceImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual AcquiCorrectionParametersType* otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetAcquiCorrectionParameters ( )
virtual
template<class TInputImage , class TOutputImage >
virtual AtmoCorrectionParametersType* otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetAtmoCorrectionParameters ( )
virtual
template<class TInputImage , class TOutputImage >
virtual AtmosphericRadiativeTermsType* otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetAtmosphericRadiativeTerms ( )
virtual
template<class TInputImage , class TOutputImage >
virtual bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetIsSetAtmosphericRadiativeTerms ( )
virtual
template<class TInputImage , class TOutputImage >
virtual const char* otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TOutputImage >
virtual bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::GetUseGenerateParameters ( )
virtual
template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::IsSetAtmosphericRadiativeTermsOff ( )
virtual
template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::IsSetAtmosphericRadiativeTermsOn ( )
virtual
template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::Modified ( void  )
protectedvirtual

If modified, we need to compute the functor parameters again

Definition at line 57 of file otbReflectanceToSurfaceReflectanceImageFilter.txx.

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

object factory method.

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected
template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::SetAcquiCorrectionParameters ( AcquiCorrectionParametersPointerType  acquiCorrTerms)
inline

Get/Set Acquisition Correction Parameters.

Definition at line 213 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::SetAtmoCorrectionParameters ( AtmoCorrectionParametersPointerType  atmoCorrTerms)
inline

Get/Set Atmospheric Correction Parameters.

Definition at line 203 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::SetAtmosphericRadiativeTerms ( AtmosphericRadiativeTermsPointerType  atmoRadTerms)
inline

Get/Set Atmospheric Radiative Terms.

Definition at line 193 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::SetIsSetAtmosphericRadiativeTerms ( bool  _arg)
virtual

Set/Get IsSetAtmosphericRadiativeTerms

template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::SetUseGenerateParameters ( bool  _arg)
virtual

Set/Get UseGenerateParameters.

template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::UpdateAtmosphericRadiativeTerms ( )
protected
template<class TInputImage , class TOutputImage >
void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::UpdateFunctors ( )
protected
template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::UseGenerateParametersOff ( )
virtual
template<class TInputImage , class TOutputImage >
virtual void otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::UseGenerateParametersOn ( )
virtual

Member Data Documentation

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

Extract input and output images dimensions.

Definition at line 140 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
AcquiCorrectionParametersPointerType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_AcquiCorrectionParameters
private
template<class TInputImage , class TOutputImage >
AtmoCorrectionParametersPointerType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_AtmoCorrectionParameters
private
template<class TInputImage , class TOutputImage >
AtmosphericRadiativeTermsPointerType otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_AtmosphericRadiativeTerms
private
template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_FunctorParametersHaveBeenComputed
private

True if the functor parameters have been generated

Definition at line 265 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_IsSetAcquiCorrectionParameters
private
template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_IsSetAtmoCorrectionParameters
private
template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_IsSetAtmosphericRadiativeTerms
private
template<class TInputImage , class TOutputImage >
bool otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::m_UseGenerateParameters
private

Enable/Disable GenerateParameters in GenerateOutputInformation. Useful for image view that call GenerateOutputInformation each time you move the full area.

Definition at line 262 of file otbReflectanceToSurfaceReflectanceImageFilter.h.

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

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