MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIEmbeddedImage Class Reference

create a larger frame for the image More...

#include <lti_embeddedImage.h>

Inheritance diagram for LTIEmbeddedImage:
LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideGeoCoord< LTIImageFilter > > > LTIOverridePixelProps< BASE > LTIOverrideDimensionsData LTIOverridePixelPropsData LTICropFilter

Public Types

enum  AlphaMode { DoNothing , FromMerge , FromSourceRectangle }
 

Public Member Functions

LT_STATUS initialize (LTIImageStage *srcImage, lt_uint32 newWidth, lt_uint32 newHeight, double newXPos, double newYPos, const LTIPixel *backgroundPixel, const LTIPixel *nodataPixel, AlphaMode alphaMode=DoNothing)
 initialize More...
 
LT_STATUS initialize (LTIImageStage *srcImage, const LTIGeomRect< lt_int32 > &cropRect, const LTIPixel *backgroundPixel=nullptr, const LTIPixel *nodataPixel=nullptr, AlphaMode alphaMode=DoNothing)
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 
LT_STATUS setFillingBackground (bool fill)
 control whether or not the background of the new "outer" image should be filled More...
 
bool getFillingBackground (void) const
 query whether or not the background of the new "outer" image should be filled More...
 
LT_STATUS setFillMethod (LTIPixelFillMethod method, double fuzzyThreshold)
 Set the fill method which controls how noData pixels are matched. More...
 
LTIPixelFillMethod getFillMethod (void) const
 Get the fill method. More...
 
double getFuzzyThreshold (void) const
 
LT_STATUS setTransparency (double transparency)
 
virtual lt_uint32 getModifications (const LTIScene &scene) const
 
lt_int32 getChildXPosAtMag (double mag) const
 
lt_int32 getChildYPosAtMag (double mag) const
 
bool getChildScene (const LTIScene &parentScene, LTIScene &childScene) const
 
- Public Member Functions inherited from LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideGeoCoord< LTIImageFilter > > >
lt_uint32 getWidth () const
 
lt_uint32 getHeight () const
 
- Public Member Functions inherited from LTIOverridePixelProps< BASE >
const LTIPixel & getPixelProps () const
 
const LTIPixel & getMinDynamicRange () const
 
const LTIPixel & getMaxDynamicRange () const
 
LT_STATUS overridePixelBPS (lt_uint8 bps)
 
LT_STATUS overrideColorSpace (LTIColorSpace colorspace)
 
LT_STATUS overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 
const LTIPixel * getBackgroundPixel () const
 
const LTIPixel * getNoDataPixel () const
 
LT_STATUS overrideBackgroundPixel (const LTIPixel *backgroundPixel)
 
LT_STATUS overrideNoDataPixel (const LTIPixel *nodataPixel)
 

Static Public Member Functions

static LTIEmbeddedImage * create (void)
 
static LT_STATUS push (LTIImageStage *&pipeline, LTIScene &scene, const LTIPixel *backgroundPixel=nullptr)
 

Protected Member Functions

 LTIEmbeddedImage (void)
 
virtual ~ LTIEmbeddedImage (void)
 
LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 
LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 
LT_STATUS decodeEnd (void)
 
- Protected Member Functions inherited from LTIOverridePixelPropsData
 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...
 
- Protected Member Functions inherited from LTIOverrideDimensionsData
 LTIOverrideDimensionsData ()
 
LT_STATUS setDimensions (lt_uint32 width, lt_uint32 height)
 set width and height of the image More...
 

Additional Inherited Members

- Protected Attributes inherited from LTIOverridePixelPropsData
LTIPixel * m_pixelProps
 
LTIPixel * m_drminPixel
 
LTIPixel * m_drmaxPixel
 
LTIPixel * m_backgroundPixel
 
LTIPixel * m_nodataPixel
 
- Protected Attributes inherited from LTIOverrideDimensionsData
lt_uint32 m_width
 
lt_uint32 m_height
 

Detailed Description

Creates a new image stage of the given size, containing the input image stage within it.

This class is used to make an image stage "larger", e.g. to place an image on a larger "canvas" for more flexible decoding. This class is used by the LTIMosaicFilter class to simplify certain computations by making all the input images map to the same underlying grid shape and size.

The embedding process honors the background and nodata pixel settings.

The LTIGeoCoord information for the image stage is updated appropriately.

Definition at line 36 of file lti_embeddedImage.h.

Member Enumeration Documentation

◆ AlphaMode

Enumerator
DoNothing 
FromMerge 
FromSourceRectangle 

Definition at line 44 of file lti_embeddedImage.h.

Constructor & Destructor Documentation

◆ LTIEmbeddedImage()

LTIEmbeddedImage::LTIEmbeddedImage ( void  )
protected

◆ ~ LTIEmbeddedImage()

virtual LTIEmbeddedImage::~ LTIEmbeddedImage ( void  )
protectedvirtual

Member Function Documentation

◆ create()

static LTIEmbeddedImage* LTIEmbeddedImage::create ( void  )
static

◆ decodeBegin()

LT_STATUS LTIEmbeddedImage::decodeBegin ( const LTIPixel &  pixelProps,
const LTIScene &  fullScene 
)
protected

◆ decodeEnd()

LT_STATUS LTIEmbeddedImage::decodeEnd ( void  )
protected

◆ decodeStrip()

LT_STATUS LTIEmbeddedImage::decodeStrip ( LTISceneBuffer &  stripBuffer,
const LTIScene &  stripScene 
)
protected

◆ getChildScene()

bool LTIEmbeddedImage::getChildScene ( const LTIScene &  parentScene,
LTIScene &  childScene 
) const

◆ getChildXPosAtMag()

lt_int32 LTIEmbeddedImage::getChildXPosAtMag ( double  mag) const

◆ getChildYPosAtMag()

lt_int32 LTIEmbeddedImage::getChildYPosAtMag ( double  mag) const

◆ getDimsAtMag()

LT_STATUS LTIEmbeddedImage::getDimsAtMag ( double  mag,
lt_uint32 &  width,
lt_uint32 &  height 
) const

◆ getEncodingCost()

lt_int64 LTIEmbeddedImage::getEncodingCost ( const LTIScene &  scene) const

◆ getFillingBackground()

bool LTIEmbeddedImage::getFillingBackground ( void  ) const
Returns
true if background to be filled

◆ getFillMethod()

LTIPixelFillMethod LTIEmbeddedImage::getFillMethod ( void  ) const

◆ getFuzzyThreshold()

double LTIEmbeddedImage::getFuzzyThreshold ( void  ) const

◆ getModifications()

virtual lt_uint32 LTIEmbeddedImage::getModifications ( const LTIScene &  scene) const
virtual

◆ getReaderScene()

bool LTIEmbeddedImage::getReaderScene ( const LTIScene &  decodeScene,
LTIScene &  readerScene 
) const

◆ initialize() [1/2]

LT_STATUS LTIEmbeddedImage::initialize ( LTIImageStage *  srcImage,
const LTIGeomRect< lt_int32 > &  cropRect,
const LTIPixel *  backgroundPixel = nullptr,
const LTIPixel *  nodataPixel = nullptr,
AlphaMode  alphaMode = DoNothing 
)

◆ initialize() [2/2]

LT_STATUS LTIEmbeddedImage::initialize ( LTIImageStage *  srcImage,
lt_uint32  newWidth,
lt_uint32  newHeight,
double  newXPos,
double  newYPos,
const LTIPixel *  backgroundPixel,
const LTIPixel *  nodataPixel,
AlphaMode  alphaMode = DoNothing 
)

Creates an image stage whose input image is placed within a much larger empty canvas.

Parameters
srcImagethe base image
newWidththe width of the new image stage
newHeightthe height of the new image stage
newXPospixel x-position of the input image in the new image
newYPospixel y-position of the input image in the new image
backgroundPixelbackground pixel color to use for the new image (may be nullptr, in which case the input image's background is used)
nodataPixelnodata pixel color to use for the new image (may be nullptr, in which case the input image's nodata is used)
alphaModehow/should an alpha band be created?

◆ push()

static LT_STATUS LTIEmbeddedImage::push ( LTIImageStage *&  pipeline,
LTIScene &  scene,
const LTIPixel *  backgroundPixel = nullptr 
)
static

◆ setFillingBackground()

LT_STATUS LTIEmbeddedImage::setFillingBackground ( bool  fill)
Parameters
fillset to true to fill the background
Returns
success or failure

◆ setFillMethod()

LT_STATUS LTIEmbeddedImage::setFillMethod ( LTIPixelFillMethod  method,
double  fuzzyThreshold 
)
Parameters
methodfill method enum. See LTIPixelFillMethod
fuzzyThresholdfill method enum. See LTIPixelFillMethod

◆ setTransparency()

LT_STATUS LTIEmbeddedImage::setTransparency ( double  transparency)

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

Extensis