te::rp::ClassifierEDStrategy Class Reference

Euclidean Distance Classifier strategy. More...

#include <ClassifierEDStrategy.h>

Inheritance diagram for te::rp::ClassifierEDStrategy:
te::rp::ClassifierStrategy

Classes

class  Parameters
 Classifier Parameters. More...
 

Public Member Functions

 ClassifierEDStrategy ()
 
void enableMultiThread (const bool &enable)
 Enable / disable the use of multiple threads. More...
 
void enableOutputPalette (const bool enabled)
 Enable (true) or disable (false) the creation of a paletted output raster. More...
 
void enableProgressInterface (const bool &enable)
 Enable / disable the progress interface. More...
 
void enableRasterCache (const bool &enable)
 Enable / disable the use of raster data cache. More...
 
bool execute () _NOEXCEPT_OP(false)
 Executes the classification strategy. More...
 
const std::string & getErrorMessage () const
 Return the current error message if there is any. More...
 
void getMetaData (std::map< std::string, std::string > &metadata) const
 Returns strategy-dependent metadata. More...
 
unsigned int getOutputNumberBands (void)
 
bool initialize (ClassifierStrategyParameters const *const strategyParams) _NOEXCEPT_OP(false)
 Initialize the classification strategy. More...
 
std::unique_ptr< te::rst::RasterreleaseOutputRaster ()
 Returns a pointer to the output raster or a void pointer if there is none. More...
 
void setInputPolygons (const std::vector< te::gm::Polygon *> &polygonsPtrs)
 Set the input polygons. More...
 
void setInputRaster (const te::rst::Raster &raster)
 Set the input raster. More...
 
void setInputRasterBands (const std::vector< unsigned int > &rasterBands)
 Set the input raste bandsr. More...
 
void setUserOutputPalette (std::vector< te::rst::BandProperty::ColorEntry > &userPalette)
 Set the output user palette. More...
 
 ~ClassifierEDStrategy ()
 

Protected Member Functions

bool createOutputRaster (const std::vector< int > &bandsDataTypes, const std::vector< double > &noDataValues)
 Create the output raster using the EXPANSIBLE driver. More...
 
virtual void reset ()
 Reset to an initial state. More...
 
void setErrorMessage (const std::string &newErrorMessage)
 Set the current error message. More...
 
bool setOutputRasterPalette (const unsigned int size)
 Create and set the output raster palette folowing the current internal settings. More...
 

Protected Attributes

std::vector< Parameters::ClassIDTm_classesIndex2ID
 An class index ordered vector of classes IDs;. More...
 
std::vector< std::vector< double > > m_classesMeans
 Classes means;. More...
 
bool m_createRasterPalette
 Enable (true) or disable (false) the creation of a paletted output raster. More...
 
bool m_enableMultiThread
 Enable or disable the use multipe threads. More...
 
bool m_enableRasterCache
 Enable or disable the use a raster data cache. More...
 
Parameters::ClassIDT m_highestTrainClassID
 The highest train class ID. More...
 
ClassifierEDStrategy::Parameters m_initParams
 Initialization parameters. More...
 
std::vector< te::gm::Polygon * > const * m_inputPolygonsPtr
 Input polygons. More...
 
std::vector< unsigned int > m_inputRasterBands
 Input raster bands. More...
 
te::rst::Raster const * m_inputRasterPtr
 A pointer to the input raster. More...
 
bool m_isInitialized
 Is this instance initialized? More...
 
std::map< std::string, std::string > m_metaData
 Strategy-dependent metadata. More...
 
std::unique_ptr< te::rst::Rasterm_outputRasterPtr
 A pointer to the output raster. More...
 
bool m_progressInterfaceEnabled
 Progress interface status. 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

Euclidean Distance Classifier strategy.

Definition at line 50 of file ClassifierEDStrategy.h.

Constructor & Destructor Documentation

◆ ClassifierEDStrategy()

te::rp::ClassifierEDStrategy::ClassifierEDStrategy ( )

◆ ~ClassifierEDStrategy()

te::rp::ClassifierEDStrategy::~ClassifierEDStrategy ( )

Member Function Documentation

◆ createOutputRaster()

bool te::rp::ClassifierStrategy::createOutputRaster ( const std::vector< int > &  bandsDataTypes,
const std::vector< double > &  noDataValues 
)
protectedinherited

Create the output raster using the EXPANSIBLE driver.

Parameters
bandsDataTypesBands data types.
noDataValuesA vector of no-data values for each band.
Returns
true if ok,false on errors.
Note
A pointer to the created raster will be handled by m_outputRasterPtr.

◆ enableMultiThread()

void te::rp::ClassifierStrategy::enableMultiThread ( const bool &  enable)
inherited

Enable / disable the use of multiple threads.

Parameters
enableEnable (true) or disable (false) the use of multiple threads.

◆ enableOutputPalette()

void te::rp::ClassifierStrategy::enableOutputPalette ( const bool  enabled)
inherited

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

Parameters
enabledEnable (true) or disable (false) the creation of a paletted output raster.

◆ enableProgressInterface()

void te::rp::ClassifierStrategy::enableProgressInterface ( const bool &  enable)
inherited

Enable / disable the progress interface.

Parameters
enableEnable (true) or disable (false) the progress interface.

◆ enableRasterCache()

void te::rp::ClassifierStrategy::enableRasterCache ( const bool &  enable)
inherited

Enable / disable the use of raster data cache.

Parameters
enableEnable (true) or disable (false) the use of raster cache.

◆ execute()

bool te::rp::ClassifierEDStrategy::execute ( )
virtual

Executes the classification strategy.

Returns
true if OK, false on errors.

Implements te::rp::ClassifierStrategy.

◆ getErrorMessage()

const std::string& te::rp::ClassifierStrategy::getErrorMessage ( ) const
inherited

Return the current error message if there is any.

Returns
Return the current error message if there is any.

◆ getMetaData()

void te::rp::ClassifierStrategy::getMetaData ( std::map< std::string, std::string > &  metadata) const
inherited

Returns strategy-dependent metadata.

Parameters
metadataStrategy-dependent metadata.

◆ getOutputNumberBands()

unsigned int te::rp::ClassifierEDStrategy::getOutputNumberBands ( void  )

◆ initialize()

bool te::rp::ClassifierEDStrategy::initialize ( ClassifierStrategyParameters const *const  strategyParams)
virtual

Initialize the classification strategy.

Parameters
strategyParamsA pointer to the user given specific classification strategy parameters ou NULL if no parameters are present.
Returns
true if OK, false on errors.

Implements te::rp::ClassifierStrategy.

◆ releaseOutputRaster()

std::unique_ptr< te::rst::Raster > te::rp::ClassifierStrategy::releaseOutputRaster ( )
inherited

Returns a pointer to the output raster or a void pointer if there is none.

Returns
Returns a pointer to the output raster or a void pointer if there is none.
Note
The caller of this method must take the ownership of the returned object.

◆ reset()

virtual void te::rp::ClassifierStrategy::reset ( )
protectedvirtualinherited

Reset to an initial state.

◆ setErrorMessage()

void te::rp::ClassifierStrategy::setErrorMessage ( const std::string &  newErrorMessage)
protectedinherited

Set the current error message.

Parameters
newErrorMessageNew error message;

◆ setInputPolygons()

void te::rp::ClassifierStrategy::setInputPolygons ( const std::vector< te::gm::Polygon *> &  polygonsPtrs)
inherited

Set the input polygons.

Parameters
polygonsPtrsInput polygons pointers.
Note
The caller of this method must keep the ownership of the objects.

◆ setInputRaster()

void te::rp::ClassifierStrategy::setInputRaster ( const te::rst::Raster raster)
inherited

Set the input raster.

Parameters
rasterInput raster.

◆ setInputRasterBands()

void te::rp::ClassifierStrategy::setInputRasterBands ( const std::vector< unsigned int > &  rasterBands)
inherited

Set the input raste bandsr.

Parameters
rasterBandsInput raster bands.

◆ setOutputRasterPalette()

bool te::rp::ClassifierStrategy::setOutputRasterPalette ( const unsigned int  size)
protectedinherited

Create and set the output raster palette folowing the current internal settings.

Parameters
sizePalette size.
Returns
true if ok,false on errors.

◆ setUserOutputPalette()

void te::rp::ClassifierStrategy::setUserOutputPalette ( std::vector< te::rst::BandProperty::ColorEntry > &  userPalette)
inherited

Set the output user palette.

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

Member Data Documentation

◆ m_classesIndex2ID

std::vector< Parameters::ClassIDT > te::rp::ClassifierEDStrategy::m_classesIndex2ID
protected

An class index ordered vector of classes IDs;.

Definition at line 109 of file ClassifierEDStrategy.h.

◆ m_classesMeans

std::vector< std::vector< double > > te::rp::ClassifierEDStrategy::m_classesMeans
protected

Classes means;.

Definition at line 111 of file ClassifierEDStrategy.h.

◆ m_createRasterPalette

bool te::rp::ClassifierStrategy::m_createRasterPalette
protectedinherited

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

Definition at line 164 of file ClassifierStrategy.h.

◆ m_enableMultiThread

bool te::rp::ClassifierStrategy::m_enableMultiThread
protectedinherited

Enable or disable the use multipe threads.

Definition at line 159 of file ClassifierStrategy.h.

◆ m_enableRasterCache

bool te::rp::ClassifierStrategy::m_enableRasterCache
protectedinherited

Enable or disable the use a raster data cache.

Definition at line 154 of file ClassifierStrategy.h.

◆ m_highestTrainClassID

Parameters::ClassIDT te::rp::ClassifierEDStrategy::m_highestTrainClassID
protected

The highest train class ID.

Definition at line 105 of file ClassifierEDStrategy.h.

◆ m_initParams

ClassifierEDStrategy::Parameters te::rp::ClassifierEDStrategy::m_initParams
protected

Initialization parameters.

Definition at line 107 of file ClassifierEDStrategy.h.

◆ m_inputPolygonsPtr

std::vector<te::gm::Polygon*> const* te::rp::ClassifierStrategy::m_inputPolygonsPtr
protectedinherited

Input polygons.

Definition at line 179 of file ClassifierStrategy.h.

◆ m_inputRasterBands

std::vector<unsigned int> te::rp::ClassifierStrategy::m_inputRasterBands
protectedinherited

Input raster bands.

Definition at line 174 of file ClassifierStrategy.h.

◆ m_inputRasterPtr

te::rst::Raster const* te::rp::ClassifierStrategy::m_inputRasterPtr
protectedinherited

A pointer to the input raster.

Definition at line 144 of file ClassifierStrategy.h.

◆ m_isInitialized

bool te::rp::ClassifierEDStrategy::m_isInitialized
protected

Is this instance initialized?

Definition at line 103 of file ClassifierEDStrategy.h.

◆ m_metaData

std::map< std::string, std::string > te::rp::ClassifierStrategy::m_metaData
protectedinherited

Strategy-dependent metadata.

Definition at line 184 of file ClassifierStrategy.h.

◆ m_outputRasterPtr

std::unique_ptr< te::rst::Raster > te::rp::ClassifierStrategy::m_outputRasterPtr
protectedinherited

A pointer to the output raster.

Definition at line 169 of file ClassifierStrategy.h.

◆ m_progressInterfaceEnabled

bool te::rp::ClassifierStrategy::m_progressInterfaceEnabled
protectedinherited

Progress interface status.

Definition at line 149 of file ClassifierStrategy.h.

◆ m_userOutputPalette

std::vector< te::rst::BandProperty::ColorEntry > te::rp::ClassifierStrategy::m_userOutputPalette
protectedinherited

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 189 of file ClassifierStrategy.h.


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