MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIMosaicFilter Class Reference

create a single mosaicked image from a set of images More...

#include <lti_mosaicFilter.h>

Inheritance diagram for LTIMosaicFilter:
LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > LTIOverridePixelProps< BASE > LTIOverrideDimensionsData LTIOverridePixelPropsData

Classes

class  InSceneCallback
 

Public Types

enum  AlphaMode { DoNothing , FromMerge , FromSourceRectangle }
 

Public Member Functions

LT_STATUS initialize (LTIImageStageManager *imageStageManager, const LTIPixel *backgroundPixel, bool useMultires, bool mergeMetadata=true, AlphaMode alphaMode=DoNothing)
 initializer More...
 
LT_STATUS initialize (LTIImageStageManager *imageStageManager, const LTIImage *imageProps, const LTIRStarTree *rtree, AlphaMode alphaMode)
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
 
lt_uint32 getModifications (const LTIScene &scene) const
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 
LTIMaskSource * getMask () const
 
bool getPipelineInfo (LTIPipelineInfo info) const
 
LTIImageStage * getPreviousStage (void) const
 
void 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
 
void setResampleMethod (LTIResampleMethod resampleMethod)
 Set resampling method. More...
 
void setMagSnapThreshold (double threshold)
 
LTIResampleMethod getResampleMethod (void) const
 Get the fill method. More...
 
void setResamplePixelCenter (bool usePixelCenter)
 
bool getReaderScene (lt_uint32 child, const LTIScene &decodeScene, LTIScene &mosaicScene, LTIScene &readerScene) const
 
bool getOverviewReaderScene (const LTIScene &decodeScene, LTIScene &mosaicScene, LTIScene &readerScene) const
 
LT_STATUS forEachImageStageInScene (const LTIScene &scene, InSceneCallback &callback)
 
void setDeleteImages (bool deleteImages)
 
bool getDeleteImages (void) const
 
LT_STATUS loadImage (lt_uint32 i, LTIEmbeddedImage *&embedded, LTIImageStage *&raw)
 
LT_STATUS closeImage (lt_uint32 i)
 
LT_STATUS setPipelineBuilder (LTIPipelineBuilder *pipelineBuilder)
 
const LTIRStarTree & getRTree (void) const
 
LTIImageStageManager & getImageStageManager (void) const
 
bool hasOverviewImage (void) const
 
double getOverviewMag (void) const
 
- Public Member Functions inherited from LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > >
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 LTIMosaicFilter * create (void)
 
static LT_STATUS checkResolutionConformance (LTIImageStageManager *imageStageManager, bool useMultires)
 Check if a set of images can be mosaicked together. More...
 

Protected Member Functions

 LTIMosaicFilter (void)
 
virtual ~ LTIMosaicFilter (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

This class create a single mosaicked image from a set of images.

The set of input images are all assumed to be in the same coordinate space. In general, all the images must have the same resolution; differences that are within a small epsilon or exactly a power of two are optionally allowed.

Definition at line 39 of file lti_mosaicFilter.h.

Member Enumeration Documentation

◆ AlphaMode

Enumerator
DoNothing 
FromMerge 
FromSourceRectangle 

Definition at line 53 of file lti_mosaicFilter.h.

Constructor & Destructor Documentation

◆ LTIMosaicFilter()

LTIMosaicFilter::LTIMosaicFilter ( void  )
protected

◆ ~ LTIMosaicFilter()

virtual LTIMosaicFilter::~ LTIMosaicFilter ( void  )
protectedvirtual

Member Function Documentation

◆ checkResolutionConformance()

static LT_STATUS LTIMosaicFilter::checkResolutionConformance ( LTIImageStageManager *  imageStageManager,
bool  useMultires 
)
static

The parameters to this function mirror those of the constructor: this function will return LT_STS_Success if and only if the images' resolutions are such that a mosaic can be produced.

Parameters
imageStageManagermanages the set of input images
useMultiresallow images with incompatible resolution
Returns
status code indicating success or failure

◆ closeImage()

LT_STATUS LTIMosaicFilter::closeImage ( lt_uint32  i)

◆ create()

static LTIMosaicFilter* LTIMosaicFilter::create ( void  )
static

◆ decodeBegin()

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

◆ decodeEnd()

LT_STATUS LTIMosaicFilter::decodeEnd ( void  )
protected

◆ decodeStrip()

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

◆ forEachImageStageInScene()

LT_STATUS LTIMosaicFilter::forEachImageStageInScene ( const LTIScene &  scene,
InSceneCallback &  callback 
)

◆ getDeleteImages()

bool LTIMosaicFilter::getDeleteImages ( void  ) const

◆ getDimsAtMag()

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

◆ getEncodingCost()

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

◆ getFillMethod()

LTIPixelFillMethod LTIMosaicFilter::getFillMethod ( void  ) const

◆ getFuzzyThreshold()

double LTIMosaicFilter::getFuzzyThreshold ( void  ) const

◆ getImageStageManager()

LTIImageStageManager& LTIMosaicFilter::getImageStageManager ( void  ) const

◆ getMask()

LTIMaskSource* LTIMosaicFilter::getMask ( ) const

◆ getModifications()

lt_uint32 LTIMosaicFilter::getModifications ( const LTIScene &  scene) const

◆ getOverviewMag()

double LTIMosaicFilter::getOverviewMag ( void  ) const

◆ getOverviewReaderScene()

bool LTIMosaicFilter::getOverviewReaderScene ( const LTIScene &  decodeScene,
LTIScene &  mosaicScene,
LTIScene &  readerScene 
) const

◆ getPipelineInfo()

bool LTIMosaicFilter::getPipelineInfo ( LTIPipelineInfo  info) const

◆ getPreviousStage()

LTIImageStage* LTIMosaicFilter::getPreviousStage ( void  ) const

◆ getReaderScene() [1/2]

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

◆ getReaderScene() [2/2]

bool LTIMosaicFilter::getReaderScene ( lt_uint32  child,
const LTIScene &  decodeScene,
LTIScene &  mosaicScene,
LTIScene &  readerScene 
) const

◆ getResampleMethod()

LTIResampleMethod LTIMosaicFilter::getResampleMethod ( void  ) const

◆ getRTree()

const LTIRStarTree& LTIMosaicFilter::getRTree ( void  ) const

◆ hasOverviewImage()

bool LTIMosaicFilter::hasOverviewImage ( void  ) const

◆ initialize() [1/2]

LT_STATUS LTIMosaicFilter::initialize ( LTIImageStageManager *  imageStageManager,
const LTIImage *  imageProps,
const LTIRStarTree *  rtree,
AlphaMode  alphaMode 
)

◆ initialize() [2/2]

LT_STATUS LTIMosaicFilter::initialize ( LTIImageStageManager *  imageStageManager,
const LTIPixel *  backgroundPixel,
bool  useMultires,
bool  mergeMetadata = true,
AlphaMode  alphaMode = DoNothing 
)

Creates an image stage which is a mosaic of the set of input images.

In order to create a mosaic, the ground resolution of all component images must match exactly or be offset by a power of two. For example, two images having 1m resolution can be mosaicked with an image having .5m resolution. However, an image with 1ft resolution will cause an error condition. Slight variations in resolution will be automatically tolerated to accommodate differences in floating-point representation.

The "useMultires" flag will allow images to be mosaicked that do not have compatible ground resolution. Setting this flag will cause some images in the mosaic to be resampled to achieve compatible resolution.

Transparency settings are honored by the mosaic process.

Parameters
imageStageManagermanages the set of input images
backgroundPixelcolor to use for the background of the mosaic
useMultiresresample images with incompatible resolution
mergeMetadatamerge input-file-name, input-file-size and modifications

◆ loadImage()

LT_STATUS LTIMosaicFilter::loadImage ( lt_uint32  i,
LTIEmbeddedImage *&  embedded,
LTIImageStage *&  raw 
)

◆ setDeleteImages()

void LTIMosaicFilter::setDeleteImages ( bool  deleteImages)

◆ setFillMethod()

void LTIMosaicFilter::setFillMethod ( LTIPixelFillMethod  method,
double  fuzzyThreshold 
)
Parameters
methodfill method enum. See LTIPixelFillMethod
fuzzyThresholdfill method enum. See LTIPixelFillMethod

◆ setMagSnapThreshold()

void LTIMosaicFilter::setMagSnapThreshold ( double  threshold)

◆ setPipelineBuilder()

LT_STATUS LTIMosaicFilter::setPipelineBuilder ( LTIPipelineBuilder *  pipelineBuilder)

◆ setResampleMethod()

void LTIMosaicFilter::setResampleMethod ( LTIResampleMethod  resampleMethod)
Parameters
resampleMethodresampling method See LTIResampleMethod

◆ setResamplePixelCenter()

void LTIMosaicFilter::setResamplePixelCenter ( bool  usePixelCenter)

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

Extensis