SPATMOD::IMAGE::FILTER_QUANTIZE Class Reference

Filter to quantize samples in image. More...

#include <spatmod/imagefilterquantize.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_QUANTIZE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FILTER_QUANTIZE (STAGE *pPreviousStage, bool TakeOwnership)
virtual ~FILTER_QUANTIZE ()
const SAMPLETABLEGetSampleTable (UINT16 SampleNum) const
ERRVALUE SetSampleTable (UINT16 SampleNum, const SAMPLETABLE &SampleTable)

Detailed Description

Filter to quantize samples in image.

Resulting samples will be unsigned with type and precision determined by the number of sample table entries.


Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_QUANTIZE::FILTER_QUANTIZE ( 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_QUANTIZE::~FILTER_QUANTIZE (  )  [virtual]

Destructor.


Member Function Documentation

const SAMPLETABLE& SPATMOD::IMAGE::FILTER_QUANTIZE::GetSampleTable ( UINT16  SampleNum  )  const

Get sample table.

Parameters:
SampleNum Sample index
ERRVALUE SPATMOD::IMAGE::FILTER_QUANTIZE::SetSampleTable ( UINT16  SampleNum,
const SAMPLETABLE SampleTable 
)

Set sample table.

Any component sample for which a table is not provided will be passed through filter unchanged. Sample values in table must be in numerically ascending sequence. Sample datatype must match corresponding sample of previous stage. Table values are considered to be minimum for quantizing to next sample. For example, if a table contains a single sample with value of 100, source samples < 100 will have output value of 0 and values >= 100 will have output value of 1. Resulting sample data type will be UINT8 with precision of 1.

Parameters:
SampleNum Sample index
SampleTable Sample table

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

Generated on Sun Oct 7 21:39:56 2012 for TNTsdk 2012 by  doxygen 1.6.1