DiMono1Image Class Reference

Class for MONOCHROME1 images. More...

Inheritance diagram for DiMono1Image:


Public Member Functions
	DiMono1Image (const DiDocument *docu, const EI_Status status)
	constructor
virtual	~DiMono1Image ()
	destructor
virtual EP_Interpretation	getInternalColorModel () const
	get color model of internal pixel representation.
virtual const void *	getOutputData (const unsigned long frame, const int bits, const int planar=0)
	get pixel data with specified format.
virtual int	getOutputData (void *buffer, const unsigned long size, const unsigned long frame, const int bits, const int planar=0)
	get pixel data with specified format.
DiImage *	createImage (const unsigned long fstart, const unsigned long fcount) const
	create copy of current image object
DiImage *	createScale (const signed long left_pos, const signed long top_pos, const unsigned long clip_width, const unsigned long clip_height, const unsigned long scale_width, const unsigned long scale_height, const int interpolate, const int aspect, const Uint16 pvalue) const
	create scaled copy of specified (clipping) area of the current image object.
DiImage *	createFlip (const int horz, const int vert) const
	create a flipped copy of the current image
DiImage *	createRotate (const int degree) const
	create a rotated copy of the current image.
DiImage *	createMono (const double dummy1, const double dummy2, const double dummy3) const
	create monochrome copy of the current image.
Protected Member Functions
	DiMono1Image (const DiMonoImage *image, const unsigned long fstart, const unsigned long fcount)
	constructor, copy
	DiMono1Image (const DiMonoImage *image, const signed long left_pos, const signed long top_pos, const Uint16 src_cols, const Uint16 src_rows, const Uint16 dest_cols, const Uint16 dest_rows, const int interpolate=0, const int aspect=0, const Uint16 pvalue=0)
	constructor, scale/clip
	DiMono1Image (const DiMonoImage *image, const int horz, const int vert)
	constructor, flip
	DiMono1Image (const DiMonoImage *image, const int degree)
	constructor, rotate

Detailed Description

Class for MONOCHROME1 images.

Definition at line 44 of file dimo1img.h.

Constructor & Destructor Documentation

DiMono1Image::DiMono1Image	(	const DiDocument *	docu,
		const EI_Status	status
	)

constructor

Parameters:

	docu	pointer to dataset (encapsulated)
	status	current image status

DiMono1Image::DiMono1Image	(	const DiMonoImage *	image,
		const unsigned long	fstart,
		const unsigned long	fcount
	)			`[protected]`

constructor, copy

Parameters:

	image	pointer to reference image
	fstart	first frame to be processed
	fcount	number of frames

DiMono1Image::DiMono1Image	(	const DiMonoImage *	image,
		const signed long	left_pos,
		const signed long	top_pos,
		const Uint16	src_cols,
		const Uint16	src_rows,
		const Uint16	dest_cols,
		const Uint16	dest_rows,
		const int	interpolate = `0`,
		const int	aspect = `0`,
		const Uint16	pvalue = `0`
	)			`[protected]`

constructor, scale/clip

Parameters:

	image	pointer to reference image
	left_pos	x coordinate of top left corner of area to be scaled (referring to image origin, negative values create a border around the image)
	top_pos	y coordinate of top left corner of area to be scaled
	src_cols	width of area to be scaled
	src_rows	height of area to be scaled
	dest_cols	width of scaled image (in pixels)
	dest_rows	height of scaled image (in pixels)
	interpolate	specifies whether scaling algorithm should use interpolation (if necessary). default: no interpolation (0), preferred interpolation algorithm (if applicable): 1 = pbmplus algorithm, 2 = c't algorithm, 3 = bilinear magnification, 4 = bicubic magnification
	aspect	specifies whether pixel aspect ratio should be taken into consideration (if true, width OR height should be 0, i.e. this component will be calculated automatically)
	pvalue	P-value used for the border outside the image (0..65535)

DiMono1Image::DiMono1Image	(	const DiMonoImage *	image,
		const int	horz,
		const int	vert
	)			`[protected]`

constructor, flip

Parameters:

	image	pointer to reference image
	horz	flip horizontally if true
	vert	flip vertically if true

DiMono1Image::DiMono1Image	(	const DiMonoImage *	image,
		const int	degree
	)			`[protected]`

constructor, rotate

Parameters:

	image	pointer to reference image
	degree	angle by which the image shall be rotated

Member Function Documentation

virtual EP_Interpretation DiMono1Image::getInternalColorModel ( ) const [inline, virtual]

get color model of internal pixel representation.

Returns:: always returns EPI_Monochrome1

Implements DiImage.

Definition at line 65 of file dimo1img.h.

virtual const void* DiMono1Image::getOutputData	(	const unsigned long	frame,
		const int	bits,
		const int	planar = `0`
	)			`[virtual]`

get pixel data with specified format.

(memory is handled internally)

Parameters:

	frame	number of frame to be rendered
	bits	number of bits for the output pixel data (depth)
	planar	flags, whether the output data (for multi-planar images) should be planar or not

Returns:: untyped pointer to the pixel data if successful, NULL otherwise

Implements DiMonoImage.

virtual int DiMono1Image::getOutputData	(	void *	buffer,
		const unsigned long	size,
		const unsigned long	frame,
		const int	bits,
		const int	planar = `0`
	)			`[virtual]`

get pixel data with specified format.

(memory is handled externally)

Parameters:

	buffer	untyped pointer to the externally allocated memory buffer
	size	size of the memory buffer in bytes (will be checked)
	frame	number of frame to be rendered
	bits	number of bits for the output pixel data (depth)
	planar	flags, whether the output data (for multi-planar images) should be planar or not

Returns:: status, true if successful, false otherwise

Implements DiMonoImage.

DiImage* DiMono1Image::createImage	(	const unsigned long	fstart,
		const unsigned long	fcount
	)			const `[virtual]`

create copy of current image object

Parameters:

	fstart	first frame to be processed
	fcount	number of frames

Returns:: pointer to new DicomImage object (NULL if an error occurred)

Implements DiImage.

DiImage* DiMono1Image::createScale	(	const signed long	left_pos,
		const signed long	top_pos,
		const unsigned long	clip_width,
		const unsigned long	clip_height,
		const unsigned long	scale_width,
		const unsigned long	scale_height,
		const int	interpolate,
		const int	aspect,
		const Uint16	pvalue
	)			const `[virtual]`

create scaled copy of specified (clipping) area of the current image object.

Parameters:

	left_pos	x coordinate of top left corner of area to be scaled (referring to image origin, negative values create a border around the image)
	top_pos	y coordinate of top left corner of area to be scaled
	clip_width	width of area to be scaled
	clip_height	height of area to be scaled
	scale_width	width of scaled image (in pixels)
	scale_height	height of scaled image (in pixels)
	interpolate	specifies whether scaling algorithm should use interpolation (if necessary). default: no interpolation (0), preferred interpolation algorithm (if applicable): 1 = pbmplus algorithm, 2 = c't algorithm, 3 = bilinear magnification, 4 = bicubic magnification
	aspect	specifies whether pixel aspect ratio should be taken into consideration (if true, width OR height should be 0, i.e. this component will be calculated automatically)
	pvalue	P-value used for the border outside the image (0..65535)

Returns:: pointer to new DiImage object (NULL if an error occurred)

Implements DiImage.

DiImage* DiMono1Image::createFlip	(	const int	horz,
		const int	vert
	)			const `[virtual]`

create a flipped copy of the current image

Parameters:

	horz	flip horizontally if true
	vert	flip vertically if true

Returns:: pointer to new DiImage object (NULL if an error occurred)

Implements DiImage.

DiImage* DiMono1Image::createRotate ( const int degree ) const [virtual]

create a rotated copy of the current image.

Parameters:

degree

angle by which the image shall be rotated

Returns:: pointer to new DiImage object (NULL if an error occurred)

Implements DiImage.

DiImage* DiMono1Image::createMono	(	const double	dummy1,
		const double	dummy2,
		const double	dummy3
	)			const `[virtual]`

create monochrome copy of the current image.

Since the image is already monochrome the effect is the same as with createImage().

Parameters:

	dummy1	not used
	dummy2	not used
	dummy3	not used

Returns:: pointer to new DiImage object (NULL if an error occurred)

Implements DiImage.

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

dcmimgle/include/dcmtk/dcmimgle/dimo1img.h

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1

DiMono1Image Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation