DiMono2Image Class Reference

Class for MONOCHROME2 images. More...

Inheritance diagram for DiMono2Image:


Public Member Functions
	DiMono2Image (const DiDocument *docu, const EI_Status status)
	constructor
	DiMono2Image (const DiDocument *docu, const EI_Status status, const double slope, const double intercept)
	constructor, modality (linear)
	DiMono2Image (const DiDocument docu, const EI_Status status, const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const DcmLongString explanation)
	constructor, modality (LUT)
	DiMono2Image (const DiColorImage *image, const double red, const double green, const double blue)
	constructor, convert color images to monochrome
	DiMono2Image (const DiMonoImage image, DiMonoOutputPixel pixel, const unsigned long frame, const int stored, const int alloc)
	constructor, createMonoOutput
virtual	~DiMono2Image ()
	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
	DiMono2Image (const DiDocument *docu, const EI_Status status, const char dummy)
	constructor
	DiMono2Image (const DiMonoImage *image, const unsigned long fstart, const unsigned long fcount)
	constructor, copy
	DiMono2Image (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
	DiMono2Image (const DiMonoImage *image, const int horz, const int vert)
	constructor, flip
	DiMono2Image (const DiMonoImage *image, const int degree)
	constructor, rotate

Detailed Description

Class for MONOCHROME2 images.

Definition at line 49 of file dimo2img.h.

Constructor & Destructor Documentation

DiMono2Image::DiMono2Image ( const DiDocument * docu,

const EI_Status status

)

constructor

Parameters:

docu pointer to dataset (encapsulated)

status current image status

DiMono2Image::DiMono2Image ( const DiDocument * docu,

const EI_Status status,

const double slope,

const double intercept

)

constructor, modality (linear)

Parameters:

docu pointer to dataset (encapsulated)

status current image status

slope rescale slope

intercept rescale intercept

DiMono2Image::DiMono2Image ( const DiDocument * docu,

const EI_Status status,

const DcmUnsignedShort & data,

const DcmUnsignedShort & descriptor,

const DcmLongString * explanation

)

constructor, modality (LUT)

Parameters:

docu pointer to dataset (encapsulated)

status current image status

data element containing the modality LUT data

descriptor element containing the modality LUT descriptor

explanation element containing the modality LUT explanation (optional)

DiMono2Image::DiMono2Image ( const DiColorImage * image,

const double red,

const double green,

const double blue

)

constructor, convert color images to monochrome

Parameters:

image pointer to reference image

red coefficient by which the red component is weighted

green coefficient by which the green component is weighted

blue coefficient by which the blue component is weighted

DiMono2Image::DiMono2Image ( const DiMonoImage * image,

DiMonoOutputPixel * pixel,

const unsigned long frame,

const int stored,

const int alloc

)

constructor, createMonoOutput

Parameters:

image pointer to reference image

pixel pointer to output pixel data used for the new image

frame number of frame stored in the new image object

stored number of bits stored

alloc number of bits allocated

DiMono2Image::DiMono2Image ( const DiDocument * docu,

const EI_Status status,

const char dummy

) [protected]

constructor

Parameters:

docu pointer to dataset (encapsulated)

status current image status

dummy (necessary to be different from another constructor)

DiMono2Image::DiMono2Image ( 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

DiMono2Image::DiMono2Image ( 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), 1 = pbmplus algorithm, 2 = c't algorithm

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)

DiMono2Image::DiMono2Image ( 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

DiMono2Image::DiMono2Image ( 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

DiImage* DiMono2Image::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* DiMono2Image::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* DiMono2Image::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.

DiImage* DiMono2Image::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* DiMono2Image::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), 1 = pbmplus algorithm, 2 = c't algorithm

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.

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

get color model of internal pixel representation.

Returns:
always returns EPI_Monochrome2

Implements DiImage.
Definition at line 122 of file dimo2img.h.

virtual int DiMono2Image::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.

virtual const void* DiMono2Image::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.

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

dcmimgle/include/dcmtk/dcmimgle/dimo2img.h

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DiMono2Image Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation