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 Member Functions | List of all members
otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage > Class Template Reference

Calculates the brightness of TerraSar sensor images. More...

#include <otbTerraSarBrightnessImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Functor::TerraSarBrightnessFunctor
< InputValueType,
OutputValueType
FunctorType
 
typedef TInputImage InputImageType
 
typedef
InputImageType::InternalPixelType 
InputInternalPixelType
 
typedef itk::NumericTraits
< InputInternalPixelType >
::ValueType 
InputValueType
 
typedef itk::MetaDataDictionary MetaDataDictionaryType
 
typedef TOutputImage OutputImageType
 
typedef
OutputImageType::InternalPixelType 
OutputInternalPixelType
 
typedef itk::NumericTraits
< OutputInternalPixelType >
::ValueType 
OutputValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
TerraSarBrightnessImageFilter 
Self
 
typedef
itk::UnaryFunctorImageFilter
< InputImageType,
OutputImageType, FunctorType
Superclass
 
- Public Types inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TerraSarBrightnessFunctor< itk::NumericTraits< TInputImage::InternalPixelType >::ValueType, itk::NumericTraits< TOutputImage::InternalPixelType >::ValueType > >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef
Functor::TerraSarBrightnessFunctor
< itk::NumericTraits
< TInputImage::InternalPixelType >
::ValueType,
itk::NumericTraits
< TOutputImage::InternalPixelType >
::ValueType > 
FunctorType
 
typedef
Functor::TerraSarBrightnessFunctor
< itk::NumericTraits
< TInputImage::InternalPixelType >
::ValueType,
itk::NumericTraits
< TOutputImage::InternalPixelType >
::ValueType > 
FunctorType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< SelfPointer
 
typedef UnaryFunctorImageFilter Self
 
typedef UnaryFunctorImageFilter Self
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
double GetCalibrationFactor ()
 
double GetDefaultValue ()
 
virtual const char * GetNameOfClass () const
 
bool GetResultsInDecibels ()
 
void SetCalibrationFactor (double pCalibrationFactor)
 
void SetDefaultValue (double value)
 
void SetResultsInDecibels (bool db)
 
- Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TerraSarBrightnessFunctor< itk::NumericTraits< TInputImage::InternalPixelType >::ValueType, itk::NumericTraits< TOutputImage::InternalPixelType >::ValueType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
void SetFunctor (const FunctorType &functor)
 
void SetFunctor (const FunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TerraSarBrightnessFunctor< itk::NumericTraits< TInputImage::InternalPixelType >::ValueType, itk::NumericTraits< TOutputImage::InternalPixelType >::ValueType > >
static Pointer New ()
 
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
 

Protected Member Functions

 TerraSarBrightnessImageFilter ()
 
virtual ~TerraSarBrightnessImageFilter ()
 
void BeforeThreadedGenerateData ()
 
- Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TerraSarBrightnessFunctor< itk::NumericTraits< TInputImage::InternalPixelType >::ValueType, itk::NumericTraits< TOutputImage::InternalPixelType >::ValueType > >
 UnaryFunctorImageFilter ()
 
 UnaryFunctorImageFilter ()
 
virtual ~UnaryFunctorImageFilter ()
 
virtual ~UnaryFunctorImageFilter ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputInformation ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 

Private Member Functions

 TerraSarBrightnessImageFilter (const Self &)
 
void operator= (const Self &)
 

Detailed Description

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

Calculates the brightness of TerraSar sensor images.

Implementation of the brightness algorithm has been made following Infoterra documentation "Radiometric Calibration of TerraSAR-X Data".

This filter computes the beta naught ( \( \beta^{0} \)) using the following formula:

\[\beta^{0} = k_{s} \cdot |DN|^{2} \]

Where \( k_{s} \) is the calibration factor, which is imported from the input image metadata, even if one can set different values using the proper accessors.

Results can be obtained either in linear or logarithmic scale (decibels), using the ResultsInDecibels flag.

This filter works with either real or complex image. In the case of the complex images (SLC products for instance), modulus and phase are extracted, sigma naught is computed from the modulus and the phase is set back to the result.

For implementation details, consider reading the code TerraSarBrightnessFunctor.

See Also
TerraSarBrightnessFunctor
TerraSarBrightnessImageFilter

Definition at line 66 of file otbTerraSarBrightnessImageFilter.h.

Member Typedef Documentation

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

Definition at line 95 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Functor::TerraSarBrightnessFunctor<InputValueType, OutputValueType> otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::FunctorType

Definition at line 87 of file otbTerraSarBrightnessImageFilter.h.

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

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

Definition at line 80 of file otbTerraSarBrightnessImageFilter.h.

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

Definition at line 82 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<InputInternalPixelType>::ValueType otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::InputValueType

Definition at line 84 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::MetaDataDictionary otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::MetaDataDictionaryType

Definition at line 88 of file otbTerraSarBrightnessImageFilter.h.

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

Definition at line 81 of file otbTerraSarBrightnessImageFilter.h.

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

Definition at line 83 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<OutputInternalPixelType>::ValueType otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::OutputValueType

Definition at line 85 of file otbTerraSarBrightnessImageFilter.h.

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

Definition at line 94 of file otbTerraSarBrightnessImageFilter.h.

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

"typedef" for standard classes.

Definition at line 91 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::UnaryFunctorImageFilter<InputImageType, OutputImageType, FunctorType> otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 93 of file otbTerraSarBrightnessImageFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 143 of file otbTerraSarBrightnessImageFilter.h.

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

Destructor

Definition at line 145 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::TerraSarBrightnessImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
protected

Initialize the functor vector

Definition at line 30 of file otbTerraSarBrightnessImageFilter.txx.

References otb::TerraSarImageMetadataInterface::New().

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage >
double otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::GetCalibrationFactor ( )
inline

Get the calibration factor

Definition at line 111 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
double otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::GetDefaultValue ( )
inline

Definition at line 136 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual const char* otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TOutputImage >
bool otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::GetResultsInDecibels ( )
inline

Get the ResultsInDecibels flag

Definition at line 124 of file otbTerraSarBrightnessImageFilter.h.

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

object factory method.

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::SetCalibrationFactor ( double  pCalibrationFactor)
inline

Set the calibration factor

Definition at line 104 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::SetDefaultValue ( double  value)
inline

Set the default value (replacing negative beta)

Definition at line 130 of file otbTerraSarBrightnessImageFilter.h.

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::SetResultsInDecibels ( bool  db)
inline

Set the ResultsInDecibels flag

Definition at line 117 of file otbTerraSarBrightnessImageFilter.h.

Member Data Documentation

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

Extract input and output images dimensions.

Definition at line 76 of file otbTerraSarBrightnessImageFilter.h.

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

Definition at line 77 of file otbTerraSarBrightnessImageFilter.h.


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