IMG_Plane Class Reference

Describes the format and layout of a single plane in an image The plane specifies the format and name of a single image plane in a deep raster image. IMG_Stat contains a list of planes found in the image. Non-deep raster formats only contain one plane. More...

#include <IMG_Plane.h>

List of all members.

Public Member Functions
int	getPixelSize () const
int	getPlaneIndex () const
	IMG_Plane ()
	IMG_Plane (const IMG_Plane &p)
	IMG_Plane (const char *name, IMG_DataType dt, IMG_ColorModel cm, int index)
void	setName (const char *name)
const char *	getName () const
void	setDataType (IMG_DataType dt)
IMG_DataType	getDataType () const
void	setColorModel (IMG_ColorModel cm)
IMG_ColorModel	getColorModel () const
void	setComponentNames (const char *c1, const char *c2=0, const char *c3=0, const char *c4=0, bool only_if_not_set=false)
void	setComponentName (int comp, const char *name)
const char *	getComponentName (int comp) const
	Returns the name of the individual component of a pixel (r,g,b,a, x,y,z).
void	setBlackWhitePoints (int64 b, int64 w)
bool	hasBlackWhitePoints () const
void	getBlackWhitePoints (int64 &b, int64 &w) const
Friends
class	IMG_Stat

---

Detailed Description

Describes the format and layout of a single plane in an image The plane specifies the format and name of a single image plane in a deep raster image. IMG_Stat contains a list of planes found in the image. Non-deep raster formats only contain one plane.

Examples:

IMG/IMG_Raw.C.

Definition at line 37 of file IMG_Plane.h.

---

Constructor & Destructor Documentation

IMG_Plane::IMG_Plane

(

)

Planes are generally not created by the user, but by IMG_State::addPlane()

IMG_Plane::IMG_Plane

(

const IMG_Plane &

p

)

Planes are generally not created by the user, but by IMG_State::addPlane()

IMG_Plane::IMG_Plane	(	const char *	name,
		IMG_DataType	dt,
		IMG_ColorModel	cm,
		int	index
	)

Planes are generally not created by the user, but by IMG_State::addPlane()

---

Member Function Documentation

void IMG_Plane::getBlackWhitePoints	(	int64 &	b,
		int64 &	w
	)			const

Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).

IMG_ColorModel IMG_Plane::getColorModel

(

)

const

color model of the pixel, which specifies the components per pixel. (SINGLE_CHAN, RGB, RGBA)

Examples:

IMG/IMG_Raw.C.

const char* IMG_Plane::getComponentName

(

int

comp

)

const

Returns the name of the individual component of a pixel (r,g,b,a, x,y,z).

IMG_DataType IMG_Plane::getDataType

(

)

const

data format of the individual pixel components (8bit - FP)

Examples:

IMG/IMG_Raw.C.

const char* IMG_Plane::getName

(

)

const

plane name - must be unique in the list of planes found in IMG_Stat

int IMG_Plane::getPixelSize

(

)

const

the size of a single pixel, in bytes, including the data format and the color model.

int IMG_Plane::getPlaneIndex

(

)

const [inline]

This is the index of this plane, in the list of planes found in IMG_Stat (0 to getNumPlanes()-1).

Definition at line 100 of file IMG_Plane.h.

bool IMG_Plane::hasBlackWhitePoints

(

)

const

Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).

void IMG_Plane::setBlackWhitePoints	(	int64	b,
		int64	w
	)

Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).

void IMG_Plane::setColorModel

(

IMG_ColorModel

cm

)

color model of the pixel, which specifies the components per pixel. (SINGLE_CHAN, RGB, RGBA)

Examples:

IMG/IMG_Raw.C.

void IMG_Plane::setComponentName	(	int	comp,
		const char *	name
	)

Sets the individual component name(s) (default: r,g,b,a). Always call after setColorModel().

void IMG_Plane::setComponentNames	(	const char *	c1,
		const char *	c2 = 0,
		const char *	c3 = 0,
		const char *	c4 = 0,
		bool	only_if_not_set = false
	)

Sets the individual component name(s) (default: r,g,b,a). Always call after setColorModel().

void IMG_Plane::setDataType

(

IMG_DataType

dt

)

data format of the individual pixel components (8bit - FP)

Examples:

IMG/IMG_Raw.C.

void IMG_Plane::setName

(

const char *

name

)

plane name - must be unique in the list of planes found in IMG_Stat

---

Friends And Related Function Documentation

friend class IMG_Stat [friend]

Definition at line 118 of file IMG_Plane.h.

---

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

• IMG/IMG_Plane.h