te::rp::Contrast::InputParameters Class Reference

Contrast input parameters. More...

#include <Contrast.h>

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

Public Types
enum	ContrastType { InvalidContrastT = 0, LinearContrastT = 1, HistogramEqualizationContrastT = 2, SetMeanAndStdContrastT = 3 }

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
bool	m_enableProgress
	Enable/Disable the progress interface (default:false). More...
std::vector< double >	m_hECMaxInput
	The contrast maximum input greyscale value of each band. More...
std::vector< unsigned int >	m_inRasterBands
	Bands to be processed from the input raster. More...
te::rst::Raster const *	m_inRasterPtr
	Input raster. More...
std::vector< double >	m_lCMaxInput
	The contrast maximum input greyscale value of each band. More...
std::vector< double >	m_lCMinInput
	The contrast minimum input greyscale value of each band. More...
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...
ContrastType	m_type
	The contrast type to be applied. More...

Detailed Description

Contrast input parameters.

Definition at line 64 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.
SetMeanAndStdContrastT	The contrasted image will have a predefined mean and standard deviation.

Definition at line 69 of file Contrast.h.

Constructor & Destructor Documentation

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

(

)

Definition at line 50 of file Contrast.cpp.

References reset().

te::rp::Contrast::InputParameters::~InputParameters

(

)

Definition at line 55 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 93 of file Contrast.cpp.

const Contrast::InputParameters & te::rp::Contrast::InputParameters::operator=

(

const InputParameters &

params

)

Definition at line 74 of file Contrast.cpp.

References m_enableProgress, m_hECMaxInput, m_inRasterBands, m_inRasterPtr, m_lCMaxInput, m_lCMinInput, m_sMASCMeanInput, m_sMASCStdInput, 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 60 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::execHistogramEqualizationContrast(), te::rp::Contrast::execLinearContrast(), te::rp::Contrast::execSetMeanAndStdContrast(), 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 83 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.

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

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

Input raster.

Definition at line 89 of file Contrast.h.

Referenced by te::qt::widgets::ContrastWizardPage::apply(), te::rp::Contrast::execHistogramEqualizationContrast(), te::rp::Contrast::execLinearContrast(), te::rp::Contrast::execSetMeanAndStdContrast(), te::qt::widgets::ContrastWizard::execute(), te::rp::Contrast::execute(), te::rp::Contrast::initialize(), te::qt::widgets::ContrastDialog::on_okPushButton_clicked(), operator=(), and te::rp::Contrast::remapBandLevels().

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

The contrast maximum input greyscale value of each band.

Definition at line 81 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 79 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_sMASCMeanInput

The mean greyscale to be applied in each band.

Definition at line 85 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 87 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=().

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

The contrast type to be applied.

Definition at line 77 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:/BB_TL5/terralib5/src/terralib/rp/Contrast.h
• C:/BB_TL5/terralib5/src/terralib/rp/Contrast.cpp