#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	execHistogramEqualizationContrast ()
	Execute the histogram equalization contrast following the internal parameters. More...

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

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

void	offSetGainRemap (const double &inValue, double &outValue)
	Remap on gray level using an offset (Contrast::m_offSetGainRemap_offset) and a gain value (Contrast::m_offSetGainRemap_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...

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

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

double	m_offSetGainRemap_gain

double	m_offSetGainRemap_offset

Contrast::OutputParameters *	m_outputParametersPtr
	Contrast input execution parameters. More...

Detailed Description

Contrast enhancement.

Apply contrast enhencement on the selected bands.

Definition at line 56 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 168 of file Contrast.h.

Constructor & Destructor Documentation

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

Definition at line 141 of file Contrast.cpp.

References reset().

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

Definition at line 146 of file Contrast.cpp.

Member Function Documentation

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

protected

Execute the histogram equalization contrast following the internal parameters.

Returns: true if OK, false on errors.

Definition at line 384 of file Contrast.cpp.

References te::rst::ConstBandIterator< T >::begin(), te::rst::ConstBandIterator< T >::end(), te::rst::Raster::getBand(), te::rp::GetDataTypeRange(), te::common::Singleton< RasterSummaryManager >::getInstance(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rst::BandProperty::getType(), te::rp::Contrast::InputParameters::m_enableProgress, te::rp::Contrast::InputParameters::m_hECMaxInput, m_inputParameters, te::rp::Contrast::InputParameters::m_inRasterBands, te::rp::Contrast::InputParameters::m_inRasterPtr, m_outputParametersPtr, te::rp::Contrast::OutputParameters::m_outRasterBands, te::rp::Contrast::OutputParameters::m_outRasterPtr, te::rst::Band::setValue(), and te::rst::SUMMARY_R_HISTOGRAM.

Referenced by execute().

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

protected

Execute a linear contrast following the internal parameters.

Returns: true if OK, false on errors.

Definition at line 329 of file Contrast.cpp.

References te::rst::Raster::getBand(), te::rp::GetDataTypeRange(), te::rst::Band::getProperty(), te::rst::BandProperty::getType(), te::rp::Contrast::InputParameters::m_enableProgress, m_inputParameters, te::rp::Contrast::InputParameters::m_inRasterBands, te::rp::Contrast::InputParameters::m_inRasterPtr, te::rp::Contrast::InputParameters::m_lCMaxInput, te::rp::Contrast::InputParameters::m_lCMinInput, m_offSetGainRemap_gain, m_offSetGainRemap_offset, m_outputParametersPtr, te::rp::Contrast::OutputParameters::m_outRasterBands, te::rp::Contrast::OutputParameters::m_outRasterPtr, offSetGainRemap(), and remapBandLevels().

Referenced by execute().

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

protected

Execute the histogram equalization contrast following the internal parameters.

Returns: true if OK, false on errors.

Definition at line 457 of file Contrast.cpp.

References te::rst::ConstBandIterator< T >::begin(), te::rst::ConstBandIterator< T >::end(), te::rst::Raster::getBand(), te::rp::GetDataTypeRange(), te::common::Singleton< RasterSummaryManager >::getInstance(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rst::Band::getRaster(), te::rst::BandProperty::getType(), te::rst::Band::getValue(), te::rp::Contrast::InputParameters::m_enableProgress, m_inputParameters, te::rp::Contrast::InputParameters::m_inRasterBands, te::rp::Contrast::InputParameters::m_inRasterPtr, m_outputParametersPtr, te::rp::Contrast::OutputParameters::m_outRasterBands, te::rp::Contrast::OutputParameters::m_outRasterPtr, te::rp::Contrast::InputParameters::m_sMASCMeanInput, te::rp::Contrast::InputParameters::m_sMASCStdInput, te::rst::Band::setValue(), te::rst::SUMMARY_MEAN, and te::rst::SUMMARY_STD.

Referenced by execute().

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.

Definition at line 150 of file Contrast.cpp.

References execHistogramEqualizationContrast(), execLinearContrast(), execSetMeanAndStdContrast(), te::rst::Raster::getAccessPolicy(), te::rst::Raster::getBand(), te::rst::Raster::getGrid(), te::rst::Raster::getNumberOfBands(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rp::Contrast::InputParameters::HistogramEqualizationContrastT, te::rp::Contrast::InputParameters::LinearContrastT, te::rp::Contrast::OutputParameters::m_createdOutRasterDSType, te::rp::Contrast::OutputParameters::m_createdOutRasterInfo, te::rp::Contrast::OutputParameters::m_createdOutRasterPtr, m_inputParameters, te::rp::Contrast::InputParameters::m_inRasterBands, te::rp::Contrast::InputParameters::m_inRasterPtr, m_isInitialized, m_outputParametersPtr, te::rp::Contrast::OutputParameters::m_outRasterBands, te::rp::Contrast::OutputParameters::m_outRasterPtr, te::rp::Contrast::InputParameters::m_type, te::rst::RasterFactory::make(), te::rp::Contrast::InputParameters::SetMeanAndStdContrastT, TERP_LOG_AND_RETURN_FALSE, TERP_LOG_AND_THROW, TERP_TRUE_OR_RETURN_FALSE, and te::common::WAccess.

Referenced by te::qt::widgets::ContrastWizardPage::apply(), te::qt::widgets::ContrastWizard::execute(), and te::qt::widgets::ContrastDialog::on_okPushButton_clicked().

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.

Definition at line 251 of file Contrast.cpp.

Referenced by te::qt::widgets::ContrastWizardPage::apply(), te::qt::widgets::ContrastWizard::execute(), and te::qt::widgets::ContrastDialog::on_okPushButton_clicked().

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.

Definition at line 324 of file Contrast.cpp.

References m_isInitialized.

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

inlineprotected

Remap on gray level using an offset (Contrast::m_offSetGainRemap_offset) and a gain value (Contrast::m_offSetGainRemap_gain.

Parameters

inValue	Input gray level.
outValue	Output gray level.

Definition at line 217 of file Contrast.h.

Referenced by execLinearContrast().

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.