MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIOverridePixelPropsData Struct Reference

#include <lti_imageStageOverrides.h>

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

Public Member Functions

 LTIOverridePixelPropsData ()
 
 ~LTIOverridePixelPropsData ()
 
LT_STATUS setPixelProps (const LTIPixel &pixelProps)
 set pixel properties of the image More...
 
LT_STATUS setPixelBPS (lt_uint8 bps)
 
LT_STATUS setColorSpace (LTIColorSpace colorspace)
 
LT_STATUS setDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 set the dynamic range of the image More...
 
LT_STATUS setDefaultDynamicRange (void)
 set the dynamic range of the image More...
 
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

LTIPixel * m_pixelProps
 
LTIPixel * m_drminPixel
 
LTIPixel * m_drmaxPixel
 
LTIPixel * m_backgroundPixel
 
LTIPixel * m_nodataPixel
 

Detailed Description

Definition at line 91 of file lti_imageStageOverrides.h.

Constructor & Destructor Documentation

◆ LTIOverridePixelPropsData()

LTIOverridePixelPropsData::LTIOverridePixelPropsData ( )

◆ ~LTIOverridePixelPropsData()

LTIOverridePixelPropsData::~LTIOverridePixelPropsData ( )

Member Function Documentation

◆ setBackgroundPixel()

LT_STATUS LTIOverridePixelPropsData::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 nullptr 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

Referenced by LTIOverridePixelProps< BASE >::overrideBackgroundPixel().

◆ setColorSpace()

LT_STATUS LTIOverridePixelPropsData::setColorSpace ( LTIColorSpace  colorspace)

◆ setDefaultDynamicRange()

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

◆ setDynamicRange()

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 nullptr, 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
drminthe minimum dynamic range value
drmaxthe maximum dynamic range value
Returns
status code indicating success or failure

Referenced by LTIOverridePixelProps< BASE >::overrideDynamicRange().

◆ setNoDataPixel()

LT_STATUS LTIOverridePixelPropsData::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 nullptr 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

Referenced by LTIOverridePixelProps< BASE >::overrideNoDataPixel().

◆ setPixelBPS()

LT_STATUS LTIOverridePixelPropsData::setPixelBPS ( lt_uint8  bps)

◆ setPixelProps()

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
pixelPropsthe 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

◆ m_backgroundPixel

LTIPixel* LTIOverridePixelPropsData::m_backgroundPixel

◆ m_drmaxPixel

LTIPixel* LTIOverridePixelPropsData::m_drmaxPixel

◆ m_drminPixel

LTIPixel* LTIOverridePixelPropsData::m_drminPixel

◆ m_nodataPixel

LTIPixel* LTIOverridePixelPropsData::m_nodataPixel

◆ m_pixelProps

LTIPixel* LTIOverridePixelPropsData::m_pixelProps

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

Extensis