MrSID Decode SDK for Raster Reference Manual 9.5.4.4709

- Main Page
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LTICropFilter Class Reference

crops the image stage to a smaller width and height More...

`#include <lti_cropFilter.h>`

Inheritance diagram for LTICropFilter:
[legend]
Collaboration diagram for LTICropFilter:
[legend]

## Public Member Functions
LT_STATUS | initialize (LTIImageStage *srcImage, lt_int32 xOffset, lt_int32 yOffset, lt_int32 newWidth, lt_int32 newHeight)
| initializer More...
Public Member Functions inherited from LTIEmbeddedImage
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
| 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...
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
| get the modification bitfield for this image More...
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< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > > >
lt_uint32 | getWidth () const
| get image width More...
lt_uint32 | getHeight () const
| get image height More...
Public Member Functions inherited from LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > > >
const LTIPixel & | getPixelProps () const
| get the pixel properties of the image 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...
LT_STATUS | overridePixelBPS (lt_uint8 bps)
| override the bits-per-sample of the image's (sample's) datatype More...
LT_STATUS | overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
| override the dynamic range of the image More...
Public Member Functions inherited from LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIImageFilter > >
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...
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...
Public Member Functions inherited from LTIOverrideGeoCoord< LTIImageFilter >
const LTIGeoCoord & | getGeoCoord () const
| get the geographic coordinates of the image More...
bool | isGeoCoordImplicit () const
| is geo information "real" or not More...
LT_STATUS | overrideGeoCoord (const LTIGeoCoord &geoCoord)
| override the geographic coordinates of the image More...
Public Member Functions inherited from LTIImageFilter
LT_STATUS | getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
| get image width and height at given magnification More...
const LTIPixelLookupTable * | getPixelLookupTable () const
| get the color lookup table, if any 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...
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 | overridePixelLookupTable (const LTIPixelLookupTable *pixelLookupTable)
| override the CLUT of the image More...
LT_STATUS | overrideMetadata (const LTIMetadataDatabase &metadata)
| override the metadata of the image 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...

## Static Public Member Functions
static LTICropFilter * | create (void)
Static Public Member Functions inherited from LTIEmbeddedImage
static LTIEmbeddedImage * | create (void)
static LT_STATUS | push (LTIImageStage *&pipeline, LTIScene &scene, const LTIPixel *backgroundPixel=NULL)

## Protected Member Functions
| LTICropFilter (void)
virtual | ~LTICropFilter (void)
Protected Member Functions inherited from LTIEmbeddedImage
| LTIEmbeddedImage (void)
virtual | ~LTIEmbeddedImage (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...

## Additional Inherited Members
Public Types inherited from LTIEmbeddedImage
enum | AlphaMode { DoNothing, FromMerge, FromSourceRectangle }
Protected Attributes inherited from LTIOverrideGeoCoordData
LTIGeoCoord * | m_geoCoord
bool | m_geoCoordImplicit
Protected Attributes inherited from LTIOverrideBackgroundPixelData
LTIPixel * | m_backgroundPixel
LTIPixel * | m_nodataPixel
Protected Attributes inherited from LTIOverridePixelPropsData
LTIPixel * | m_pixelProps
LTIPixel * | m_drminPixel
LTIPixel * | m_drmaxPixel
Protected Attributes inherited from LTIOverrideDimensionsData
lt_uint32 | m_width
lt_uint32 | m_height

## Detailed Description

This class crops the image stage to a smaller width and height.

Examples:
  Pipeline.cpp.

Definition at line 27 of file lti_cropFilter.h.

## Constructor & Destructor Documentation

LTICropFilter::LTICropFilter | ( | void | ) |  |
| protected

virtual LTICropFilter::~LTICropFilter | ( | void | ) |  |
| protected virtual

## Member Function Documentation

static LTICropFilter* LTICropFilter::create | ( | void | ) |  |
| static

Examples:
  Pipeline.cpp.

LT_STATUS LTICropFilter::initialize | ( | LTIImageStage * | srcImage,
|  | lt_int32 | xOffset,
|  | lt_int32 | yOffset,
|  | lt_int32 | newWidth,
|  | lt_int32 | newHeight
| ) |  |

Creates an image stage which corresponds to a cropped subsection of the input image, according to the given offset, width, and height.

Parameters

  srcImage | the base image
  xOffset | x-position of the origin of the new image (specified relative to the input image)
  yOffset | y-position of the origin of the new image (specified relative to the input image)
  newWidth | width of the new image
  newHeight | height of the new image

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

- lti_cropFilter.h

LizardTech