MrSID Decode SDK for Raster Reference Manual  9.5.4.4709
LTIOverrideBackgroundPixelData Struct Reference

#include <lti_imageStageOverrides.h>

Inheritance diagram for LTIOverrideBackgroundPixelData:
LTIOverrideBackgroundPixel< BASE > LTIOverrideBackgroundPixel< LTIImageFilter > LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > LTIOverrideBackgroundPixel< LTIOverrideMetadata< LTIImageFilter > > 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 LTIRawImageReader MrSIDSingleImageReaderBase Nitf::ImageReader LTIBBBImageReader

Public Member Functions

 LTIOverrideBackgroundPixelData ()
 
 ~LTIOverrideBackgroundPixelData ()
 
LT_STATUS setBackgroundPixel (const LTIPixel *backgroundPixel)
 set the background color of the image More...
 
LT_STATUS setNoDataPixel (const LTIPixel *nodataPixel)
 set the "no data" (transparency) color of the image More...
 

Public Attributes

LTIPixelm_backgroundPixel
 
LTIPixelm_nodataPixel
 

Detailed Description

Definition at line 194 of file lti_imageStageOverrides.h.

Constructor & Destructor Documentation

§ LTIOverrideBackgroundPixelData()

LTIOverrideBackgroundPixelData::LTIOverrideBackgroundPixelData ( )

§ ~LTIOverrideBackgroundPixelData()

LTIOverrideBackgroundPixelData::~LTIOverrideBackgroundPixelData ( )

Member Function Documentation

§ setBackgroundPixel()

LT_STATUS LTIOverrideBackgroundPixelData::setBackgroundPixel ( const LTIPixel backgroundPixel)

This function is used to set the background color of the image.

Derived classes may choose to call this function from within their initialize() method. If the background color is not set, or if NULL is passed in, a background color of black (sample values of 0) will be used. (Exception: for CMYK images, the background is set to white.)

Parameters
backgroundPixelthe data for the background color
Returns
status code indicating success or failure

§ setNoDataPixel()

LT_STATUS LTIOverrideBackgroundPixelData::setNoDataPixel ( const LTIPixel nodataPixel)

This function is used to set the "no data" or transparency color of the image.

Derived classes may choose to call this function from within their initialize() method. If the transparency color is not set, or if NULL is passed in, the image will be assumed to have no transparent pixels.

Parameters
nodataPixelthe data for the transparency color
Returns
status code indicating success or failure

Member Data Documentation

§ m_backgroundPixel

LTIPixel* LTIOverrideBackgroundPixelData::m_backgroundPixel

Definition at line 229 of file lti_imageStageOverrides.h.

§ m_nodataPixel

LTIPixel* LTIOverrideBackgroundPixelData::m_nodataPixel

Definition at line 230 of file lti_imageStageOverrides.h.


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

LizardTech