te::map::RasterContrast Class Reference

This class contains the parameters needed to apply dynamic contrast over a raster. More...

#include <RasterContrast.h>

Public Member Functions
std::size_t	getNBands ()
	It gets the contrast number of bands. More...
const te::map::RasterTransform::ContrastType	getType () const
	It gets the contrast type. More...
void	getValues (std::vector< double > &gain, std::vector< double > &offset1, std::vector< double > &offset2, std::vector< double > &min, std::vector< double > &max)
	It get the contrast transformation values. More...
	RasterContrast (const RasterContrast &rhs)
	Copy constructor. More...
	RasterContrast (const te::map::RasterTransform::ContrastType &type, const std::size_t &nBands)
	It constructs a new RasterContrast instance. More...
void	setValues (const double &gain, const double &offset1, const double &offset2, const double &min, const double &max, const std::size_t &band)
	It set the transformation values for contranst of one band. More...
	~RasterContrast ()
	Destructor. More...

Private Attributes
std::vector< double >	m_gain
std::vector< double >	m_max
std::vector< double >	m_min
std::size_t	m_nBands
std::vector< double >	m_offset1
std::vector< double >	m_offset2
te::map::RasterTransform::ContrastType	m_type
	The contrast type. More...

Detailed Description

This class contains the parameters needed to apply dynamic contrast over a raster.

See also

RasterTransform

Definition at line 52 of file RasterContrast.h.

Constructor & Destructor Documentation

RasterContrast() [1/2]

te::map::RasterContrast::RasterContrast	(	const te::map::RasterTransform::ContrastType &	type,
		const std::size_t &	nBands
	)

It constructs a new RasterContrast instance.

Parameters

type	The contrast type.

~RasterContrast()

te::map::RasterContrast::~RasterContrast

(

)

Destructor.

RasterContrast() [2/2]

te::map::RasterContrast::RasterContrast

(

const RasterContrast &

rhs

)

Copy constructor.

Member Function Documentation

getNBands()

std::size_t te::map::RasterContrast::getNBands

(

)

It gets the contrast number of bands.

Returns

The number of bands

getType()

const te::map::RasterTransform::ContrastType te::map::RasterContrast::getType

(

)

const

It gets the contrast type.

Returns

The contrast type.

getValues()

void te::map::RasterContrast::getValues	(	std::vector< double > &	gain,
		std::vector< double > &	offset1,
		std::vector< double > &	offset2,
		std::vector< double > &	min,
		std::vector< double > &	max
	)

It get the contrast transformation values.

Parameters

gain	The vector with gain values of transformation.
offset1	The vector with offset1 values of transformation.
offset2	The vector with offset2 values of transformation.
min	The vector with minimun band values for this transformation.
max	The vector with maximum band values for this transformation.

setValues()

void te::map::RasterContrast::setValues	(	const double &	gain,
		const double &	offset1,
		const double &	offset2,
		const double &	min,
		const double &	max,
		const std::size_t &	band
	)

It set the transformation values for contranst of one band.

Parameters

gain	The gain value of transformation.
offset1	The offset1 value of transformation.
offset2	The offset2 value of transformation.
min	The minimun band value for this transformation.
max	The maximum band value for this transformation.
band	The band index.

Member Data Documentation

m_gain

std::vector<double> te::map::RasterContrast::m_gain

private

Definition at line 113 of file RasterContrast.h.

m_max

std::vector<double> te::map::RasterContrast::m_max

private

Definition at line 117 of file RasterContrast.h.

m_min

std::vector<double> te::map::RasterContrast::m_min

private

Definition at line 116 of file RasterContrast.h.

m_nBands

std::size_t te::map::RasterContrast::m_nBands

private

Definition at line 111 of file RasterContrast.h.

m_offset1

std::vector<double> te::map::RasterContrast::m_offset1

private

Definition at line 114 of file RasterContrast.h.

m_offset2

std::vector<double> te::map::RasterContrast::m_offset2

private

Definition at line 115 of file RasterContrast.h.

m_type

te::map::RasterTransform::ContrastType te::map::RasterContrast::m_type

private

The contrast type.

Definition at line 109 of file RasterContrast.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/maptools/RasterContrast.h