te::rp::Contrast Class Reference

Contrast enhancement. More...

#include <Contrast.h>

Inheritance diagram for te::rp::Contrast:

Classes
class	InputParameters
	Contrast input parameters. More...
class	OutputParameters
	Contrast output parameters. More...

Public Member Functions
	Contrast ()
bool	execute (AlgorithmOutputParameters &outputParams)
	Executes the algorithm using the supplied parameters.
const std::string &	getErrorMessage () const
	Return the current error message if there is any.
bool	initialize (const AlgorithmInputParameters &inputParams)
	Initialize the algorithm instance making it ready for execution.
bool	isInitialized () const
	Returns true if the algorithm instance is initialized and ready for execution.
void	reset ()
	Clear all internal allocated objects and reset the algorithm to its initial state.
	~Contrast ()

Static Public Member Functions
static bool	getGainAndOffset (const InputParameters::ContrastType &type, const double &inRangeMin, const double &inRangeMax, const double &outRangeMin, const double &outRangeMax, double &gain, double &offset1, double &offset2)
	Returns gain and offset values for contrast types (when applicable).

Protected Types
typedef void(Contrast::*	RemapFuncPtrT) (const double &inValue, double &outValue)
	Type definition for a remapping function pointer.

Protected Member Functions
void	DecorrelationEnhancementRemap (const double &inValue, double &outValue)
	Remap on gray level using two offsets and gain.
bool	execCumulativeCut2Enhancement ()
	Execute a cumulative linear contrast cutted by 2-98% following the internal parameters.
bool	execDecorrelationEnhancement ()
	Execute the decorrelation enhancement contrast following the internal parameters.
bool	execHistogramEqualizationContrast ()
	Execute the histogram equalization contrast following the internal parameters.
bool	execLinearContrast ()
	Execute a linear contrast following the internal parameters.
bool	execLogContrast ()
	Execute a log contrast following the internal parameters.
bool	execPercentCutUDLinear ()
	Execute a linear contrast cutted by user defined percentual values.
bool	execSetMeanAndStdContrast ()
	Execute the histogram equalization contrast following the internal parameters.
bool	execSquareContrast ()
	Execute a square contrast following the internal parameters.
bool	execSquareRootContrast ()
	Execute a square root contrast following the internal parameters.
void	histogramEqualizationRemap (const double &inValue, double &outValue)
	Remap on gray level using two offsets and gain.
void	logRemap (const double &inValue, double &outValue)
	Remap on gray level using a log.
void	offSetGainRemap (const double &inValue, double &outValue)
	Remap on gray level using an offset and gain.
bool	remapBandLevels (const te::rst::Raster &inRaster, const unsigned int inRasterBandIdx, te::rst::Raster &outRaster, const unsigned int outRasterBandIdx, RemapFuncPtrT remapFuncPtr, const bool enableProgress)
	Band gray levels remap using a remap function.
void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message.
void	squareRemap (const double &inValue, double &outValue)
	Remap on gray level using a square.
void	squareRootRemap (const double &inValue, double &outValue)
	Remap on gray level using a square root.

Protected Attributes
double	m_decorrelationEnhancementRemap_gain
double	m_decorrelationEnhancementRemap_offset1
double	m_decorrelationEnhancementRemap_offset2
std::map< double, double >	m_histogramEqualizationRemap_cdf
double	m_histogramEqualizationRemap_cDFMin
double	m_histogramEqualizationRemap_gain
Contrast::InputParameters	m_inputParameters
	Contrast input execution parameters.
bool	m_isInitialized
	Tells if this instance is initialized.
double	m_logRemap_gain
double	m_logRemap_offset
double	m_offSetGainRemap_gain
double	m_offSetGainRemap_offset1
double	m_offSetGainRemap_offset2
Contrast::OutputParameters *	m_outputParametersPtr
	Contrast input execution parameters.
double	m_squareRemap_gain
double	m_squareRootRemap_gain

Private Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Contrast enhancement.

Apply contrast enhencement on the selected bands.

Definition at line 57 of file Contrast.h.

Member Typedef Documentation

RemapFuncPtrT

typedef void(Contrast::* te::rp::Contrast::RemapFuncPtrT) (const double &inValue, double &outValue)

protected

Type definition for a remapping function pointer.

Definition at line 274 of file Contrast.h.

Constructor & Destructor Documentation

Contrast()

te::rp::Contrast::Contrast

(

)

~Contrast()

te::rp::Contrast::~Contrast

(

)

Member Function Documentation

DecorrelationEnhancementRemap()

void te::rp::Contrast::DecorrelationEnhancementRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using two offsets and gain.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Definition at line 429 of file Contrast.h.

execCumulativeCut2Enhancement()

bool te::rp::Contrast::execCumulativeCut2Enhancement ( )

protected

Execute a cumulative linear contrast cutted by 2-98% following the internal parameters.

Returns

true if OK, false on errors.

execDecorrelationEnhancement()

bool te::rp::Contrast::execDecorrelationEnhancement ( )

protected

Execute the decorrelation enhancement contrast following the internal parameters.

Returns

true if OK, false on errors.

execHistogramEqualizationContrast()

bool te::rp::Contrast::execHistogramEqualizationContrast ( )

protected

Execute the histogram equalization contrast following the internal parameters.

Returns

true if OK, false on errors.

execLinearContrast()

bool te::rp::Contrast::execLinearContrast ( )

protected

Execute a linear contrast following the internal parameters.

Returns

true if OK, false on errors.

execLogContrast()

bool te::rp::Contrast::execLogContrast ( )

protected

Execute a log contrast following the internal parameters.

Returns

true if OK, false on errors.

execPercentCutUDLinear()

bool te::rp::Contrast::execPercentCutUDLinear ( )

protected

Execute a linear contrast cutted by user defined percentual values.

Returns

true if OK, false on errors.

execSetMeanAndStdContrast()

bool te::rp::Contrast::execSetMeanAndStdContrast ( )

protected

Execute the histogram equalization contrast following the internal parameters.

Returns

true if OK, false on errors.

execSquareContrast()

bool te::rp::Contrast::execSquareContrast ( )

protected

Execute a square contrast following the internal parameters.

Returns

true if OK, false on errors.

execSquareRootContrast()

bool te::rp::Contrast::execSquareRootContrast ( )

protected

Execute a square root contrast following the internal parameters.

Returns

true if OK, false on errors.

execute()

bool te::rp::Contrast::execute ( AlgorithmOutputParameters &  outputParams )

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams

Output parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

getErrorMessage()

const std::string & te::rp::Algorithm::getErrorMessage ( ) const

inherited

Return the current error message if there is any.

Returns

Return the current error message if there is any.

getGainAndOffset()

static bool te::rp::Contrast::getGainAndOffset ( const InputParameters::ContrastType &  type, const double &  inRangeMin, const double &  inRangeMax, const double &  outRangeMin, const double &  outRangeMax, double &  gain, double &  offset1, double &  offset2  )

static

Returns gain and offset values for contrast types (when applicable).

Parameters

inRangeMin	Input values range minimum value.
inRangeMax	Input values range maximum value.
outRangeMin	Output values range minimum value.
outRangeMax	Output values range maximum value.
gain	Calculated gain.
offset1	Calculated offset 1.
offset2	Calculated offset 2.

Returns

true if OK, false on errors.

histogramEqualizationRemap()

void te::rp::Contrast::histogramEqualizationRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using two offsets and gain.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Definition at line 441 of file Contrast.h.

initialize()

bool te::rp::Contrast::initialize ( const AlgorithmInputParameters &  inputParams )

virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams

Input parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

isInitialized()

bool te::rp::Contrast::isInitialized ( ) const

virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns

true if the algorithm instance is initialized and ready for execution.

Implements te::rp::Algorithm.

logRemap()

void te::rp::Contrast::logRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using a log.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Note

outValue = m_logRemap_gain * std::log10( inValue + m_logRemap_offset + 1.0 );

Definition at line 419 of file Contrast.h.

offSetGainRemap()

void te::rp::Contrast::offSetGainRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using an offset and gain.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Note

outValue = ( ( inValue + m_offSetGainRemap_offset1 ) * m_offSetGainRemap_gain ) + m_offSetGainRemap_offset2

Definition at line 385 of file Contrast.h.

remapBandLevels()

bool te::rp::Contrast::remapBandLevels ( const te::rst::Raster &  inRaster, const unsigned int  inRasterBandIdx, te::rst::Raster &  outRaster, const unsigned int  outRasterBandIdx, RemapFuncPtrT  remapFuncPtr, const bool  enableProgress  )

protected

Band gray levels remap using a remap function.

Parameters

inRaster	Input Raster
inRasterBandIdx	Input raster band index.
outRaster	Output raster.
outRasterBandIdx	Output raster band index.
remapFuncPtr	The remap function pointer used.
enableProgress	Enable the use of a progress interface.

Returns

true if OK, false on errors.

reset()

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

virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Reimplemented from te::rp::Algorithm.

setErrorMessage()

void te::rp::Algorithm::setErrorMessage ( const std::string &  newErrorMessage )

protectedinherited

Set the current error message.

Parameters

newErrorMessage

New error message;

squareRemap()

void te::rp::Contrast::squareRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using a square.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Note

outValue = m_squareRemap_factor * std::pow( inValue, 2.0 )

Definition at line 397 of file Contrast.h.

squareRootRemap()

void te::rp::Contrast::squareRootRemap ( const double &  inValue, double &  outValue  )

inlineprotected

Remap on gray level using a square root.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Note

outValue = m_squareRootRemap_gain * std::sqrt( inValue );

Definition at line 408 of file Contrast.h.

Member Data Documentation

m_decorrelationEnhancementRemap_gain

double te::rp::Contrast::m_decorrelationEnhancementRemap_gain

protected

Definition at line 370 of file Contrast.h.

m_decorrelationEnhancementRemap_offset1

double te::rp::Contrast::m_decorrelationEnhancementRemap_offset1

protected

Definition at line 371 of file Contrast.h.

m_decorrelationEnhancementRemap_offset2

double te::rp::Contrast::m_decorrelationEnhancementRemap_offset2

protected

Definition at line 372 of file Contrast.h.

m_errorMessage

std::string te::rp::Algorithm::m_errorMessage

privateinherited

Current error message.

Definition at line 104 of file Algorithm.h.

m_histogramEqualizationRemap_cdf

std::map<double, double> te::rp::Contrast::m_histogramEqualizationRemap_cdf

protected

Definition at line 377 of file Contrast.h.

m_histogramEqualizationRemap_cDFMin

double te::rp::Contrast::m_histogramEqualizationRemap_cDFMin

protected

Definition at line 375 of file Contrast.h.

m_histogramEqualizationRemap_gain

double te::rp::Contrast::m_histogramEqualizationRemap_gain

protected

Definition at line 376 of file Contrast.h.

m_inputParameters

Contrast::InputParameters te::rp::Contrast::m_inputParameters

protected

Contrast input execution parameters.

Definition at line 277 of file Contrast.h.

m_isInitialized

bool te::rp::Contrast::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 280 of file Contrast.h.

m_logRemap_gain

double te::rp::Contrast::m_logRemap_gain

protected

Definition at line 366 of file Contrast.h.

m_logRemap_offset

double te::rp::Contrast::m_logRemap_offset

protected

Definition at line 367 of file Contrast.h.

m_offSetGainRemap_gain

double te::rp::Contrast::m_offSetGainRemap_gain

protected

Definition at line 357 of file Contrast.h.

m_offSetGainRemap_offset1

double te::rp::Contrast::m_offSetGainRemap_offset1

protected

Definition at line 355 of file Contrast.h.

m_offSetGainRemap_offset2

double te::rp::Contrast::m_offSetGainRemap_offset2

protected

Definition at line 356 of file Contrast.h.

m_outputParametersPtr

Contrast::OutputParameters* te::rp::Contrast::m_outputParametersPtr

protected

Contrast input execution parameters.

Definition at line 278 of file Contrast.h.

m_squareRemap_gain

double te::rp::Contrast::m_squareRemap_gain

protected

Definition at line 360 of file Contrast.h.

m_squareRootRemap_gain

double te::rp::Contrast::m_squareRootRemap_gain

protected

Definition at line 363 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