#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) throw ( te::rp::Exception )
	Executes the algorithm using the supplied parameters. More...

bool	initialize (const AlgorithmInputParameters &inputParams) throw ( te::rp::Exception )
	Initialize the algorithm instance making it ready for execution. More...

bool	isInitialized () const
	Returns true if the algorithm instance is initialized and ready for execution. More...

void	reset () throw ( te::rp::Exception )
	Clear all internal allocated objects and reset the algorithm to its initial state. More...

	~Contrast ()

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

Protected Member Functions
bool	execDecorrelationEnhancement ()
	Execute the decorrelation enhancement contrast following the internal parameters. More...

bool	execHistogramEqualizationContrast ()
	Execute the histogram equalization contrast following the internal parameters. More...

bool	execLinearContrast ()
	Execute a linear contrast following the internal parameters. More...

bool	execLogContrast ()
	Execute a log contrast following the internal parameters. More...

bool	execSetMeanAndStdContrast ()
	Execute the histogram equalization contrast following the internal parameters. More...

bool	execSquareContrast ()
	Execute a square contrast following the internal parameters. More...

bool	execSquareRootContrast ()
	Execute a square root contrast following the internal parameters. More...

void	logRemap (const double &inValue, double &outValue)
	Remap on gray level using a log. More...

void	offSetGainRemap (const double &inValue, double &outValue)
	Remap on gray level using an offset and gain. More...

bool	remapBandLevels (const te::rst::Band &inRasterBand, te::rst::Band &outRasterBand, RemapFuncPtrT remapFuncPtr, const bool enableProgress)
	Band gray levels remap using a remap function. More...

void	squareRemap (const double &inValue, double &outValue)
	Remap on gray level using a square. More...

void	squareRootRemap (const double &inValue, double &outValue)
	Remap on gray level using a square root. More...

Protected Attributes
Contrast::InputParameters	m_inputParameters
	Contrast input execution parameters. More...

bool	m_isInitialized
	Tells if this instance is initialized. More...

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

double	m_squareRemap_factor

double	m_squareRootRemap_gain

Detailed Description

Contrast enhancement.

Apply contrast enhencement on the selected bands.

Definition at line 57 of file Contrast.h.

Member Typedef Documentation

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

protected

Type definition for a remapping function pointer.

Definition at line 234 of file Contrast.h.

Constructor & Destructor Documentation

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

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

Member Function Documentation

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

protected

Execute the decorrelation enhancement contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute the histogram equalization contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute a linear contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute a log contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute the histogram equalization contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute a square contrast following the internal parameters.

Returns: true if OK, false on errors.

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

protected

Execute a square root contrast following the internal parameters.

Returns: true if OK, false on errors.

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

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams Output parameters.

Returns: true if OK, false on errors.

Implements te::rp::Algorithm.

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

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 te::rp::Module::getLastLogStr()

Implements te::rp::Algorithm.

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.

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 352 of file Contrast.h.

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 318 of file Contrast.h.

bool te::rp::Contrast::remapBandLevels	(	const te::rst::Band &	inRasterBand,
		te::rst::Band &	outRasterBand,
		RemapFuncPtrT	remapFuncPtr,
		const bool	enableProgress
	)

protected

Band gray levels remap using a remap function.

Parameters

inRasterBand	Input raster band.
outRasterBand	Output raster band.
remapFuncPtr	The remap function pointer used.
enableProgress	Enable the use of a progress interface.

Returns: true if OK, false on errors.

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

virtual

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

Implements te::rp::Algorithm.

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 330 of file Contrast.h.

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 341 of file Contrast.h.

Member Data Documentation

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

protected

Contrast input execution parameters.

Definition at line 237 of file Contrast.h.

bool te::rp::Contrast::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 240 of file Contrast.h.

double te::rp::Contrast::m_logRemap_gain

protected

Definition at line 309 of file Contrast.h.

double te::rp::Contrast::m_logRemap_offset

protected

Definition at line 310 of file Contrast.h.

double te::rp::Contrast::m_offSetGainRemap_gain

protected

Definition at line 299 of file Contrast.h.

double te::rp::Contrast::m_offSetGainRemap_offset1

protected

Definition at line 297 of file Contrast.h.

double te::rp::Contrast::m_offSetGainRemap_offset2

protected

Definition at line 298 of file Contrast.h.

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

protected

Contrast input execution parameters.

Definition at line 238 of file Contrast.h.

double te::rp::Contrast::m_squareRemap_factor

protected

Definition at line 302 of file Contrast.h.

double te::rp::Contrast::m_squareRootRemap_gain

protected

Definition at line 306 of file Contrast.h.

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

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation