OTB  9.0.0
Orfeo Toolbox
List of all members
otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage > Class Template Reference
Processing images region by region » Filters supporting StreamingSupport for Multithreading » | Multithreaded FiltersThematic modules » | Radiometry modulesGroup SAR » | Module OTBSARCalibration

#include <otbTerraSarBrightnessImageFilter.h>

+ Inheritance diagram for otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >:
typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef InputImageType::InternalPixelType InputInternalPixelType
 
typedef OutputImageType::InternalPixelType OutputInternalPixelType
 
typedef itk::NumericTraits< InputInternalPixelType >::ValueType InputValueType
 
typedef itk::NumericTraits< OutputInternalPixelType >::ValueType OutputValueType
 
typedef Functor::TerraSarBrightnessFunctor< InputValueType, OutputValueType > FunctorType
 
typedef itk::MetaDataDictionary MetaDataDictionaryType
 
typedef TerraSarBrightnessImageFilter Self
 
typedef itk::UnaryFunctorImageFilter< InputImageType, OutputImageType, FunctorType > Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetCalibrationFactor (double pCalibrationFactor)
 
double GetCalibrationFactor ()
 
void SetResultsInDecibels (bool db)
 
bool GetResultsInDecibels ()
 
void SetDefaultValue (double value)
 
double GetDefaultValue ()
 
 TerraSarBrightnessImageFilter ()
 
 ~TerraSarBrightnessImageFilter () override
 
void BeforeThreadedGenerateData () override
 
 TerraSarBrightnessImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

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 67 of file otbTerraSarBrightnessImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

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

Definition at line 92 of file otbTerraSarBrightnessImageFilter.h.

◆ FunctorType

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

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

Definition at line 85 of file otbTerraSarBrightnessImageFilter.h.

◆ InputImageType

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

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

Definition at line 79 of file otbTerraSarBrightnessImageFilter.h.

◆ InputInternalPixelType

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

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

Definition at line 81 of file otbTerraSarBrightnessImageFilter.h.

◆ InputValueType

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

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

Definition at line 83 of file otbTerraSarBrightnessImageFilter.h.

◆ MetaDataDictionaryType

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

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

Definition at line 86 of file otbTerraSarBrightnessImageFilter.h.

◆ OutputImageType

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

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

Definition at line 80 of file otbTerraSarBrightnessImageFilter.h.

◆ OutputInternalPixelType

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

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

Definition at line 82 of file otbTerraSarBrightnessImageFilter.h.

◆ OutputValueType

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

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

Definition at line 84 of file otbTerraSarBrightnessImageFilter.h.

◆ Pointer

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

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

Definition at line 91 of file otbTerraSarBrightnessImageFilter.h.

◆ Self

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

"typedef" for standard classes.

Definition at line 89 of file otbTerraSarBrightnessImageFilter.h.

◆ Superclass

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

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

Definition at line 90 of file otbTerraSarBrightnessImageFilter.h.

Constructor & Destructor Documentation

◆ TerraSarBrightnessImageFilter() [1/2]

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

Constructor

Definition at line 143 of file otbTerraSarBrightnessImageFilter.h.

◆ ~TerraSarBrightnessImageFilter()

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

Destructor

Definition at line 146 of file otbTerraSarBrightnessImageFilter.h.

◆ TerraSarBrightnessImageFilter() [2/2]

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

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

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData
overrideprotected

Initialize the functor vector

Retrieve the ImageMetadata

Definition at line 31 of file otbTerraSarBrightnessImageFilter.hxx.

References otb::CalFactor.

◆ CreateAnother()

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

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

◆ GetCalibrationFactor()

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

Get the calibration factor

Definition at line 109 of file otbTerraSarBrightnessImageFilter.h.

◆ GetDefaultValue()

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

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

Definition at line 136 of file otbTerraSarBrightnessImageFilter.h.

◆ GetNameOfClass()

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

return class name.

◆ GetResultsInDecibels()

template<class TInputImage , class TOutputImage >
bool otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::GetResultsInDecibels ( )
inline

Get the ResultsInDecibels flag

Definition at line 123 of file otbTerraSarBrightnessImageFilter.h.

◆ New()

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

object factory method.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )
privatedelete

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

◆ SetCalibrationFactor()

template<class TInputImage , class TOutputImage >
void otb::TerraSarBrightnessImageFilter< TInputImage, TOutputImage >::SetCalibrationFactor ( double  pCalibrationFactor)
inline

Set the calibration factor

Definition at line 101 of file otbTerraSarBrightnessImageFilter.h.

◆ SetDefaultValue()

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

Set the default value (replacing negative beta)

Definition at line 129 of file otbTerraSarBrightnessImageFilter.h.

◆ SetResultsInDecibels()

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

Set the ResultsInDecibels flag

Definition at line 115 of file otbTerraSarBrightnessImageFilter.h.

Member Data Documentation

◆ InputImageDimension

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 74 of file otbTerraSarBrightnessImageFilter.h.

◆ OutputImageDimension

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

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

Definition at line 75 of file otbTerraSarBrightnessImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:34 for OTB with   doxygen 1.8.17