SPATMOD::IMAGE::FILTER_OVERLAY Class Reference

Filter to overlay multiple source images. More...

Inheritance diagram for SPATMOD::IMAGE::FILTER_OVERLAY:

Public Types
enum	OVERLAPMETHOD { OVERLAPMETHOD_First, OVERLAPMETHOD_Last, OVERLAPMETHOD_Minimum, OVERLAPMETHOD_Maximum, OVERLAPMETHOD_ClosestToSpecified }
Public Member Functions
	FILTER_OVERLAY (STAGE_ARRAY &PreviousStages, bool TakeOwnership, OVERLAPMETHOD OverlapMethod=OVERLAPMETHOD_First)
virtual	~FILTER_OVERLAY ()
ERRVALUE	SetPixelTestClosest (const PIXEL &PixelTestClosest)

Detailed Description

Filter to overlay multiple source images.

The first source image pixel that is valid will used as the output pixel. All sources images must have the same dimensions and pixel type.

Enumerator:

OVERLAPMETHOD_First	Use first valid pixel.
OVERLAPMETHOD_Last	Use last valid pixel.
OVERLAPMETHOD_Minimum	Use pixel with minimum total of sample values.
OVERLAPMETHOD_Maximum	Use pixel with maximum total of sample values.
OVERLAPMETHOD_ClosestToSpecified	Use pixel closest to specified value.

SPATMOD::IMAGE::FILTER_OVERLAY::FILTER_OVERLAY	(	STAGE_ARRAY &	PreviousStages,
		bool	TakeOwnership,
		OVERLAPMETHOD	OverlapMethod = `OVERLAPMETHOD_First`
	)

Construct using array of previous stage pointers and common ownership.

All previous stages must have same total dimensions and pixel type.

Parameters:

	PreviousStages	Array of previous stages
	TakeOwnership	Filter takes ownership of previous stages and will delete when needed
	OverlapMethod	Overlap control method

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

ERRVALUE SPATMOD::IMAGE::FILTER_OVERLAY::SetPixelTestClosest ( const PIXEL & PixelTestClosest )

Set pixel for OVERLAPMETHOD_ClosestToSpecified.

If not specified, the center of the valid data range will be used by default.

Parameters:

PixelTestClosest

Pixel value, must have same properties as image itself

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