MrSID Decode SDK for Raster Reference Manual 9.5.5.5244
LTIMultiResFilter Class Reference

add resolutions to the image More...

#include <lti_multiresFilter.h>

Inheritance diagram for LTIMultiResFilter:
Collaboration diagram for LTIMultiResFilter:

Public Member Functions

LT_STATUS initialize (LTIImageStage *srcImage)
 initializer More...
 
LT_STATUS initialize (LTIImageStage *srcImage, lt_int8 scaleFactor)
 initializer (for compatibly with the old LTIStaticZoomFilter) More...
 
LT_STATUS initialize (LTIImageStage *srcImage, double deltaMag, double minMag, double maxMag)
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
 get image width and height at given magnification More...
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 get the cost to encode this scene More...
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 get the underlying scene to be used More...
 
virtual lt_uint32 getModifications (const LTIScene &scene) const
 get the modification bitfield for this image More...
 
bool getPipelineInfo (LTIPipelineInfo info) const
 
LT_STATUS setResampleMethod (LTIResampleMethod resampleMethod)
 Set resampling method. More...
 
LT_STATUS setResamplePixelCenter (bool usePixelCenter)
 
void setMagSnapThreshold (double threshold)
 
void setDeltaMagXY (double deltaMagX, double deltaMagY)
 
- Public Member Functions inherited from LTIOverrideDimensions< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideStripHeight< LTIImageFilter > > > >
lt_uint32 getWidth () const
 
lt_uint32 getHeight () const
 
- Public Member Functions inherited from LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideStripHeight< LTIImageFilter > > >
const LTIGeoCoord & getGeoCoord () const
 
bool isGeoCoordImplicit () const
 
LT_STATUS overrideGeoCoord (const LTIGeoCoord &geoCoord)
 
- Public Member Functions inherited from LTIOverrideMagnification< LTIOverrideStripHeight< LTIImageFilter > >
double getMinMagnification () const
 
double getMaxMagnification () const
 
- Public Member Functions inherited from LTIOverrideStripHeight< LTIImageFilter >
lt_uint32 getStripHeight () const
 
LT_STATUS setStripHeight (lt_uint32 stripHeight)
 
- Public Member Functions inherited from LTIImageFilter
lt_uint32 getWidth () const
 get image width More...
 
lt_uint32 getHeight () const
 get image height More...
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
 get image width and height at given magnification More...
 
const LTIPixel & getPixelProps () const
 get the pixel properties of the image More...
 
const LTIPixel * getBackgroundPixel () const
 get the values of the background pixel More...
 
const LTIPixel * getNoDataPixel () const
 get the values of the "no data" (transparency) pixel More...
 
const LTIPixelLookupTable * getPixelLookupTable () const
 get the color lookup table, if any More...
 
const LTIPixel & getMinDynamicRange () const
 get the minimum dynamic range value of image More...
 
const LTIPixel & getMaxDynamicRange () const
 get the maximum dynamic range value of image More...
 
const LTIGeoCoord & getGeoCoord () const
 get the geographic coordinates of the image More...
 
bool isGeoCoordImplicit () const
 is geo information "real" or not More...
 
const LTIMetadataDatabase & getMetadata () const
 get the metadata associated with the image More...
 
double getMinMagnification () const
 get the minimum magnification More...
 
double getMaxMagnification () const
 get the maximum magnification More...
 
bool isSelective () const
 check if image supports "random access" decoding More...
 
lt_uint32 getModifications (const LTIScene &scene) const
 get the modification bitfield for this image More...
 
LT_STATUS getMetadataBlob (const char *type, LTIOStreamInf *&stream) const
 extract the metadata associated with the image of the given type More...
 
bool hasMetadataBlob (const char *type) const
 
void setProgressDelegate (LTIProgressDelegate *delegate)
 set progress delegate More...
 
LTIProgressDelegate * getProgressDelegate () const
 get progress delegate More...
 
void setInterruptDelegate (LTIInterruptDelegate *delegate)
 set interrupt delegate More...
 
LTIInterruptDelegate * getInterruptDelegate () const
 get interrupt delegate More...
 
lt_uint32 getStripHeight () const
 get strip height More...
 
LT_STATUS setStripHeight (lt_uint32 stripHeight)
 set the strip height More...
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 get the cost to encode this scene More...
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 get the underlying scene to be used More...
 
LT_STATUS overrideBackgroundPixel (const LTIPixel *backgroundPixel)
 override the background color of the image More...
 
LT_STATUS overrideNoDataPixel (const LTIPixel *nodataPixel)
 override the "no data" (transparency) color of the image More...
 
LT_STATUS overrideGeoCoord (const LTIGeoCoord &geoCoord)
 override the geographic coordinates of the image More...
 
LT_STATUS overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 override the dynamic range of the image More...
 
LT_STATUS overridePixelBPS (lt_uint8)
 override the bits-per-sample of the image's (sample's) datatype More...
 
LT_STATUS overridePixelLookupTable (const LTIPixelLookupTable *pixelLookupTable)
 override the CLUT of the image More...
 
LT_STATUS overrideMetadata (const LTIMetadataDatabase &metadata)
 override the metadata of the image More...
 
LT_STATUS overrideColorSpace (LTIColorSpace colorspace)
 override the colorspace of all the pixel properties (PixelProps, NoData, Background, Min/MaxDynamicRange) More...
 
LTIMaskSource * getMask () const
 
bool getPipelineInfo (LTIPipelineInfo info) const
 
LTIImageStage * getPreviousStage (void) const
 
- Public Member Functions inherited from LTIImageStage
virtual void setProgressDelegate (LTIProgressDelegate *delegate)=0
 set progress delegate More...
 
virtual LTIProgressDelegate * getProgressDelegate () const =0
 get progress delegate More...
 
virtual void setInterruptDelegate (LTIInterruptDelegate *delegate)=0
 set interrupt delegate More...
 
virtual LTIInterruptDelegate * getInterruptDelegate () const =0
 get interrupt delegate More...
 
LT_STATUS read (const LTIScene &scene, LTISceneBuffer &buffer)
 read (decode) a scene from the image More...
 
virtual LT_STATUS readBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 start strip-based read More...
 
virtual LT_STATUS readStrip (LTISceneBuffer &buffer, const LTIScene &stripScene)
 read a strip from the image More...
 
virtual LT_STATUS readEnd ()
 finish strip-based read More...
 
virtual lt_uint32 getStripHeight () const =0
 get strip height More...
 
virtual LT_STATUS setStripHeight (lt_uint32 stripHeight)=0
 set the strip height More...
 
virtual lt_int64 getEncodingCost (const LTIScene &scene) const =0
 get the cost to encode this scene More...
 
virtual bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const =0
 get the underlying scene to be used More...
 
lt_uint32 getNumStrips () const
 get number of strips in scene More...
 
LTIScene getStripScene (lt_uint32 stripNumber) const
 get a strip for current scene More...
 
virtual LT_STATUS overrideBackgroundPixel (const LTIPixel *backgroundPixel)=0
 override the background color of the image More...
 
virtual LT_STATUS overrideNoDataPixel (const LTIPixel *nodataPixel)=0
 override the "no data" (transparency) color of the image More...
 
virtual LT_STATUS overrideGeoCoord (const LTIGeoCoord &geoCoord)=0
 override the geographic coordinates of the image More...
 
virtual LT_STATUS overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)=0
 override the dynamic range of the image More...
 
virtual LT_STATUS overridePixelBPS (lt_uint8)=0
 override the bits-per-sample of the image's (sample's) datatype More...
 
virtual LT_STATUS overridePixelLookupTable (const LTIPixelLookupTable *pixelLookupTable)=0
 override the CLUT of the image More...
 
virtual LT_STATUS overrideMetadata (const LTIMetadataDatabase &metadata)=0
 override the metadata of the image More...
 
virtual LT_STATUS overrideColorSpace (LTIColorSpace colorspace)=0
 override the colorspace of all the pixel properties (PixelProps, NoData, Background, Min/MaxDynamicRange) More...
 
virtual LTIMaskSource * getMask () const =0
 
virtual bool getPipelineInfo (LTIPipelineInfo info) const =0
 
virtual LTIImageStage * getPreviousStage () const =0
 
- Public Member Functions inherited from LTIImage
virtual lt_uint32 getWidth () const =0
 get image width More...
 
virtual lt_uint32 getHeight () const =0
 get image height More...
 
virtual LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const =0
 get image width and height at given magnification More...
 
lt_uint16 getNumBands () const
 get number of bands More...
 
lt_uint16 getNumBandsWithoutAlpha () const
 get number of bands without alpha More...
 
LTIColorSpace getColorSpace () const
 get colorspace More...
 
LTIDataType getDataType () const
 get data type More...
 
virtual const LTIPixel & getPixelProps () const =0
 get the pixel properties of the image More...
 
virtual const LTIPixel * getBackgroundPixel () const =0
 get the values of the background pixel More...
 
virtual const LTIPixel * getNoDataPixel () const =0
 get the values of the "no data" (transparency) pixel More...
 
virtual const LTIPixelLookupTable * getPixelLookupTable () const =0
 get the color lookup table, if any More...
 
virtual const LTIPixel & getMinDynamicRange () const =0
 get the minimum dynamic range value of image More...
 
virtual const LTIPixel & getMaxDynamicRange () const =0
 get the maximum dynamic range value of image More...
 
bool isNaturalDynamicRange () const
 check if the range is "complete" or not More...
 
virtual const LTIGeoCoord & getGeoCoord () const =0
 get the geographic coordinates of the image More...
 
virtual bool isGeoCoordImplicit () const =0
 is geo information "real" or not More...
 
virtual const LTIMetadataDatabase & getMetadata () const =0
 get the metadata associated with the image More...
 
virtual double getMinMagnification () const =0
 get the minimum magnification More...
 
virtual double getMaxMagnification () const =0
 get the maximum magnification More...
 
virtual bool isSelective () const =0
 check if image supports "random access" decoding More...
 
virtual lt_uint32 getModifications (const LTIScene &scene) const =0
 get the modification bitfield for this image More...
 
virtual LT_STATUS getMetadataBlob (const char *type, LTIOStreamInf *&stream) const
 extract the metadata associated with the image of the given type More...
 
virtual bool hasMetadataBlob (const char *type) const
 
lt_int64 getNominalImageSizeWithoutAlpha () const
 get the nominal size of the image, not considering the alpha band More...
 
lt_int64 getNominalImageSizeWithAlpha () const
 get the nominal size of the image, including the alpha band More...
 
void getGeoPoint (LTIPosition position, double &x, double &y) const
 get position of a named point More...
 
LTIPixel * createBackgroundPixel () const
 return new background pixel More...
 
- Public Member Functions inherited from LTIReferenceCountedObject
virtual void retain (void) const
 increment reference counter More...
 
virtual void release (void) const
 decrement the reference counter and delete the object when the counter is zero More...
 

Static Public Member Functions

static LTIMultiResFilter * create (void)
 
static double magForIcon (const LTIImage &image, lt_uint32 iconSize)
 
static double magForIcon (lt_uint32 width, lt_uint32 height, lt_uint32 iconSize)
 
static LT_STATUS push (LTIImageStage *&pipeline, const LTIScene &dstScene, LTIResampleMethod method=LTI_RESAMPLE_NEAREST)
 
static LT_STATUS push (LTIImageStage *&pipeline, double mag, LTIResampleMethod method=LTI_RESAMPLE_NEAREST)
 

Protected Types

enum  Mode {
  MODE_INVALID , MODE_RESAMPLE , MODE_PASSTHROUGH , MODE_DOWNSAMPLE_FULLREAD ,
  MODE_ALL_AT_ONCE
}
 
enum  { kMaxMagnification = 512 }
 

Protected Member Functions

 LTIMultiResFilter (void)
 
virtual ~LTIMultiResFilter (void)
 
LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 start strip-based read More...
 
LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 read a strip from the image More...
 
LT_STATUS decodeEnd (void)
 finish strip-based read More...
 
bool getChildScene (const LTIScene &scene, Mode &mode, double &xScale, double &yScale, LTIScene &childScene) const
 
- Protected Member Functions inherited from LTIImageFilter
 LTIImageFilter (void)
 
virtual ~LTIImageFilter (void)
 
LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 start strip-based read More...
 
LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 read a strip from the image More...
 
LT_STATUS decodeEnd (void)
 finish strip-based read More...
 
LT_STATUS init (LTIImageStage *previousStage)
 
void releasePreviousStageNow (void)
 
void changePreviousStage (LTIImageStage *newPref)
 
- Protected Member Functions inherited from LTIImageStage
 LTIImageStage (void)
 
virtual ~LTIImageStage (void)
 
LT_STATUS fillBackground (const LTIScene &scene, LTISceneBuffer &buffer)
 fill the background of the scene More...
 
LT_STATUS fillBackground (const LTIScene &scene, LTISceneBuffer &buffer, const LTIPixel &color)
 fill the scene to given pixel More...
 
bool isBandSelected (const LTIPixel &pixelProps) const
 
virtual LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)=0
 start strip-based read More...
 
virtual LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)=0
 read a strip from the image More...
 
virtual LT_STATUS decodeEnd (void)=0
 finish strip-based read More...
 
const LTIScene & getFullScene () const
 get full scene More...
 
- Protected Member Functions inherited from LTIImage
 LTIImage (void)
 
virtual ~LTIImage (void)
 
- Protected Member Functions inherited from LTIReferenceCountedObject
 LTIReferenceCountedObject (void)
 
virtual ~LTIReferenceCountedObject (void)
 
- Protected Member Functions inherited from LTIOverrideStripHeightData
 LTIOverrideStripHeightData ()
 
- Protected Member Functions inherited from LTIOverrideMagnificationData
 LTIOverrideMagnificationData ()
 
LT_STATUS setMagnification (double minMag, double maxMag)
 set the minimum and maximum magnifications of the image properties More...
 
- Protected Member Functions inherited from LTIOverrideGeoCoordData
 LTIOverrideGeoCoordData ()
 
 ~LTIOverrideGeoCoordData ()
 
LT_STATUS setGeoCoord (const LTIGeoCoord &geoCoord)
 set the geographic coordinates of the image More...
 
LT_STATUS setDefaultGeoCoord (const LTIImage &image)
 set the geographic coordinates 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 LTIOverrideStripHeightData
lt_uint32 m_stripHeight
 
- Protected Attributes inherited from LTIOverrideMagnificationData
double m_minMag
 
double m_maxMag
 
- Protected Attributes inherited from LTIOverrideGeoCoordData
LTIGeoCoord * m_geoCoord
 
bool m_geoCoordImplicit
 
- Protected Attributes inherited from LTIOverrideDimensionsData
lt_uint32 m_width
 
lt_uint32 m_height
 

Detailed Description

Extends the magnification range of an image, to allow decodes at different resolutions than the image stage would normally allow.

Note that this class is not the same as at the LTIStaticZoomFilter class, which scales the magnification statically for the pipeline when initially constructed. This class allows for the zoom level to be extended for an individual decode operation.

Definition at line 34 of file lti_multiresFilter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kMaxMagnification 

Definition at line 138 of file lti_multiresFilter.h.

◆ Mode

enum LTIMultiResFilter::Mode
protected
Enumerator
MODE_INVALID 
MODE_RESAMPLE 
MODE_PASSTHROUGH 
MODE_DOWNSAMPLE_FULLREAD 
MODE_ALL_AT_ONCE 

Definition at line 123 of file lti_multiresFilter.h.

Constructor & Destructor Documentation

◆ LTIMultiResFilter()

LTIMultiResFilter::LTIMultiResFilter ( void  )
protected

◆ ~LTIMultiResFilter()

virtual LTIMultiResFilter::~LTIMultiResFilter ( void  )
protectedvirtual

Member Function Documentation

◆ create()

static LTIMultiResFilter * LTIMultiResFilter::create ( void  )
static

◆ decodeBegin()

LT_STATUS LTIMultiResFilter::decodeBegin ( const LTIPixel &  pixelProps,
const LTIScene &  fullScene 
)
protectedvirtual

This function is called by readBegin() to start the actual class-specific work for decoding a scene.

Derived classes must implement this function.

This function should never be called directly.

Parameters
pixelPropsthe band selection
fullScenethe full scene to be read
Returns
status code indicating success or failure

Reimplemented from LTIImageFilter.

◆ decodeEnd()

LT_STATUS LTIMultiResFilter::decodeEnd ( void  )
protectedvirtual

This function is called by readEnd() to complete the actual class-specific work for decoding a scene.

Derived classes must implement this function.

This function should never be called directly.

Returns
status code indicating success or failure

Reimplemented from LTIImageFilter.

◆ decodeStrip()

LT_STATUS LTIMultiResFilter::decodeStrip ( LTISceneBuffer &  stripBuffer,
const LTIScene &  stripScene 
)
protectedvirtual

This function is called by readStrip() to implement the actual class-specific work for decoding a strip of the scene.

Derived classes must implement this function.

This function should never be called directly.

Parameters
stripBufferthe buffer to read the pixels into
stripScenethe scene for this strip being decoded
Returns
status code indicating success or failure

Reimplemented from LTIImageFilter.

◆ getChildScene()

bool LTIMultiResFilter::getChildScene ( const LTIScene &  scene,
Mode &  mode,
double &  xScale,
double &  yScale,
LTIScene &  childScene 
) const
protected

◆ getDimsAtMag()

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

This function returns the width and height of the image, in pixels, relative to the given magnification.

Parameters
magmagnification to determine width at
widththe image width at the magnification
heightthe image height at the magnification
Returns
status code indicating success or failure

Reimplemented from LTIImageFilter.

◆ getEncodingCost()

lt_int64 LTIMultiResFilter::getEncodingCost ( const LTIScene &  scene) const
virtual

Returns the "cost" to encode this scene, for use by those image writers which have usage metering enabled. The typical cost is equal to the nominal image size (width * height * numBands * bytesPerSample), but this is overridden for special situations, e.g. the mosaic filter.

Parameters
scenethe scene to be charged for
Returns
the cost to encode the given scene

Reimplemented from LTIImageFilter.

◆ getModifications()

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

This function returns a bitfield describing what kinds of modifications have been made to the image during and since its initial encoding.

Parameters
scenethe area pertaining to this request
Returns
a bitfield itemizing the encoding modifications

Reimplemented from LTIImageFilter.

◆ getPipelineInfo()

bool LTIMultiResFilter::getPipelineInfo ( LTIPipelineInfo  info) const
virtual

Reimplemented from LTIImageFilter.

◆ getReaderScene()

bool LTIMultiResFilter::getReaderScene ( const LTIScene &  decodeScene,
LTIScene &  readerScene 
) const
virtual

Get the scene that will be sent to the underlying LTIImageReader. This is useful in some complex pipelines.

Parameters
decodeScenethe scene that would be given to read()
readerScenethe scene that is the actual scene passed the underlying image reader
Returns
true if readerScene is not empty

Reimplemented from LTIImageFilter.

◆ initialize() [1/3]

LT_STATUS LTIMultiResFilter::initialize ( LTIImageStage *  srcImage)

Creates an image stage which can be decoded at arbitrary magnifications.

Normally image stages will only support a limited set of magnification values for the LTIScene passed to LTIImageStage::read() – often, only 1.0. This class will perform any needed resampling on the fly so that arbitrary (power-of-two) magnifications are supported.

Parameters
srcImagethe base image

◆ initialize() [2/3]

LT_STATUS LTIMultiResFilter::initialize ( LTIImageStage *  srcImage,
double  deltaMag,
double  minMag,
double  maxMag 
)

◆ initialize() [3/3]

LT_STATUS LTIMultiResFilter::initialize ( LTIImageStage *  srcImage,
lt_int8  scaleFactor 
)

Magnifies the image by the scale factor given. The image width, height, geographic resolution, etc, are all updated accordingly.

A positive scale factor performs a "res-up" operation, while a negative scale factor will reduce the image. That is, a scale factor of 2 will double the image size, e.g. from a magnification of 1.0 to 2.0, while a scale factor of -2 will halve the image size, e.g. from a magnification of 1.0 to 0.5.

Parameters
srcImagethe base image
scaleFactorthe integer scale factor

◆ magForIcon() [1/2]

static double LTIMultiResFilter::magForIcon ( const LTIImage &  image,
lt_uint32  iconSize 
)
static

◆ magForIcon() [2/2]

static double LTIMultiResFilter::magForIcon ( lt_uint32  width,
lt_uint32  height,
lt_uint32  iconSize 
)
static

◆ push() [1/2]

static LT_STATUS LTIMultiResFilter::push ( LTIImageStage *&  pipeline,
const LTIScene &  dstScene,
LTIResampleMethod  method = LTI_RESAMPLE_NEAREST 
)
static

◆ push() [2/2]

static LT_STATUS LTIMultiResFilter::push ( LTIImageStage *&  pipeline,
double  mag,
LTIResampleMethod  method = LTI_RESAMPLE_NEAREST 
)
static

◆ setDeltaMagXY()

void LTIMultiResFilter::setDeltaMagXY ( double  deltaMagX,
double  deltaMagY 
)

◆ setMagSnapThreshold()

void LTIMultiResFilter::setMagSnapThreshold ( double  threshold)

◆ setResampleMethod()

LT_STATUS LTIMultiResFilter::setResampleMethod ( LTIResampleMethod  resampleMethod)
Parameters
resampleMethodresampling method See LTIResampleMethod

◆ setResamplePixelCenter()

LT_STATUS LTIMultiResFilter::setResamplePixelCenter ( bool  usePixelCenter)

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

Extensis