#include <Contrast.h>

Inheritance diagram for te::rp::Contrast::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...

Global parameters
enum	ContrastType { InvalidContrastT , LinearContrastT , HistogramEqualizationContrastT , SquareContrastT , SquareRootContrastT , LogContrastT , MeanAndStdContrastT , DecorrelationEnhancementT , CumulativeCut2EnhancementT }

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...

double	m_outRangeMin
	Minimum value of data type range (default: -1.0 * std::numeric_limits<double>::max() ). More...

double	m_outRangeMax
	Maximum value of data type range (default: std::numeric_limits<double>::max(). More...

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

bool	m_sampled
	Enable/Disable uses all values to calculate histogram. 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...

	InputParameters ()

	~InputParameters ()

void	reset ()
	Clear all internal allocated resources and reset the parameters instance to its initial state. More...

const InputParameters &	operator= (const InputParameters &params)

AbstractParameters *	clone () const
	Create a clone copy of this instance. More...

bool	serialize (AlgorithmParametersSerializer &serializer) const
	Returns a parameter serialization object. More...

Detailed Description

Contrast input parameters.

Definition at line 65 of file Contrast.h.

Member Enumeration Documentation

◆ ContrastType

enum te::rp::Contrast::InputParameters::ContrastType

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.
CumulativeCut2EnhancementT	Linear cumulative cutted in 2 - 98%.

Definition at line 75 of file Contrast.h.

Constructor & Destructor Documentation

◆ InputParameters()

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

◆ ~InputParameters()

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

Member Function Documentation

◆ clone()

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.

◆ operator=()

const InputParameters& te::rp::Contrast::InputParameters::operator= ( const InputParameters & params )

◆ reset()

void te::rp::Contrast::InputParameters::reset ( )

virtual

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

Implements te::common::AbstractParameters.

◆ serialize()

bool te::rp::Contrast::InputParameters::serialize ( AlgorithmParametersSerializer & serializer ) const

virtual

Returns a parameter serialization object.

Parameters

serializer The output serialization object.

Returns: Returns true if ok, false on erros.

Reimplemented from te::rp::AlgorithmInputParameters.

Member Data Documentation

◆ m_enableProgress

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

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

Definition at line 98 of file Contrast.h.

◆ m_hECMaxInput

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

The contrast maximum input greyscale value of each band.

Definition at line 120 of file Contrast.h.

◆ m_inRasterBands

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

Bands to be processed from the input raster.

Definition at line 92 of file Contrast.h.

◆ m_inRasterPtr

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

Input raster.

Definition at line 90 of file Contrast.h.

◆ m_lCMaxInput

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

The contrast maximum input greyscale value of each band.

Definition at line 111 of file Contrast.h.

◆ m_lCMinInput

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

The contrast minimum input greyscale value of each band.

Definition at line 109 of file Contrast.h.

◆ m_logCMaxInput

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

The contrast maximum input greyscale value of each band.

Definition at line 153 of file Contrast.h.

◆ m_logCMinInput

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

The contrast minimum input greyscale value of each band.

Definition at line 151 of file Contrast.h.

◆ m_outRangeMax

double te::rp::Contrast::InputParameters::m_outRangeMax

Maximum value of data type range (default: std::numeric_limits<double>::max().

Definition at line 96 of file Contrast.h.

◆ m_outRangeMin

double te::rp::Contrast::InputParameters::m_outRangeMin

Minimum value of data type range (default: -1.0 * std::numeric_limits<double>::max() ).

Definition at line 94 of file Contrast.h.

◆ m_sampled

bool te::rp::Contrast::InputParameters::m_sampled

Enable/Disable uses all values to calculate histogram.

Definition at line 100 of file Contrast.h.

◆ m_sMASCMeanInput

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

The mean greyscale to be applied in each band.

Definition at line 162 of file Contrast.h.

◆ m_sMASCStdInput

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

The standard deviation to be applied in each band.

Definition at line 164 of file Contrast.h.

◆ m_squareCMaxInput

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

The contrast maximum input greyscale value of each band.

Definition at line 131 of file Contrast.h.

◆ m_squareCMinInput

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

The contrast minimum input greyscale value of each band.

Definition at line 129 of file Contrast.h.

◆ m_squareRootCMaxInput

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

The contrast maximum input greyscale value of each band.

Definition at line 142 of file Contrast.h.

◆ m_squareRootCMinInput

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

The contrast minimum input greyscale value of each band.

Definition at line 140 of file Contrast.h.

◆ m_type

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

The contrast type to be applied.

Definition at line 88 of file Contrast.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/Contrast.h

Public Attributes

Global parameters

Mean and standard deviation normalization contrast parameters

Detailed Description

Member Enumeration Documentation

◆ ContrastType

Constructor & Destructor Documentation

◆ InputParameters()

◆ ~InputParameters()

Member Function Documentation

◆ clone()

◆ operator=()

◆ reset()

◆ serialize()

Member Data Documentation

◆ m_enableProgress

◆ m_hECMaxInput

◆ m_inRasterBands

◆ m_inRasterPtr

◆ m_lCMaxInput

◆ m_lCMinInput

◆ m_logCMaxInput

◆ m_logCMinInput

◆ m_outRangeMax

◆ m_outRangeMin

◆ m_sampled

◆ m_sMASCMeanInput

◆ m_sMASCStdInput

◆ m_squareCMaxInput

◆ m_squareCMinInput

◆ m_squareRootCMaxInput

◆ m_squareRootCMinInput

◆ m_type