MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIImageFilter Class Reference

abstract class for implementing an image transform More...

#include <lti_imageFilter.h>

Inheritance diagram for LTIImageFilter:
LTIImageStage LTIImage LTIReferenceCountedObject LTIOverrideGeoCoord< LTIImageFilter > LTIOverridePixelProps< LTIImageFilter > J2KImageReader LTIViewerImageFilter LTIWatermarkFilter MrSIDImageReader LTITranslationFilter LTIOverrideMetadata< LTIOverridePixelProps< LTIImageFilter > > LTIDynamicRangeFilter LTIColorTransformer

Public Member Functions

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
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...
 
lt_uint32 getNumStrips () const
 get number of strips in scene More...
 
LTIScene getStripScene (lt_uint32 stripNumber) const
 get a strip for current scene More...
 
- Public Member Functions inherited from LTIImage
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...
 
bool isNaturalDynamicRange () const
 check if the range is "complete" or not More...
 
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...
 

Protected Member Functions

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

Detailed Description

The LTIImageFilter abstract class extends the LTIImageStage so that it can be used as an intermediate stage in an image pipeline. This is the base class for such classes as the colorspace transformer, image cropper, etc.

Definition at line 24 of file lti_imageFilter.h.

Constructor & Destructor Documentation

◆ LTIImageFilter()

LTIImageFilter::LTIImageFilter ( void  )
protected

◆ ~ LTIImageFilter()

virtual LTIImageFilter::~ LTIImageFilter ( void  )
protectedvirtual

Member Function Documentation

◆ changePreviousStage()

void LTIImageFilter::changePreviousStage ( LTIImageStage *  newPref)
protected

◆ decodeBegin()

LT_STATUS LTIImageFilter::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

Implements LTIImageStage.

Reimplemented in LTIWatermarkFilter.

◆ decodeEnd()

LT_STATUS LTIImageFilter::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

Implements LTIImageStage.

Reimplemented in LTIWatermarkFilter.

◆ decodeStrip()

LT_STATUS LTIImageFilter::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

Implements LTIImageStage.

Reimplemented in LTIWatermarkFilter.

◆ getBackgroundPixel()

const LTIPixel* LTIImageFilter::getBackgroundPixel ( ) const
virtual

This function returns a pointer to an object containing the values of the background pixel of the image. If the pointer is nullptr, no background color has been set for the image.

Returns
pointer to the background pixel

Implements LTIImage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

◆ getDimsAtMag()

LT_STATUS LTIImageFilter::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

Implements LTIImage.

Examples
DecodeJP2ToBBB.cpp, DecodeJP2ToJPG.cpp, DecodeMrSIDToRaw.cpp, and DecodeMrSIDToTIFF.cpp.

◆ getEncodingCost()

lt_int64 LTIImageFilter::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

Implements LTIImageStage.

Reimplemented in MrSIDImageReader.

◆ getGeoCoord()

const LTIGeoCoord& LTIImageFilter::getGeoCoord ( ) const
virtual

This function returns the geographic coordinates of the image.

Note that if the image has no explicit geographic coordinate information, e.g. stored within the metadata of a file, the geographic coordinates are implicitly set (upperleft is (0,-height), resolution is (1,-1))

Returns
a pointer to an object containing the geographic coordinates

Implements LTIImage.

Reimplemented in LTIOverrideGeoCoord< LTIImageFilter >.

Examples
GeoScene.cpp, and ImageInfo.cpp.

◆ getHeight()

lt_uint32 LTIImageFilter::getHeight ( ) const
virtual

This function returns the height of the image, in pixels.

Returns
the image height

Implements LTIImage.

Examples
GeoScene.cpp, and ImageInfo.cpp.

◆ getInterruptDelegate()

LTIInterruptDelegate* LTIImageFilter::getInterruptDelegate ( ) const
virtual

This function returns the object's interrupt delegate.

The function will return nullptr if no delegate has been set.

Derived classes should call this method from within their read() methods so that they can determine if the user has requested that the read operation should be aborted.

Returns
a pointer to the delegate object (or nullptr if no delegate has been set)

Implements LTIImageStage.

◆ getMask()

LTIMaskSource* LTIImageFilter::getMask ( ) const
virtual

Implements LTIImageStage.

◆ getMaxDynamicRange()

const LTIPixel& LTIImageFilter::getMaxDynamicRange ( ) const
virtual

This function returns the pixels of maximum value of the dynamic range of the image.

Returns
pixel object with the maximum dynamic range values

Implements LTIImage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

◆ getMaxMagnification()

double LTIImageFilter::getMaxMagnification ( ) const
virtual

This function returns the maximum magnification of the image. Images that do not support "zooming in" will return 1.0; images that support "res-up", e.g. MrSID, will return a value less than 1.0.

Returns
the maximum magnification

Implements LTIImage.

Examples
ImageInfo.cpp.

◆ getMetadata()

const LTIMetadataDatabase& LTIImageFilter::getMetadata ( ) const
virtual

This function returns a reference to the object containing the metadata associated with the image.

Returns
a reference to the metadata database

Implements LTIImage.

Reimplemented in LTIOverrideMetadata< LTIOverridePixelProps< LTIImageFilter > >.

Examples
MetadataDump.cpp.

◆ getMetadataBlob()

LT_STATUS LTIImageFilter::getMetadataBlob ( const char *  type,
LTIOStreamInf *&  stream 
) const
virtual

This function returns XMP or EXIF metadata as a blob.

Parameters
typetype of metadata to extract (xmp|exif)
streamoutput stream containing the asked for metadata.
The caller must delete the returned stream.
Returns
status code indicating success or failure

Reimplemented from LTIImage.

◆ getMinDynamicRange()

const LTIPixel& LTIImageFilter::getMinDynamicRange ( ) const
virtual

This function returns the pixels of minimum value of the dynamic range of the image.

Returns
pixel object with the minimum dynamic range values

Implements LTIImage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

◆ getMinMagnification()

double LTIImageFilter::getMinMagnification ( ) const
virtual

This function returns the minimum magnification of the image. Images that do not support "zooming out" will return 1.0; images that contain "overviews", e.g. MrSID, will return a value greater than 1.0.

Returns
the minimum magnification

Implements LTIImage.

Examples
ImageInfo.cpp.

◆ getModifications()

lt_uint32 LTIImageFilter::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

Implements LTIImage.

Reimplemented in MrSIDImageReader, LTIWatermarkFilter, LTIViewerImageFilter, and LTITranslationFilter.

◆ getNoDataPixel()

const LTIPixel* LTIImageFilter::getNoDataPixel ( ) const
virtual

This function returns a pointer to an object containing the values of the no data pixel of the image. If the pointer is nullptr, no transparency color has been set for the image.

Returns
pointer to the no data pixel

Implements LTIImage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

Examples
ImageInfo.cpp.

◆ getPipelineInfo()

bool LTIImageFilter::getPipelineInfo ( LTIPipelineInfo  info) const
virtual

Implements LTIImageStage.

◆ getPixelLookupTable()

const LTIPixelLookupTable* LTIImageFilter::getPixelLookupTable ( ) const
virtual

This function returns a pointer the color lookup table, used for indexed or palletized images. Will return nullptr if no table is used.

Returns
pointer to the pixel lookup table

Implements LTIImage.

◆ getPixelProps()

const LTIPixel& LTIImageFilter::getPixelProps ( ) const
virtual

This function returns an object which describes the basic properties of a pixel in the image.

Returns
the pixel properties of the image

Implements LTIImage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

Examples
DecodeJP2ToMemory.cpp, DecodeMrSIDBandSelection.cpp, DecodeMrSIDToMemory.cpp, InterruptDelegate.cpp, ProgressDelegate.cpp, and SceneBuffer.cpp.

◆ getPreviousStage()

LTIImageStage* LTIImageFilter::getPreviousStage ( void  ) const
virtual

Implements LTIImageStage.

◆ getProgressDelegate()

LTIProgressDelegate* LTIImageFilter::getProgressDelegate ( ) const
virtual

This function returns the object's progress delegate.

The function will return nullptr if no delegate has been set.

Derived classes should call this method from within their read() methods so that they can inform the user of the progress of the read operation.

Returns
a pointer to the delegate object (or nullptr if no delegate has been set)

Implements LTIImageStage.

◆ getReaderScene()

bool LTIImageFilter::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

Implements LTIImageStage.

◆ getStripHeight()

lt_uint32 LTIImageFilter::getStripHeight ( ) const
virtual

Returns the strip height used in read() calls.

Reader classes should set this. Filter classes should inherit the stripheight of their pipeline predecessor. A writer class will force the stripheight of the pipeline to match its stripheight.

Returns
the strip height

Implements LTIImageStage.

◆ getWidth()

lt_uint32 LTIImageFilter::getWidth ( ) const
virtual

This function returns the width of the image, in pixels.

Returns
the image width

Implements LTIImage.

Examples
GeoScene.cpp, and ImageInfo.cpp.

◆ hasMetadataBlob()

bool LTIImageFilter::hasMetadataBlob ( const char *  type) const
virtual

Reimplemented from LTIImage.

◆ init()

LT_STATUS LTIImageFilter::init ( LTIImageStage *  previousStage)
protected

◆ isGeoCoordImplicit()

bool LTIImageFilter::isGeoCoordImplicit ( ) const
virtual

This function returns true if the geo information is implicit, i.e. the source image did not have native geo coord info.

Returns
true if and only if the geo information is not "real"

Implements LTIImage.

Reimplemented in LTIOverrideGeoCoord< LTIImageFilter >.

◆ isSelective()

bool LTIImageFilter::isSelective ( ) const
virtual

Some formats, notably JPEG, do not support "selective" decoding. That is, they require that scenes being decoding must march in order down the scanlines of the image. Formats like TIFF and MrSID, however, are "selective": any scene can be requested at any time.

Returns
true if and only if the image supports arbitrary scene requests

Implements LTIImage.

◆ overrideBackgroundPixel()

LT_STATUS LTIImageFilter::overrideBackgroundPixel ( const LTIPixel *  backgroundPixel)
virtual

This function is used to set the background color of the image.

Parameters
backgroundPixelthe data for the background color
Returns
status code indicating success or failure

Implements LTIImageStage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

◆ overrideColorSpace()

LT_STATUS LTIImageFilter::overrideColorSpace ( LTIColorSpace  colorspace)
virtual

◆ overrideDynamicRange()

LT_STATUS LTIImageFilter::overrideDynamicRange ( const LTIPixel &  drmin,
const LTIPixel &  drmax 
)
virtual

◆ overrideGeoCoord()

LT_STATUS LTIImageFilter::overrideGeoCoord ( const LTIGeoCoord &  geoCoord)
virtual

This function is used to set the geographic coordinates of the image.

Parameters
geoCoordthe geographic coordinate information
Returns
status code indicating success or failure

Implements LTIImageStage.

Reimplemented in LTIOverrideGeoCoord< LTIImageFilter >.

◆ overrideMetadata()

LT_STATUS LTIImageFilter::overrideMetadata ( const LTIMetadataDatabase &  metadata)
virtual

◆ overrideNoDataPixel()

LT_STATUS LTIImageFilter::overrideNoDataPixel ( const LTIPixel *  nodataPixel)
virtual

This function is used to set the "no data" or transparency color of the image.

Parameters
nodataPixelthe data for the transparency color
Returns
status code indicating success or failure

Implements LTIImageStage.

Reimplemented in LTIOverridePixelProps< LTIImageFilter >.

◆ overridePixelBPS()

LT_STATUS LTIImageFilter::overridePixelBPS ( lt_uint8  )
virtual

◆ overridePixelLookupTable()

LT_STATUS LTIImageFilter::overridePixelLookupTable ( const LTIPixelLookupTable *  pixelLookupTable)
virtual

Implements LTIImageStage.

◆ releasePreviousStageNow()

void LTIImageFilter::releasePreviousStageNow ( void  )
protected

◆ setInterruptDelegate()

void LTIImageFilter::setInterruptDelegate ( LTIInterruptDelegate *  delegate)
virtual

This function sets the interrupt delegate, which is used in a callback-like fashion by the calling application to asynchronously indicate that a read() operation should be halted without completing.

Passing nullptr to this function should remove the LTIImageStage's current delegate, if any.

Note this function does not take ownership of the delegate object.

Parameters
delegatea pointer to the delegate object to be used by the image reader

Implements LTIImageStage.

Examples
InterruptDelegate.cpp.

◆ setProgressDelegate()

void LTIImageFilter::setProgressDelegate ( LTIProgressDelegate *  delegate)
virtual

This function sets the progress delegate, which is used in a callback-like fashion to report percent-complete of a read() operation back to the calling application.

Passing nullptr to this function should remove the LTIImageStage's current delegate, if any.

Note this function does not take ownership of the delegate object.

Parameters
delegatea pointer to the delegate object to be used by the image reader

Implements LTIImageStage.

Examples
ProgressDelegate.cpp.

◆ setStripHeight()

LT_STATUS LTIImageFilter::setStripHeight ( lt_uint32  stripHeight)
virtual

Sets the strip height to be used in decoding. This is the number of rows to be decoded in each strip of the read() sequence.

Reader classes should implement this directly. (LTIImageFilter implements this as a call to setStripHeight() on the previous stage.)

Parameters
stripHeightthe number of rows to decode at one time
Returns
status code indicating success or failure

Implements LTIImageStage.


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

Extensis