MrSID Decode SDK for Raster Reference Manual  9.5.1.4427
LTIEmbeddedImage Class Reference

create a larger frame for the image More...

#include <lti_embeddedImage.h>

Inheritance diagram for LTIEmbeddedImage:
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 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
 
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
 

Static Public Member Functions

static LTIEmbeddedImagecreate (void)
 

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)
 

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 42 of file lti_embeddedImage.h.

Member Enumeration Documentation

Enumerator
DoNothing 
FromMerge 
FromSourceRectangle 

Definition at line 51 of file lti_embeddedImage.h.

Constructor & Destructor Documentation

LTIEmbeddedImage::LTIEmbeddedImage ( void  )
protected
virtual LTIEmbeddedImage::~LTIEmbeddedImage ( void  )
protectedvirtual

Member Function Documentation

static LTIEmbeddedImage* LTIEmbeddedImage::create ( void  )
static
LT_STATUS LTIEmbeddedImage::decodeBegin ( const LTIPixel pixelProps,
const LTIScene fullScene 
)
protected
LT_STATUS LTIEmbeddedImage::decodeEnd ( void  )
protected
LT_STATUS LTIEmbeddedImage::decodeStrip ( LTISceneBuffer stripBuffer,
const LTIScene stripScene 
)
protected
bool LTIEmbeddedImage::getChildScene ( const LTIScene parentScene,
LTIScene childScene 
) const
lt_int32 LTIEmbeddedImage::getChildXPosAtMag ( double  mag) const
lt_int32 LTIEmbeddedImage::getChildYPosAtMag ( double  mag) const
LT_STATUS LTIEmbeddedImage::getDimsAtMag ( double  mag,
lt_uint32 width,
lt_uint32 height 
) const
lt_int64 LTIEmbeddedImage::getEncodingCost ( const LTIScene scene) const
bool LTIEmbeddedImage::getFillingBackground ( void  ) const
Returns
true if background to be filled
LTIPixelFillMethod LTIEmbeddedImage::getFillMethod ( void  ) const
double LTIEmbeddedImage::getFuzzyThreshold ( void  ) const
virtual lt_uint32 LTIEmbeddedImage::getModifications ( const LTIScene scene) const
virtual
bool LTIEmbeddedImage::getReaderScene ( const LTIScene decodeScene,
LTIScene readerScene 
) const
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 NULL, in which case the input image's background is used)
nodataPixelnodata pixel color to use for the new image (may be NULL, in which case the input image's nodata is used)
fakeAlphaBandset to true to force this filter to pretend it has an alpha band
LT_STATUS LTIEmbeddedImage::setFillingBackground ( bool  fill)
Parameters
fillset to true to fill the background
Returns
success or failure
LT_STATUS LTIEmbeddedImage::setFillMethod ( LTIPixelFillMethod  method,
double  fuzzyThreshold 
)
Parameters
methodfill method enum. See LTIPixelFillMethod
fuzzyThresholdfill method enum. See LTIPixelFillMethod

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

LizardTech