#include <Contrast.h>

Inheritance diagram for te::rp::Contrast::InputParameters:

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

	InputParameters ()

const InputParameters &	operator= (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

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.

Definition at line 75 of file Contrast.h.

Constructor & Destructor Documentation

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

Definition at line 51 of file Contrast.cpp.

References reset().

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

Definition at line 56 of file Contrast.cpp.

References te::rp::Contrast::reset().

Member Function Documentation

te::common::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.

Definition at line 121 of file Contrast.cpp.

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

Definition at line 90 of file Contrast.cpp.

References m_enableProgress, m_hECMaxInput, m_inRasterBands, m_inRasterPtr, m_lCMaxInput, m_lCMinInput, m_logCMaxInput, m_logCMinInput, m_sMASCMeanInput, m_sMASCStdInput, m_squareCMaxInput, m_squareCMinInput, m_squareRootCMaxInput, m_squareRootCMinInput, m_type, and te::rp::Contrast::reset().

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.

Definition at line 61 of file Contrast.cpp.

References InvalidContrastT.

Referenced by InputParameters(), and te::rp::Contrast::reset().

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.

Referenced by te::rp::Contrast::execDecorrelationEnhancement(), te::rp::Contrast::execHistogramEqualizationContrast(), te::rp::Contrast::execLinearContrast(), te::rp::Contrast::execLogContrast(), te::rp::Contrast::execSetMeanAndStdContrast(), te::rp::Contrast::execSquareContrast(), te::rp::Contrast::execSquareRootContrast(), te::qt::widgets::ContrastWizard::execute(), and operator=().

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.

Referenced by te::rp::Contrast::execHistogramEqualizationContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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.

Referenced by te::rp::Contrast::execLinearContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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.

Referenced by te::rp::Contrast::execLinearContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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.

Referenced by te::rp::Contrast::execLogContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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.

Referenced by te::rp::Contrast::execLogContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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.

Referenced by te::rp::Contrast::execSetMeanAndStdContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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.

Referenced by te::rp::Contrast::execSetMeanAndStdContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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.

Referenced by te::rp::Contrast::execSquareContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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.

Referenced by te::rp::Contrast::execSquareContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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.

Referenced by te::rp::Contrast::execSquareRootContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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.

Referenced by te::rp::Contrast::execSquareRootContrast(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), and operator=().

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

The contrast type to be applied.

Definition at line 87 of file Contrast.h.

Referenced by te::rp::Contrast::execute(), te::qt::widgets::ContrastWizardPage::getInputParams(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), and operator=().

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

C:/TL5_2015_release/terralib5/src/terralib/rp/Contrast.h
C:/TL5_2015_release/terralib5/src/terralib/rp/Contrast.cpp

Public Member Functions

Public Attributes

Global parameters

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation