SPATMOD::IMAGE::FILTER_LOOKUP Class Reference

Filter to apply lookup tables to samples in image. More...

#include <spatmod/imagefilterlookup.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_LOOKUP:

[legend]

List of all members.

Public Member Functions
	FILTER_LOOKUP (STAGE *pPreviousStage, bool TakeOwnership)
virtual	~FILTER_LOOKUP ()
const PIXEL *	GetPixelAboveMax () const
const PIXEL *	GetPixelBelowMin () const
const SAMPLETABLE &	GetSampleTable (UINT16 SampleNum) const
ERRVALUE	SetContrastParm (const CONTRASTPARM &ContrastParm, UINT16 SampleNum=0)
ERRVALUE	SetPixelAboveMaximum (const PIXEL &PixelAboveMax)
ERRVALUE	SetPixelBelowMinimum (const PIXEL &PixelBelowMin)
ERRVALUE	SetSampleTable (UINT16 SampleNum, const SAMPLETABLE &SampleTable, double MinValue=0, double Interval=1)

---

Detailed Description

Filter to apply lookup tables to samples in image.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_LOOKUP::FILTER_LOOKUP	(	STAGE *	pPreviousStage,
		bool	TakeOwnership
	)

Constructor.

Parameters:

	pPreviousStage	Pointer to previous stage
	TakeOwnership	Filter takes ownership of previous stage and will delete when needed

virtual SPATMOD::IMAGE::FILTER_LOOKUP::~FILTER_LOOKUP

(

)

[virtual]

Destructor.

---

Member Function Documentation

const PIXEL* SPATMOD::IMAGE::FILTER_LOOKUP::GetPixelAboveMax

(

)

const [inline]

Get pixel value for samples above maximum in table.

Returns:

Pointer to pixel value, NULL if none set.

const PIXEL* SPATMOD::IMAGE::FILTER_LOOKUP::GetPixelBelowMin

(

)

const [inline]

Get pixel value for samples below minimum in table.

Returns:

Pointer to pixel value, NULL if none set.

const SAMPLETABLE& SPATMOD::IMAGE::FILTER_LOOKUP::GetSampleTable

(

UINT16

SampleNum

)

const

Get sample table.

Parameters:

SampleNum

Sample index

ERRVALUE SPATMOD::IMAGE::FILTER_LOOKUP::SetContrastParm	(	const CONTRASTPARM &	ContrastParm,
		UINT16	SampleNum = 0
	)

Set all table and pixel values from CONTRASTPARM.

Resulting sample DATATYPE will be UINT8.

Parameters:

	ContrastParm	Contrast parameters
	SampleNum	Sample number

ERRVALUE SPATMOD::IMAGE::FILTER_LOOKUP::SetPixelAboveMaximum

(

const PIXEL &

PixelAboveMax

)

Set pixel value to use for samples above maximum.

Pixel properties must match image properties. If not specified will use table maximum.

Parameters:

PixelAboveMax

Pixel value to use

ERRVALUE SPATMOD::IMAGE::FILTER_LOOKUP::SetPixelBelowMinimum

(

const PIXEL &

PixelBelowMin

)

Set pixel value to use for samples below minimum.

Pixel properties must match image properties. If not specified will use table minimum.

Parameters:

PixelBelowMin

Pixel value to use

ERRVALUE SPATMOD::IMAGE::FILTER_LOOKUP::SetSampleTable	(	UINT16	SampleNum,
		const SAMPLETABLE &	SampleTable,
		double	MinValue = 0,
		double	Interval = 1
	)

Set sample table.

Any component sample for which a table is not provided will be passed through filter unchanged.

Parameters:

	SampleNum	Sample index
	SampleTable	Sample table
	MinValue	Minimum data value, corresponds to index 0 in sample table
	Interval	Interval between data values for computing table index

---

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

• spatmod/imagefilterlookup.h