MrSID Decode SDK for Raster Reference Manual  9.0.0.3864
LTIWatermarkFilter Class Reference

insert a watermark image onto an image More...

#include <lti_watermarkFilter.h>

Inheritance diagram for LTIWatermarkFilter:
LTIImageFilter LTIImageStage LTIImage LTIReferenceCountedObject

List of all members.

Public Member Functions

LT_STATUS initialize (LTIImageStage *srcImage, LTIImageStage *watermarkImage, LTIPosition position, lt_uint32 edgePadding)
 initializer
virtual lt_uint32 getModifications (const LTIScene &scene) const
 get the modification bitfield for this image

Static Public Member Functions

static LTIWatermarkFiltercreate (void)

Protected Member Functions

 LTIWatermarkFilter (void)
virtual ~LTIWatermarkFilter (void)
LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 start strip-based read
LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 read a strip from the image
LT_STATUS decodeEnd (void)
 finish strip-based read

Detailed Description

Inserts a watermark image onto the current image stage.

Definition at line 29 of file lti_watermarkFilter.h.


Constructor & Destructor Documentation

virtual LTIWatermarkFilter::~LTIWatermarkFilter ( void  ) [protected, virtual]

Member Function Documentation

static LTIWatermarkFilter* LTIWatermarkFilter::create ( void  ) [static]
LT_STATUS LTIWatermarkFilter::decodeBegin ( const LTIPixel pixelProps,
const LTIScene fullScene 
) [protected, virtual]

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.

LT_STATUS LTIWatermarkFilter::decodeEnd ( void  ) [protected, virtual]

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.

LT_STATUS LTIWatermarkFilter::decodeStrip ( LTISceneBuffer stripBuffer,
const LTIScene stripScene 
) [protected, virtual]

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.

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.

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: