te::rp::Contrast::InputParameters Class Reference

Contrast input parameters. More...

#include <Contrast.h>

Inheritance diagram for te::rp::Contrast::InputParameters:
te::rp::AlgorithmInputParameters te::common::AbstractParameters

Public Member Functions

AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
 InputParameters ()
 
const InputParametersoperator= (const InputParameters &params)
 
void reset () throw ( te::rp::Exception )
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
 ~InputParameters ()
 

Public Attributes

Linear contrast parameters
std::vector< double > m_lCMinInput
 The contrast minimum input greyscale value of each band. More...
 
std::vector< double > m_lCMaxInput
 The contrast maximum input greyscale value of each band. More...
 
Histogram equalization contrast parameters
std::vector< double > m_hECMaxInput
 The contrast maximum input greyscale value of each band. More...
 
Square contrast parameters
std::vector< double > m_squareCMinInput
 The contrast minimum input greyscale value of each band. More...
 
std::vector< double > m_squareCMaxInput
 The contrast maximum input greyscale value of each band. More...
 
Square root contrast parameters
std::vector< double > m_squareRootCMinInput
 The contrast minimum input greyscale value of each band. More...
 
std::vector< double > m_squareRootCMaxInput
 The contrast maximum input greyscale value of each band. More...
 
Log contrast parameters
std::vector< double > m_logCMinInput
 The contrast minimum input greyscale value of each band. More...
 
std::vector< double > m_logCMaxInput
 The contrast maximum input greyscale value of each band. More...
 
Mean and standard deviation normalization contrast parameters
std::vector< double > m_sMASCMeanInput
 The mean greyscale to be applied in each band. More...
 
std::vector< double > m_sMASCStdInput
 The standard deviation to be applied in each band. More...
 

Global parameters

enum  ContrastType {
  InvalidContrastT, LinearContrastT, HistogramEqualizationContrastT, SquareContrastT,
  SquareRootContrastT, LogContrastT, MeanAndStdContrastT, DecorrelationEnhancementT
}
 
ContrastType m_type
 The contrast type to be applied. More...
 
te::rst::Raster const * m_inRasterPtr
 Input raster. More...
 
std::vector< unsigned int > m_inRasterBands
 Bands to be processed from the input raster. More...
 
bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 

Detailed Description

Contrast input parameters.

Definition at line 65 of file Contrast.h.

Member Enumeration Documentation

Enumerator
InvalidContrastT 

Invalid contrast.

LinearContrastT 

The histogram range will be changed to the supplied min/max range ( linear function ).

HistogramEqualizationContrastT 

The histogram of the image will be equalized automatically.

SquareContrastT 

The contrasted image will be created by using a square function.

SquareRootContrastT 

The contrasted image will be created by using a square root function.

LogContrastT 

The contrasted image will be created by using a log function.

MeanAndStdContrastT 

The contrasted image will have a predefined mean and standard deviation normalization.

DecorrelationEnhancementT 

Decorrelation Enhancement using principal components.

Definition at line 75 of file Contrast.h.

Constructor & Destructor Documentation

te::rp::Contrast::InputParameters::InputParameters ( )
te::rp::Contrast::InputParameters::~InputParameters ( )

Member Function Documentation

AbstractParameters* te::rp::Contrast::InputParameters::clone ( ) const
virtual

Create a clone copy of this instance.

Returns
A clone copy of this instance.
Note
The caller will take the ownership of the returned pointer.

Implements te::common::AbstractParameters.

const InputParameters& te::rp::Contrast::InputParameters::operator= ( const InputParameters params)
void te::rp::Contrast::InputParameters::reset ( )
throw (te::rp::Exception
)
virtual

Clear all internal allocated resources and reset the parameters instance to its initial state.

Implements te::common::AbstractParameters.

Member Data Documentation

bool te::rp::Contrast::InputParameters::m_enableProgress

Enable/Disable the progress interface (default:false).

Definition at line 93 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_hECMaxInput

The contrast maximum input greyscale value of each band.

Definition at line 113 of file Contrast.h.

std::vector< unsigned int > te::rp::Contrast::InputParameters::m_inRasterBands

Bands to be processed from the input raster.

Definition at line 91 of file Contrast.h.

te::rst::Raster const* te::rp::Contrast::InputParameters::m_inRasterPtr

Input raster.

Definition at line 89 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_lCMaxInput

The contrast maximum input greyscale value of each band.

Definition at line 104 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_lCMinInput

The contrast minimum input greyscale value of each band.

Definition at line 102 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_logCMaxInput

The contrast maximum input greyscale value of each band.

Definition at line 146 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_logCMinInput

The contrast minimum input greyscale value of each band.

Definition at line 144 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_sMASCMeanInput

The mean greyscale to be applied in each band.

Definition at line 155 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_sMASCStdInput

The standard deviation to be applied in each band.

Definition at line 157 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_squareCMaxInput

The contrast maximum input greyscale value of each band.

Definition at line 124 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_squareCMinInput

The contrast minimum input greyscale value of each band.

Definition at line 122 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_squareRootCMaxInput

The contrast maximum input greyscale value of each band.

Definition at line 135 of file Contrast.h.

std::vector< double > te::rp::Contrast::InputParameters::m_squareRootCMinInput

The contrast minimum input greyscale value of each band.

Definition at line 133 of file Contrast.h.

ContrastType te::rp::Contrast::InputParameters::m_type

The contrast type to be applied.

Definition at line 87 of file Contrast.h.


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