Raster segmenter strategy base class. More...

#include <SegmenterStrategy.h>

Inheritance diagram for te::rp::SegmenterStrategy:

Public Types
enum	BlocksMergingMethod { NoMerging = 0, GradientMerging = 1 }
	Blocks merging method. More...

Public Member Functions
virtual bool	execute (SegmenterIdsManager &segmenterIdsManager, const te::rp::SegmenterSegmentsBlock &block2ProcessInfo, const te::rst::Raster &inputRaster, const std::vector< unsigned int > &inputRasterBands, const std::vector< std::complex< double > > &inputRasterNoDataValues, const std::vector< std::complex< double > > &inputRasterBandMinValues, const std::vector< std::complex< double > > &inputRasterBandMaxValues, te::rst::Raster &outputRaster, const unsigned int outputRasterBand, const bool enableProgressInterface)=0 throw ( te::rp::Exception )
	Executes the segmentation strategy over region delimited by the given block. More...

virtual BlocksMergingMethod	getBlocksMergingMethod () const =0
	Return the strategy blocks merging method. More...

const std::string &	getErrorMessage () const
	Return the current error message if there is any. More...

virtual double	getMemUsageEstimation (const unsigned int bandsToProcess, const unsigned int pixelsNumber) const =0
	Returns a memory estimation (bytes). More...

virtual unsigned int	getOptimalBlocksOverlapSize () const =0
	Returns a optimal blocks overlap size (number of border pixels overlapped between blocks, under one direction). More...

virtual bool	initialize (SegmenterStrategyParameters const *const strategyParams)=0 throw ( te::rp::Exception )
	Initialize the segmentation strategy. More...

virtual void	reset ()
	Clear all internal allocated resources and go back to the initial not-initialized state. More...

virtual bool	shouldComputeMinMaxValues () const =0
	Returns if the min and max pixel values should be computed. More...

virtual	~SegmenterStrategy ()

Protected Member Functions
	SegmenterStrategy ()

void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message. More...

Private Member Functions
SegmenterStrategy &	operator= (const SegmenterStrategy &)

	SegmenterStrategy (const SegmenterStrategy &)

Private Attributes
std::string	m_errorMessage
	Current error message. More...

Detailed Description

Raster segmenter strategy base class.

Definition at line 46 of file SegmenterStrategy.h.

Member Enumeration Documentation

◆ BlocksMergingMethod

enum te::rp::SegmenterStrategy::BlocksMergingMethod

Blocks merging method.

Enumerator
NoMerging	No merging.
GradientMerging	Gradient Merging.

Definition at line 52 of file SegmenterStrategy.h.

Constructor & Destructor Documentation

◆ ~SegmenterStrategy()

virtual te::rp::SegmenterStrategy::~SegmenterStrategy ( )

virtual

◆ SegmenterStrategy() [1/2]

te::rp::SegmenterStrategy::SegmenterStrategy ( )

protected

◆ SegmenterStrategy() [2/2]

te::rp::SegmenterStrategy::SegmenterStrategy ( const SegmenterStrategy & )

private

Member Function Documentation

◆ execute()

virtual bool te::rp::SegmenterStrategy::execute	(	SegmenterIdsManager &	segmenterIdsManager,
		const te::rp::SegmenterSegmentsBlock &	block2ProcessInfo,
		const te::rst::Raster &	inputRaster,
		const std::vector< unsigned int > &	inputRasterBands,
		const std::vector< std::complex< double > > &	inputRasterNoDataValues,
		const std::vector< std::complex< double > > &	inputRasterBandMinValues,
		const std::vector< std::complex< double > > &	inputRasterBandMaxValues,
		te::rst::Raster &	outputRaster,
		const unsigned int	outputRasterBand,
		const bool	enableProgressInterface
	)
throw	(	te::rp::Exception
	)

pure virtual

Executes the segmentation strategy over region delimited by the given block.

Parameters

segmenterIdsManager	The segments IDs manager to be used when acquiring/releaseing unique segment IDs.
block2ProcessInfo	The information about the block of raster that must be processed.
inputRaster	Input raster.
inputRasterBands	Input raster bands.
inputRasterNoDataValues	A vector of values to be used as input raster no-data values.
inputRasterBandMinValues	The minimum value present on each band.
inputRasterBandMinValues	The maximum value present on each band.
outputRaster	Output raster.
outputRasterBand	Output raster band.
enableProgressInterface	Enable the internal strategy to update the progress interface.

Returns: true if OK, false on errors.

Note: The used gaind/ofset calcule: new_value = ( old_value + offset ) * gain

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ getBlocksMergingMethod()

virtual BlocksMergingMethod te::rp::SegmenterStrategy::getBlocksMergingMethod ( ) const

pure virtual

Return the strategy blocks merging method.

Returns: The blocks merging method.

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ getErrorMessage()

const std::string& te::rp::SegmenterStrategy::getErrorMessage ( ) const

Return the current error message if there is any.

Returns: Return the current error message if there is any.

◆ getMemUsageEstimation()

virtual double te::rp::SegmenterStrategy::getMemUsageEstimation	(	const unsigned int	bandsToProcess,
		const unsigned int	pixelsNumber
	)		const

pure virtual

Returns a memory estimation (bytes).

This parameter is used by the segmenter to guess the sub-image blocks size.

Parameters

bandsToProcess	The number of input raster bands that will be processed at the strategy execution time.
pixelsNumber	The number of pixels.

Returns: A positive memory use estimation.

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ getOptimalBlocksOverlapSize()

virtual unsigned int te::rp::SegmenterStrategy::getOptimalBlocksOverlapSize ( ) const

pure virtual

Returns a optimal blocks overlap size (number of border pixels overlapped between blocks, under one direction).

Note: This value will be used in the case where the image is splitted into blocks for segmentation.

Returns: The blocks overlap size.

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ initialize()

virtual bool te::rp::SegmenterStrategy::initialize	(	SegmenterStrategyParameters const *const	strategyParams	)
throw	(	te::rp::Exception
	)

pure virtual

Initialize the segmentation strategy.

Parameters

strategyParams A pointer to the user given specific segmentation strategy parameters ou NULL if no parameters are present.

Returns: true if OK, false on errors.

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ operator=()

SegmenterStrategy& te::rp::SegmenterStrategy::operator= ( const SegmenterStrategy & )

private

◆ reset()

virtual void te::rp::SegmenterStrategy::reset ( )

virtual

Clear all internal allocated resources and go back to the initial not-initialized state.

Reimplemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

◆ setErrorMessage()

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

protected

Set the current error message.

Parameters

newErrorMessage New error message;

◆ shouldComputeMinMaxValues()

virtual bool te::rp::SegmenterStrategy::shouldComputeMinMaxValues ( ) const

pure virtual

Returns if the min and max pixel values should be computed.

Returns: True if min and max values should be computed. False otherwise.

Implemented in te::rp::SegmenterRegionGrowingBaatzStrategy, te::rp::SegmenterRegionGrowingMeanStrategy, and te::rp::SegmenterDummyStrategy.

Member Data Documentation

◆ m_errorMessage

std::string te::rp::SegmenterStrategy::m_errorMessage

private

Current error message.

Definition at line 157 of file SegmenterStrategy.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ BlocksMergingMethod

Constructor & Destructor Documentation

◆ ~SegmenterStrategy()

◆ SegmenterStrategy() [1/2]

◆ SegmenterStrategy() [2/2]

Member Function Documentation

◆ execute()

◆ getBlocksMergingMethod()

◆ getErrorMessage()

◆ getMemUsageEstimation()

◆ getOptimalBlocksOverlapSize()

◆ initialize()

◆ operator=()

◆ reset()

◆ setErrorMessage()

◆ shouldComputeMinMaxValues()

Member Data Documentation

◆ m_errorMessage