LTIOverridePixelPropsData Struct Reference

#include <lti_imageStageOverrides.h>

Inheritance diagram for LTIOverridePixelPropsData:
LTIOverridePixelProps< BASE > LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIImageFilter > > LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > > LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideMetadata< LTIImageFilter > > > LTIColorTransformer LTIDynamicRangeFilter LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > > > LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > > LTIBandSelectFilter LTIEmbeddedImage LTIImageReader LTIMosaicFilter LTICropFilter LTIGeoImageReader LizardTech::Nitf::ImageReader LTIRawImageReader MrSIDSingleImageReaderBase LTIBBBImageReader

List of all members.

Public Member Functions

 LTIOverridePixelPropsData ()
 ~LTIOverridePixelPropsData ()
LT_STATUS setPixelProps (const LTIPixel &pixelProps)
 set pixel properties of the image
LT_STATUS setPixelBPS (lt_uint8 bps)
LT_STATUS setDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 set the dynamic range of the image
LT_STATUS setDefaultDynamicRange (void)
 set the dynamic range of the image

Public Attributes

LTIPixelm_pixelProps
LTIPixelm_drminPixel
LTIPixelm_drmaxPixel

Detailed Description

Definition at line 96 of file lti_imageStageOverrides.h.


Constructor & Destructor Documentation

LTIOverridePixelPropsData::LTIOverridePixelPropsData (  ) 
LTIOverridePixelPropsData::~LTIOverridePixelPropsData (  ) 

Member Function Documentation

LT_STATUS LTIOverridePixelPropsData::setDefaultDynamicRange ( void   ) 

This function is used to set the dynamic range of the image. The dynamic range consists of the minimum and maximum value for a given sample. This function sets these values to the natural range of the sample datatype.

Derived classes may choose to call this function from within their initialize() method. If the dynamic range is not set, the natural minimum and maximum of the datatype of the sample is used.

Returns:
status code indicating success or failure
LT_STATUS LTIOverridePixelPropsData::setDynamicRange ( const LTIPixel drmin,
const LTIPixel drmax 
)

This function is used to set the dynamic range of the image. The dynamic range consists of the minimum and maximum value for a given sample.

If both the minimum and maximum are NULL, the natural range of the sample datatype will be used.

Derived classes may choose to call this function from within their initialize() method. If the dynamic range is not set, the natural minimum and maximum of the datatype of the sample is used.

Parameters:
drmin the minimum dynamic range value
drmax the maximum dynamic range value
Returns:
status code indicating success or failure

Referenced by LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > >::overrideDynamicRange().

LT_STATUS LTIOverridePixelPropsData::setPixelBPS ( lt_uint8  bps  ) 
LT_STATUS LTIOverridePixelPropsData::setPixelProps ( const LTIPixel pixelProps  ) 

This function is used to set the pixel properties of the image, namely the datatype, colorspace, and number of bands.

Derived classes are required to call this function from within their initialize() method.

Parameters:
pixelProps the basic pixel properties of the image (number of bands, colorspace, datatype)
Returns:
status code indicating success or failure
Examples:
DerivedImageFilter.cpp, and DerivedImageReader.cpp.

Member Data Documentation


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

LizardTech