MrSID Decode SDK for Raster Reference Manual 9.5.5.5244
LTIWatermarkFilter Class Reference

insert a watermark image onto an image More...

#include <lti_watermarkFilter.h>

Inheritance diagram for LTIWatermarkFilter:
Collaboration diagram for LTIWatermarkFilter:

Public Member Functions

LT_STATUS initialize (LTIImageStage *srcImage, LTIImageStage *watermarkImage, LTIPosition position, lt_uint32 edgePadding)
 initializer More...
 
LT_STATUS initialize (LTIImageStage *srcImage, LTIImageStage *watermarkImage, float transparency, LTIPosition position, lt_uint32 edgePadding)
 
virtual lt_uint32 getModifications (const LTIScene &scene) const
 get the modification bitfield for this image More...
 
- 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 LTIWatermarkFilter * create (void)
 

Protected Member Functions

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

Detailed Description

Inserts a watermark image onto the current image stage.

Definition at line 24 of file lti_watermarkFilter.h.

Constructor & Destructor Documentation

◆ LTIWatermarkFilter()

LTIWatermarkFilter::LTIWatermarkFilter ( void  )
protected

◆ ~LTIWatermarkFilter()

virtual LTIWatermarkFilter::~LTIWatermarkFilter ( void  )
protectedvirtual

Member Function Documentation

◆ create()

static LTIWatermarkFilter * LTIWatermarkFilter::create ( void  )
static

◆ decodeBegin()

LT_STATUS LTIWatermarkFilter::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 LTIWatermarkFilter::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 LTIWatermarkFilter::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.

◆ getModifications()

virtual lt_uint32 LTIWatermarkFilter::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.

◆ initialize() [1/2]

LT_STATUS LTIWatermarkFilter::initialize ( LTIImageStage *  srcImage,
LTIImageStage *  watermarkImage,
float  transparency,
LTIPosition  position,
lt_uint32  edgePadding 
)

◆ initialize() [2/2]

LT_STATUS LTIWatermarkFilter::initialize ( LTIImageStage *  srcImage,
LTIImageStage *  watermarkImage,
LTIPosition  position,
lt_uint32  edgePadding 
)

Creates an image stage with the watermarkImage overlaid over the srcImage at the position specified.

The edgePadding argument is used to specify the distance (in pixels) between the watermark and the edge of the base image specified by the position argument. (This argument is ignored if LTI_POSITION_CENTER is used.)

Parameters
srcImagethe base image
watermarkImagethe watermark to be overlaid
positionwhere to insert the watermark
edgePaddingdistance (in pixels) between the watermark and the base image

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

Extensis