SPATMOD::IMAGE::FILTER_VALIDITYNEAR Class Reference

Filter to determine validity based on nearness to specified pixel values. More...

Inheritance diagram for SPATMOD::IMAGE::FILTER_VALIDITYNEAR:

Public Types
enum	MEASURE { MEASURE_Euclidean, MEASURE_Orthogonal }
Public Member Functions
	FILTER_VALIDITYNEAR (STAGE *pPreviousStage, bool TakeOwnership, MEASURE Measure, bool ResultValid, bool TestOpacity=false)
virtual	~FILTER_VALIDITYNEAR ()
ERRVALUE	AddValue (const COLOR &color, double distance, bool use8bit=true)
ERRVALUE	AddValue (const PIXEL &value, double distance)
ERRVALUE	SetSamplesTest (const UINT16 *SamplesTest, UINT16 NumSamplesTest)

Detailed Description

Filter to determine validity based on nearness to specified pixel values.

At present, all samples selected for testing must have the same DATATYPE.

Measurement method for distance.

Enumerator:

MEASURE_Euclidean
MEASURE_Orthogonal

SPATMOD::IMAGE::FILTER_VALIDITYNEAR::FILTER_VALIDITYNEAR	(	STAGE *	pPreviousStage,
		bool	TakeOwnership,
		MEASURE	Measure,
		bool	ResultValid,
		bool	TestOpacity = `false`
	)

Constructor.

Parameters:

	pPreviousStage	Pointer to previous stage
	TakeOwnership	Filter takes ownership of previous stage and will delete when needed
	Measure	Measurement method for nearness
	ResultValid	True if pixels "near" test values are valid, false if not
	TestOpacity	True to test opacity samples, false to ignore

virtual SPATMOD::IMAGE::FILTER_VALIDITYNEAR::~FILTER_VALIDITYNEAR ( ) [virtual]

ERRVALUE SPATMOD::IMAGE::FILTER_VALIDITYNEAR::AddValue	(	const COLOR &	color,
		double	distance,
		bool	use8bit = `true`
	)

Add value as COLOR to test.

Image pixel type must be appropriate (eg, RGB or RGBA).

Parameters:

	color	Color to add
	distance	Distance
	use8bit	Use 8-bit RGB values regardless of input pixel datatype

ERRVALUE SPATMOD::IMAGE::FILTER_VALIDITYNEAR::AddValue	(	const PIXEL &	value,
		double	distance
	)

Add value to set to test.

Must be done before Initialize().

Parameters:

	value	Value to add, type must match image
	distance	Distance

ERRVALUE SPATMOD::IMAGE::FILTER_VALIDITYNEAR::SetSamplesTest	(	const UINT16 *	SamplesTest,
		UINT16	NumSamplesTest
	)

Set which samples to test.

If used, must be done before Initialize.

Parameters:

	SamplesTest	Array of sample indices to test
	NumSamplesTest	Number of sample indices to test

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