version 3.3

VRS::ImageModulate Class Reference

Multiplies the pixels of two images. More...

#include <vrs/image/imagemodulate.h>

Inheritance diagram for VRS::ImageModulate:

VRS::ImageManipulator VRS::SharedObj VRS::Visitable

List of all members.

Public Member Functions

 ImageModulate (Image *referenceImage)
void setReferenceImage (Image *image)
ImagegetReferenceImage () const
 Set/get the reference image.
virtual Imagemanipulate (Image *source, Image *target)
virtual bool operatesInPlace () const
 VRS_TYPEINFO (ImageModulate, ImageManipulator)


Detailed Description

Multiplies the pixels of two images.

Constructor & Destructor Documentation

VRS::ImageModulate::ImageModulate ( Image referenceImage  ) 

For each pixel component, the modulated value is computed as this_pixel_component * reference_pixel_component. Both images must have the same extension and the the same number of image layers.


Member Function Documentation

void VRS::ImageModulate::setReferenceImage ( Image image  ) 

Image* VRS::ImageModulate::getReferenceImage (  )  const

Set/get the reference image.

virtual Image* VRS::ImageModulate::manipulate ( Image srcImage,
Image dstImage 
) [virtual]

The image operation is apply to the source image and the the resulting image is stored in the target image. The handle of the target image is returned.

Implements VRS::ImageManipulator.

virtual bool VRS::ImageModulate::operatesInPlace (  )  const [virtual]

See `ImageManipulator'. Blends the source image and the reference image, and stores the result in the target image. This manipulator operates in place.

Reimplemented from VRS::ImageManipulator.

VRS::ImageModulate::VRS_TYPEINFO ( ImageModulate  ,
ImageManipulator   
)


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

Generated on Mon May 21 06:00:18 2012 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact