te::rp::Contrast::OutputParameters Class Reference

Contrast output parameters. More...

#include <Contrast.h>

Inheritance diagram for te::rp::Contrast::OutputParameters:

Public Member Functions
AbstractParameters *	clone () const
	Create a clone copy of this instance. More...
const OutputParameters &	operator= (const OutputParameters &params)
	OutputParameters ()
	OutputParameters (const OutputParameters &)
void	reset () throw ( te::rp::Exception )
	Clear all internal allocated resources and reset the parameters instance to its initial state. More...
	~OutputParameters ()

Public Attributes
std::string	m_createdOutRasterDSType
	Output raster data source type (as described in te::raster::RasterFactory ), leave empty if the result must be written to the raster pointed m_outRasterPtr. More...
std::map< std::string, std::string >	m_createdOutRasterInfo
	The necessary information to create the raster (as described in te::raster::RasterFactory), leave empty if the result must be written to the raster pointed m_outRasterPtr. More...
std::auto_ptr< te::rst::Raster >	m_createdOutRasterPtr
	A pointer to the created output raster instance, or an empty pointer empty if the result must be written to the raster pointed m_outRasterPtr. More...
std::vector< unsigned int >	m_outRasterBands
	Bands to be processed from the output raster. More...
te::rst::Raster *	m_outRasterPtr
	A pointer to a valid initiated raster instance where the result must be written, leave NULL to create a new instance(in this case the other output parameters must be used). More...

Detailed Description

Contrast output parameters.

The result will be written to the raster instance pointed by m_outRasterPtr (in this case the output bands must also be passed by m_outRasterBands ); or written to a new raster instance created inside the given data source pointed by m_outDataSourcePtr (in this case the data set name must be supplied - m_outDataSetName ).

Definition at line 184 of file Contrast.h.

Constructor & Destructor Documentation

te::rp::Contrast::OutputParameters::OutputParameters

(

)

te::rp::Contrast::OutputParameters::OutputParameters

(

const OutputParameters &

)

te::rp::Contrast::OutputParameters::~OutputParameters

(

)

Member Function Documentation

AbstractParameters* te::rp::Contrast::OutputParameters::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.

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

(

const OutputParameters &

params

)

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

virtual

Clear all internal allocated resources and reset the parameters instance to its initial state.

Implements te::common::AbstractParameters.

Member Data Documentation

std::string te::rp::Contrast::OutputParameters::m_createdOutRasterDSType

Output raster data source type (as described in te::raster::RasterFactory ), leave empty if the result must be written to the raster pointed m_outRasterPtr.

Definition at line 194 of file Contrast.h.

std::map< std::string, std::string > te::rp::Contrast::OutputParameters::m_createdOutRasterInfo

The necessary information to create the raster (as described in te::raster::RasterFactory), leave empty if the result must be written to the raster pointed m_outRasterPtr.

Definition at line 196 of file Contrast.h.

std::auto_ptr< te::rst::Raster > te::rp::Contrast::OutputParameters::m_createdOutRasterPtr

A pointer to the created output raster instance, or an empty pointer empty if the result must be written to the raster pointed m_outRasterPtr.

Definition at line 190 of file Contrast.h.

std::vector< unsigned int > te::rp::Contrast::OutputParameters::m_outRasterBands

Bands to be processed from the output raster.

Definition at line 192 of file Contrast.h.

te::rst::Raster* te::rp::Contrast::OutputParameters::m_outRasterPtr

A pointer to a valid initiated raster instance where the result must be written, leave NULL to create a new instance(in this case the other output parameters must be used).

Definition at line 188 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