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::ImageToLuminanceImageFilter< TInputImage, TOutputImage > Class Template Reference

Convert a raw value into a luminance value. More...

#include <otbImageToLuminanceImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Functor::ImageToLuminanceImageFunctor
< typename
InputImageType::InternalPixelType,
typename
OutputImageType::InternalPixelType > 
FunctorType
 
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 ImageToLuminanceImageFilter Self
 
typedef InputImageType::SizeType SizeType
 
typedef
UnaryImageFunctorWithVectorImageFilter
< InputImageType,
OutputImageType, FunctorType
Superclass
 
typedef
itk::VariableLengthVector
< double > 
VectorType
 
- Public Types inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToLuminanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Functor::ImageToLuminanceImageFunctor
< 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
 
virtual const VectorTypeGetAlpha ()
 
virtual const VectorTypeGetBeta ()
 
virtual const char * GetNameOfClass () const
 
virtual void SetAlpha (VectorType _arg)
 
virtual void SetBeta (VectorType _arg)
 
- Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToLuminanceImageFunctor< 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::ImageToLuminanceImageFunctor< 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::ImageToLuminanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Protected Member Functions

 ImageToLuminanceImageFilter ()
 
virtual ~ImageToLuminanceImageFilter ()
 
virtual void BeforeThreadedGenerateData (void)
 
- Protected Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToLuminanceImageFunctor< 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

VectorType m_Alpha
 
VectorType m_Beta
 

Detailed Description

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

Convert a raw value into a luminance value.

Transform a classical image into the luminance image. For this it uses the functor ImageToLuminanceImageFunctor calling for each component of each pixel.

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

Examples:
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 108 of file otbImageToLuminanceImageFilter.h.

Member Typedef Documentation

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

Definition at line 133 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 127 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 144 of file otbImageToLuminanceImageFilter.h.

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

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

Definition at line 124 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 143 of file otbImageToLuminanceImageFilter.h.

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

Supported images definition.

Definition at line 139 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 147 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 125 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 146 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 145 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 132 of file otbImageToLuminanceImageFilter.h.

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

"typedef" for standard classes.

Definition at line 130 of file otbImageToLuminanceImageFilter.h.

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

Image size "typedef" definition.

Definition at line 152 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 131 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 149 of file otbImageToLuminanceImageFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 167 of file otbImageToLuminanceImageFilter.h.

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

Destructor

Definition at line 174 of file otbImageToLuminanceImageFilter.h.

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual void otb::ImageToLuminanceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
inlineprotectedvirtual
template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::ImageToLuminanceImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage >
virtual const VectorType& otb::ImageToLuminanceImageFilter< TInputImage, TOutputImage >::GetAlpha ( )
virtual

Give the absolute calibration gains.

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

Give the absolute calibration bias.

template<class TInputImage , class TOutputImage >
virtual const char* otb::ImageToLuminanceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TOutputImage >
static Pointer otb::ImageToLuminanceImageFilter< TInputImage, TOutputImage >::New ( )
static

object factory method.

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

Set the absolute calibration gains.

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

Set the absolute calibration bias.

Member Data Documentation

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

Extract input and output images dimensions.

Definition at line 120 of file otbImageToLuminanceImageFilter.h.

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

Ponderation declaration

Definition at line 219 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 220 of file otbImageToLuminanceImageFilter.h.

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

Definition at line 121 of file otbImageToLuminanceImageFilter.h.


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