VRS::SubImage Class Reference

2D Subimage. More...

#include <vrs/image/subimage.h>

Inheritance diagram for VRS::SubImage:

List of all members.

Public Member Functions
	SubImage (Image *master, bool useMasterROI=true)
	SubImage (Image *master, const Area &region)
	A subimage uses a specified region of its master image.
virtual Image *	master () const
	Returns the master image.
const Area &	subRegion () const
virtual int	width () const
virtual int	height () const
	See Image.
virtual void *	lineComponents (int y) const
virtual void *	pixelComponents (int x, int y, int component=0) const
	See Image.
virtual SO< Image >	uncompressed (bool storeReference=false) const
	If the image is an CompressedImage the decompressed image is returned here.
	VRS_TYPEINFO (SubImage, DecoratedImage)
	VRS_SERIALIZABLE (SubImage)
Protected Member Functions
	SubImage ()

---

Detailed Description

2D Subimage.

---

Constructor & Destructor Documentation

VRS::SubImage::SubImage	(	Image *	master,
		bool	useMasterROI = true
	)

VRS::SubImage::SubImage	(	Image *	master,
		const Area &	region
	)

A subimage uses a specified region of its master image.

VRS::SubImage::SubImage

(

)

[protected]

---

Member Function Documentation

virtual Image* VRS::SubImage::master

(

)

const [virtual]

Returns the master image.

Implements VRS::DecoratedImage.

const Area& VRS::SubImage::subRegion

(

)

const

virtual int VRS::SubImage::width

(

)

const [virtual]

Implements VRS::Image.

virtual int VRS::SubImage::height

(

)

const [virtual]

See Image.

Implements VRS::Image.

virtual void* VRS::SubImage::lineComponents

(

int

y

)

const [virtual]

Reimplemented from VRS::Image.

virtual void* VRS::SubImage::pixelComponents	(	int	x,
		int	y,
		int	component = 0
	)			const [virtual]

See Image.

Implements VRS::Image.

virtual SO<Image> VRS::SubImage::uncompressed

(

bool

storeReference = false

)

const [virtual]

If the image is an CompressedImage the decompressed image is returned here.

If the image is not compressed, it will be directly returned.

Reimplemented from VRS::Image.

VRS::SubImage::VRS_TYPEINFO	(	SubImage	,
		DecoratedImage
	)

VRS::SubImage::VRS_SERIALIZABLE

(

SubImage

)

---

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

• subimage.h