SPATMOD::IMAGE::FILTER_REPLACENULL Class Reference

Filter to replace null pixels with specified value. More...

#include <spatmod/imagefilterreplacenull.h>

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

List of all members.

Public Member Functions

 FILTER_REPLACENULL (STAGE *pSourceImage, bool TakeOwnership, const PIXEL &PixelReplace, bool MakeValid=true)
 FILTER_REPLACENULL (STAGE *pSourceImage, bool TakeOwnership, double ValueReplace=0, bool MakeValid=true)
virtual ~FILTER_REPLACENULL ()

Detailed Description

Filter to replace null pixels with specified value.

Can be useful for controlling the actual value of "null" pixels prior to writing to target.


Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_REPLACENULL::FILTER_REPLACENULL ( STAGE pSourceImage,
bool  TakeOwnership,
double  ValueReplace = 0,
bool  MakeValid = true 
)

Construct with numeric replacement value.

Value must be in allowed range or error will be returned in Initialize.

Parameters:
pSourceImage Source image stage
TakeOwnership Filter takes ownership of source stage and will delete when needed
ValueReplace Value to replace with, will be used for all samples
MakeValid Make replaced values "valid"
SPATMOD::IMAGE::FILTER_REPLACENULL::FILTER_REPLACENULL ( STAGE pSourceImage,
bool  TakeOwnership,
const PIXEL PixelReplace,
bool  MakeValid = true 
)

Construct with replacement PIXEL value.

Pixel properties must match input image or error will be returned in Initialize.

Parameters:
pSourceImage Source image stage
TakeOwnership Filter takes ownership of source stage and will delete when needed
PixelReplace Value to replace with
MakeValid Make replaced values "valid"
virtual SPATMOD::IMAGE::FILTER_REPLACENULL::~FILTER_REPLACENULL (  )  [virtual]

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

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