te::rp::Segmenter::InputParameters Class Reference

Segmenter Input Parameters. More...

#include <Segmenter.h>

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

Public Member Functions

AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
SegmenterStrategyParameters const * getSegStrategyParams () const
 Returns a pointer to the internal specific segmenter strategy parameters. More...
 
 InputParameters ()
 
 InputParameters (const InputParameters &other)
 
const Segmenter::InputParametersoperator= (const Segmenter::InputParameters &params)
 
void reset () throw ( te::rp::Exception )
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
void setSegStrategyParams (const SegmenterStrategyParameters &segStratParams)
 Set specific segmenter strategy parameters. More...
 
 ~InputParameters ()
 

Public Attributes

unsigned char m_blocksOverlapPercent
 The percentage of blocks overlapped area (valid range:0-25, defaul:10). More...
 
bool m_enableBlockProcessing
 If true, the original raster will be splitted into small blocks, each one will be segmented independently and the result will be merged (if possible) at the end (default:true). More...
 
bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 
bool m_enableRasterCache
 Enable/Disable the use of raster data cache (default:true). More...
 
bool m_enableThreadedProcessing
 If true, threaded processing will be performed (best with multi-core or multi-processor systems (default:true). More...
 
std::vector< unsigned int > m_inputRasterBands
 Bands to be processed from the input raster. More...
 
std::vector< std::complex< double > > m_inputRasterNoDataValues
 A vector of values to be used as input raster no-data values or an empty vector indicating to use the default values from the input raster.. More...
 
te::rst::Raster const * m_inputRasterPtr
 Input raster. More...
 
unsigned int m_maxBlockSize
 The input image will be split into blocks with this width for processing, this parameter tells the maximum block lateral size (width or height), the default: 0 - the size will be defined following the current system resources and physical processors number). More...
 
unsigned int m_maxSegThreads
 The maximum number of concurrent segmenter threads (default:0 - automatically found). More...
 
std::string m_strategyName
 The segmenter strategy name see each te::rp::SegmenterStrategyFactory inherited classes documentation for reference (default:RegionGrowingMean). More...
 

Protected Attributes

std::auto_ptr< SegmenterStrategyParametersm_segStratParamsPtr
 A pointer to the internal specific segmenter strategy parameters or NULL if no parameters are present. More...
 

Detailed Description

Segmenter Input Parameters.

Definition at line 81 of file Segmenter.h.

Constructor & Destructor Documentation

te::rp::Segmenter::InputParameters::InputParameters ( )
te::rp::Segmenter::InputParameters::InputParameters ( const InputParameters other)
te::rp::Segmenter::InputParameters::~InputParameters ( )

Member Function Documentation

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

SegmenterStrategyParameters const* te::rp::Segmenter::InputParameters::getSegStrategyParams ( ) const

Returns a pointer to the internal specific segmenter strategy parameters.

Returns
A pointer to the internal specific segmenter strategy parameters, or null if no parameters are present.
const Segmenter::InputParameters& te::rp::Segmenter::InputParameters::operator= ( const Segmenter::InputParameters params)
void te::rp::Segmenter::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::Segmenter::InputParameters::setSegStrategyParams ( const SegmenterStrategyParameters segStratParams)

Set specific segmenter strategy parameters.

Parameters
paramsThe specific segmenter strategy parameters.

Member Data Documentation

unsigned char te::rp::Segmenter::InputParameters::m_blocksOverlapPercent

The percentage of blocks overlapped area (valid range:0-25, defaul:10).

Definition at line 99 of file Segmenter.h.

bool te::rp::Segmenter::InputParameters::m_enableBlockProcessing

If true, the original raster will be splitted into small blocks, each one will be segmented independently and the result will be merged (if possible) at the end (default:true).

Definition at line 95 of file Segmenter.h.

bool te::rp::Segmenter::InputParameters::m_enableProgress

Enable/Disable the progress interface (default:false).

Definition at line 103 of file Segmenter.h.

bool te::rp::Segmenter::InputParameters::m_enableRasterCache

Enable/Disable the use of raster data cache (default:true).

Definition at line 105 of file Segmenter.h.

bool te::rp::Segmenter::InputParameters::m_enableThreadedProcessing

If true, threaded processing will be performed (best with multi-core or multi-processor systems (default:true).

Definition at line 91 of file Segmenter.h.

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

Bands to be processed from the input raster.

Definition at line 87 of file Segmenter.h.

std::vector< std::complex< double > > te::rp::Segmenter::InputParameters::m_inputRasterNoDataValues

A vector of values to be used as input raster no-data values or an empty vector indicating to use the default values from the input raster..

Definition at line 89 of file Segmenter.h.

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

Input raster.

Definition at line 85 of file Segmenter.h.

unsigned int te::rp::Segmenter::InputParameters::m_maxBlockSize

The input image will be split into blocks with this width for processing, this parameter tells the maximum block lateral size (width or height), the default: 0 - the size will be defined following the current system resources and physical processors number).

Definition at line 97 of file Segmenter.h.

unsigned int te::rp::Segmenter::InputParameters::m_maxSegThreads

The maximum number of concurrent segmenter threads (default:0 - automatically found).

Definition at line 93 of file Segmenter.h.

std::auto_ptr< SegmenterStrategyParameters > te::rp::Segmenter::InputParameters::m_segStratParamsPtr
protected

A pointer to the internal specific segmenter strategy parameters or NULL if no parameters are present.

Definition at line 142 of file Segmenter.h.

std::string te::rp::Segmenter::InputParameters::m_strategyName

The segmenter strategy name see each te::rp::SegmenterStrategyFactory inherited classes documentation for reference (default:RegionGrowingMean).

Definition at line 101 of file Segmenter.h.


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