Dummy strategy (just for testing purposes). More...

#include <SegmenterDummyStrategy.h>

Inheritance diagram for te::rp::SegmenterDummyStrategy:

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

Public Member Functions
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) throw ( te::rp::Exception )
	Executes the segmentation strategy over region delimited by the given block. More...

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

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

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

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

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

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

	SegmenterDummyStrategy ()

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

	~SegmenterDummyStrategy ()

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

Detailed Description

Dummy strategy (just for testing purposes).

Definition at line 41 of file SegmenterDummyStrategy.h.

Member Enumeration Documentation

enum te::rp::SegmenterStrategy::BlocksMergingMethod

inherited

Blocks merging method.

Enumerator
NoMerging	No merging.
GradientMerging	Gradient Merging.

Definition at line 52 of file SegmenterStrategy.h.

Constructor & Destructor Documentation

te::rp::SegmenterDummyStrategy::~SegmenterDummyStrategy ( )

default

te::rp::SegmenterDummyStrategy::SegmenterDummyStrategy ( )

default

Member Function Documentation

bool te::rp::SegmenterDummyStrategy::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
	)

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

Implements te::rp::SegmenterStrategy.

Definition at line 54 of file SegmenterDummyStrategy.cpp.

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

virtual

Return the strategy blocks merging method.

Returns: The blocks merging method.

Implements te::rp::SegmenterStrategy.

Definition at line 163 of file SegmenterDummyStrategy.cpp.

References te::rp::SegmenterStrategy::GradientMerging.

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

inherited

Return the current error message if there is any.

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

Definition at line 45 of file SegmenterStrategy.cpp.

References te::rp::SegmenterStrategy::m_errorMessage.

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

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.

Implements te::rp::SegmenterStrategy.

Definition at line 147 of file SegmenterDummyStrategy.cpp.

unsigned int te::rp::SegmenterDummyStrategy::getOptimalBlocksOverlapSize ( ) const

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.

Implements te::rp::SegmenterStrategy.

Definition at line 153 of file SegmenterDummyStrategy.cpp.

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

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.

Implements te::rp::SegmenterStrategy.

Definition at line 43 of file SegmenterDummyStrategy.cpp.

void te::rp::SegmenterDummyStrategy::reset ( )

virtual

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

Reimplemented from te::rp::SegmenterStrategy.

Definition at line 49 of file SegmenterDummyStrategy.cpp.

References te::rp::SegmenterStrategy::reset().

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

protectedinherited

Set the current error message.

Parameters

newErrorMessage New error message;

Definition at line 50 of file SegmenterStrategy.cpp.

References te::rp::SegmenterStrategy::m_errorMessage.

bool te::rp::SegmenterDummyStrategy::shouldComputeMinMaxValues ( ) const

virtual

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

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

Implements te::rp::SegmenterStrategy.

Definition at line 158 of file SegmenterDummyStrategy.cpp.

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation