#include <Segmenter.h>

Inheritance diagram for te::rp::Segmenter::InputParameters:

Public Member Functions
AbstractParameters *	clone () 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::InputParameters &	operator= (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::unique_ptr< SegmenterStrategyParameters >	m_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 src/terralib/rp/Segmenter.h.

Constructor & Destructor Documentation

te::rp::Segmenter::InputParameters::InputParameters ( )

Definition at line 60 of file src/terralib/rp/Segmenter.cpp.

References reset().

Referenced by clone().

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

Definition at line 65 of file src/terralib/rp/Segmenter.cpp.

References operator=(), and reset().

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

Definition at line 71 of file src/terralib/rp/Segmenter.cpp.

References reset().

Member Function Documentation

te::common::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.

Definition at line 115 of file src/terralib/rp/Segmenter.cpp.

References InputParameters().

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.

Definition at line 127 of file src/terralib/rp/Segmenter.cpp.

References m_segStratParamsPtr.

Referenced by te::rp::Segmenter::execute(), and te::rp::Segmenter::segmenterThreadEntry().

const Segmenter::InputParameters & te::rp::Segmenter::InputParameters::operator= ( const Segmenter::InputParameters & params )

Definition at line 92 of file src/terralib/rp/Segmenter.cpp.

References m_blocksOverlapPercent, m_enableBlockProcessing, m_enableProgress, m_enableRasterCache, m_enableThreadedProcessing, m_inputRasterBands, m_inputRasterNoDataValues, m_inputRasterPtr, m_maxBlockSize, m_maxSegThreads, m_segStratParamsPtr, m_strategyName, and reset().

Referenced by InputParameters(), and te::rp::Segmenter::OutputParameters::OutputParameters().

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.

Definition at line 76 of file src/terralib/rp/Segmenter.cpp.

References m_blocksOverlapPercent, m_enableBlockProcessing, m_enableProgress, m_enableRasterCache, m_enableThreadedProcessing, m_inputRasterBands, m_inputRasterNoDataValues, m_inputRasterPtr, m_maxBlockSize, m_maxSegThreads, m_segStratParamsPtr, and m_strategyName.

Referenced by te::rp::Segmenter::initialize(), InputParameters(), operator=(), te::rp::Segmenter::OutputParameters::operator=(), te::rp::Segmenter::OutputParameters::OutputParameters(), te::rp::Segmenter::reset(), te::rp::Segmenter::SegmenterThreadEntryParams::SegmenterThreadEntryParams(), ~InputParameters(), and te::rp::Segmenter::OutputParameters::~OutputParameters().

void te::rp::Segmenter::InputParameters::setSegStrategyParams ( const SegmenterStrategyParameters & segStratParams )

Set specific segmenter strategy parameters.

Parameters

params The specific segmenter strategy parameters.

Definition at line 120 of file src/terralib/rp/Segmenter.cpp.

References te::common::AbstractParameters::clone(), and m_segStratParamsPtr.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizardPage::getInputParams(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), te::idl::rp::RegionGrowingSegmenter(), Segmenter(), and SegmentImage().

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 src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::rp::Segmenter::calcBestBlockSize(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), te::rp::Segmenter::initialize(), operator=(), reset(), and te::qt::widgets::SegmenterAdvancedOptionsWizardPage::SegmenterAdvancedOptionsWizardPage().

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 src/terralib/rp/Segmenter.h.

Referenced by te::qt::widgets::SegmenterWizardPage::apply(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), and reset().

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

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

Definition at line 103 of file src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), operator=(), and reset().

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

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

Definition at line 105 of file src/terralib/rp/Segmenter.h.

Referenced by te::rp::Segmenter::execute(), operator=(), and reset().

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 src/terralib/rp/Segmenter.h.

Referenced by te::qt::widgets::SegmenterWizardPage::apply(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), reset(), and te::qt::widgets::SegmenterAdvancedOptionsWizardPage::SegmenterAdvancedOptionsWizardPage().

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

Bands to be processed from the input raster.

Definition at line 87 of file src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::rp::Segmenter::createCutOffLinesTiff(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterWizardPage::getInputParams(), te::rp::Segmenter::initialize(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), te::idl::rp::RegionGrowingSegmenter(), reset(), Segmenter(), te::rp::Segmenter::segmenterThreadEntry(), and SegmentImage().

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 src/terralib/rp/Segmenter.h.

Referenced by te::rp::Segmenter::execute(), te::qt::widgets::SegmenterWizardPage::getInputParams(), te::rp::Segmenter::initialize(), operator=(), reset(), and te::rp::Segmenter::SegmenterThreadEntryParams::SegmenterThreadEntryParams().

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

Input raster.

Definition at line 85 of file src/terralib/rp/Segmenter.h.

Referenced by te::qt::widgets::SegmenterWizardPage::apply(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::rp::Segmenter::calcBestBlockSize(), te::rp::Segmenter::createCutOffLinesTiff(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterWizardPage::getInputParams(), te::rp::Segmenter::initialize(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), te::idl::rp::RegionGrowingSegmenter(), reset(), Segmenter(), and SegmentImage().

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 src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), reset(), and te::qt::widgets::SegmenterAdvancedOptionsWizardPage::SegmenterAdvancedOptionsWizardPage().

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 src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::qt::widgets::SegmenterWizard::execute(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), reset(), and te::qt::widgets::SegmenterAdvancedOptionsWizardPage::SegmenterAdvancedOptionsWizardPage().

std::unique_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 src/terralib/rp/Segmenter.h.

Referenced by getSegStrategyParams(), operator=(), reset(), and setSegStrategyParams().

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 src/terralib/rp/Segmenter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_SUITE(), te::rp::Segmenter::execute(), te::qt::widgets::SegmenterWizardPage::getInputParams(), te::qt::widgets::SegmenterDialog::on_okPushButton_clicked(), operator=(), te::idl::rp::RegionGrowingSegmenter(), reset(), Segmenter(), te::rp::Segmenter::segmenterThreadEntry(), and SegmentImage().

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

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation