te::rp::Classifier::InputParameters Class Reference

Classifier input parameters. More...

#include <Classifier.h>

Inheritance diagram for te::rp::Classifier::InputParameters:
te::rp::AlgorithmInputParameters te::common::AbstractParameters

Public Member Functions

te::common::AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
ClassifierStrategyParameters const * getClassifierStrategyParams () const
 Returns a pointer to the internal specific classifier strategy parameters, or null if no parameters are present. More...
 
 InputParameters ()
 Default constructor. More...
 
 InputParameters (const InputParameters &rhs)
 Copy constructor. More...
 
const Classifier::InputParametersoperator= (const Classifier::InputParameters &params)
 
void reset () throw (te::rp::Exception)
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
void setClassifierStrategyParams (const ClassifierStrategyParameters &p)
 Set specific classifier strategy parameters. More...
 
 ~InputParameters ()
 

Public Attributes

ClassifierStrategyParametersm_classifierStrategyParamsPtr
 Internal specific classifier strategy parameters. More...
 
bool m_createRasterPalette
 Enable (true) or disable (false) the creation of a paletted output raster (default:true). More...
 
bool m_enableMultiThread
 Enable (true) or disable (false) the use multiple threads (default:true). More...
 
bool m_enableProgressInterface
 Enable (true) or disable (false) the use of a progress interface (default: disabled). More...
 
bool m_enableRasterCache
 Enable (true) or disable (false) the use of memory raster data cache (default:true). More...
 
std::vector< te::gm::Polygon * > m_inputPolygons
 The polygons to be classified when using object-based image analysis (OBIA). More...
 
std::vector< unsigned int > m_inputRasterBands
 Bands to be processed from the input raster. More...
 
te::rst::Raster const * m_inputRasterPtr
 Input raster. More...
 
std::string m_strategyName
 The classifier strategy name see each te::rp::ClassifierStrategyFactory inherited classes documentation for reference. More...
 
std::vector< te::rst::BandProperty::ColorEntrym_userOutputPalette
 User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette. More...
 

Detailed Description

Classifier input parameters.

Definition at line 75 of file Classifier.h.

Constructor & Destructor Documentation

te::rp::Classifier::InputParameters::InputParameters ( )

Default constructor.

te::rp::Classifier::InputParameters::InputParameters ( const InputParameters rhs)

Copy constructor.

Parameters
rhsThe right-hand side Raster.
te::rp::Classifier::InputParameters::~InputParameters ( )

Member Function Documentation

te::common::AbstractParameters* te::rp::Classifier::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.

ClassifierStrategyParameters const* te::rp::Classifier::InputParameters::getClassifierStrategyParams ( ) const

Returns a pointer to the internal specific classifier strategy parameters, or null if no parameters are present.

const Classifier::InputParameters& te::rp::Classifier::InputParameters::operator= ( const Classifier::InputParameters params)
void te::rp::Classifier::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.

void te::rp::Classifier::InputParameters::setClassifierStrategyParams ( const ClassifierStrategyParameters p)

Set specific classifier strategy parameters.

Parameters
pThe specific classifier strategy parameters.

Member Data Documentation

ClassifierStrategyParameters* te::rp::Classifier::InputParameters::m_classifierStrategyParamsPtr

Internal specific classifier strategy parameters.

Definition at line 122 of file Classifier.h.

bool te::rp::Classifier::InputParameters::m_createRasterPalette

Enable (true) or disable (false) the creation of a paletted output raster (default:true).

Definition at line 116 of file Classifier.h.

bool te::rp::Classifier::InputParameters::m_enableMultiThread

Enable (true) or disable (false) the use multiple threads (default:true).

Definition at line 118 of file Classifier.h.

bool te::rp::Classifier::InputParameters::m_enableProgressInterface

Enable (true) or disable (false) the use of a progress interface (default: disabled).

Definition at line 115 of file Classifier.h.

bool te::rp::Classifier::InputParameters::m_enableRasterCache

Enable (true) or disable (false) the use of memory raster data cache (default:true).

Definition at line 117 of file Classifier.h.

std::vector<te::gm::Polygon*> te::rp::Classifier::InputParameters::m_inputPolygons

The polygons to be classified when using object-based image analysis (OBIA).

Definition at line 120 of file Classifier.h.

std::vector<unsigned int> te::rp::Classifier::InputParameters::m_inputRasterBands

Bands to be processed from the input raster.

Definition at line 119 of file Classifier.h.

te::rst::Raster const* te::rp::Classifier::InputParameters::m_inputRasterPtr

Input raster.

Definition at line 114 of file Classifier.h.

std::string te::rp::Classifier::InputParameters::m_strategyName

The classifier strategy name see each te::rp::ClassifierStrategyFactory inherited classes documentation for reference.

Definition at line 121 of file Classifier.h.

std::vector< te::rst::BandProperty::ColorEntry > te::rp::Classifier::InputParameters::m_userOutputPalette

User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette.

Definition at line 123 of file Classifier.h.


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