te::rp::Skeleton::InputParameters Class Reference

Skeleton input parameters. More...

#include <Skeleton.h>

Inheritance diagram for te::rp::Skeleton::InputParameters:

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

Public Attributes
unsigned int	m_diffusionMaxIterations
	The maximum number of iterations to perform (zero: no iterations limit). More...
double	m_diffusionRegularization
	A regularization parameter to control the variation from one iteration to the next one (higher values can reduce the number of iterations but can bring the system to an unstable state, valid range: (0,1] positive values ). More...
double	m_diffusionThreshold
	A threshold over the residue from one iteration to another, if the residue drops below this value the process is finished - valid range: (0,1] positive values, lower values will cause more iterations to be performed. More...
bool	m_enableMultiThread
	Enable (true) the use of threads. More...
bool	m_enableProgress
	Enable/Disable the progress interface (default:false). More...
te::rst::Raster const *	m_inputMaskRasterPtr
	A pointer to an input raster (where pixels with zero velues will be ignored) or an null pointer if no input mask raster must be used. More...
unsigned int	m_inputRasterBand
	Bands to process from the input raster. More...
te::rst::Raster const *	m_inputRasterPtr
	Input raster. More...
double	m_skeletonThreshold
	A threshold to select those pixels as being part of the final skeleton - valid range [0,1]. More...

Detailed Description

Skeleton input parameters.

Definition at line 78 of file Skeleton.h.

Constructor & Destructor Documentation

te::rp::Skeleton::InputParameters::InputParameters

(

)

te::rp::Skeleton::InputParameters::InputParameters

(

const InputParameters &

)

te::rp::Skeleton::InputParameters::~InputParameters

(

)

Member Function Documentation

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

const InputParameters& te::rp::Skeleton::InputParameters::operator=

(

const InputParameters &

params

)

void te::rp::Skeleton::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.

Member Data Documentation

unsigned int te::rp::Skeleton::InputParameters::m_diffusionMaxIterations

The maximum number of iterations to perform (zero: no iterations limit).

Definition at line 92 of file Skeleton.h.

double te::rp::Skeleton::InputParameters::m_diffusionRegularization

A regularization parameter to control the variation from one iteration to the next one (higher values can reduce the number of iterations but can bring the system to an unstable state, valid range: (0,1] positive values ).

Definition at line 90 of file Skeleton.h.

double te::rp::Skeleton::InputParameters::m_diffusionThreshold

A threshold over the residue from one iteration to another, if the residue drops below this value the process is finished - valid range: (0,1] positive values, lower values will cause more iterations to be performed.

Definition at line 88 of file Skeleton.h.

bool te::rp::Skeleton::InputParameters::m_enableMultiThread

Enable (true) the use of threads.

Definition at line 94 of file Skeleton.h.

bool te::rp::Skeleton::InputParameters::m_enableProgress

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

Definition at line 98 of file Skeleton.h.

te::rst::Raster const* te::rp::Skeleton::InputParameters::m_inputMaskRasterPtr

A pointer to an input raster (where pixels with zero velues will be ignored) or an null pointer if no input mask raster must be used.

Definition at line 86 of file Skeleton.h.

unsigned int te::rp::Skeleton::InputParameters::m_inputRasterBand

Bands to process from the input raster.

Definition at line 84 of file Skeleton.h.

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

Input raster.

Definition at line 82 of file Skeleton.h.

double te::rp::Skeleton::InputParameters::m_skeletonThreshold

A threshold to select those pixels as being part of the final skeleton - valid range [0,1].

Definition at line 96 of file Skeleton.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/rp/Skeleton.h