DCMTK  Version 3.6.5
OFFIS DICOM Toolkit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
DiMonoImage Class Referenceabstract

Base class for monochrome images. More...

+ Inheritance diagram for DiMonoImage:

Public Member Functions

 DiMonoImage (const DiDocument *docu, const EI_Status status)
 constructor More...
 
 DiMonoImage (const DiDocument *docu, const EI_Status status, const double slope, const double intercept)
 constructor, rescale More...
 
 DiMonoImage (const DiDocument *docu, const EI_Status status, const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const DcmLongString *explanation)
 constructor, modality LUT More...
 
virtual ~DiMonoImage ()
 destructor
 
virtual int processNextFrames (const unsigned long fcount)
 process next couple of frames More...
 
int getMinMaxValues (double &min, double &max, const int mode) const
 get minimum and maximum pixel values. More...
 
DiDisplayFunctiongetDisplayFunction () const
 get display function More...
 
int setDisplayFunction (DiDisplayFunction *display)
 set display function More...
 
int setNoDisplayFunction ()
 set no display function. More...
 
int setNoVoiTransformation ()
 unset all VOI transformations (windows and LUTs). More...
 
int deleteDisplayLUT (const int bits)
 delete specified display LUT(s) More...
 
int isValueUnused (const unsigned long value)
 check whether given output value is unused More...
 
int convertPValueToDDL (const Uint16 pvalue, Uint16 &ddl, const int bits)
 convert P-value to DDL. More...
 
int setMinMaxWindow (const int idx=1)
 set automatically calculated minimum/maximum window. More...
 
int setRoiWindow (const unsigned long left_pos, const unsigned long top_pos, const unsigned long width, const unsigned long height, const unsigned long frame)
 set automatically calculated VOI window for the specified Region of Interest (ROI). More...
 
int setHistogramWindow (const double thresh)
 set automatically calculated histogram window. More...
 
int setWindow (const unsigned long pos=0)
 set specified window (given by index to window width/center sequence stored in image file). More...
 
int setWindow (const double center, const double width, const char *explanation=NULL)
 set specified window (given by window width and center). More...
 
int getWindow (double &center, double &width)
 get current window center and width values More...
 
unsigned long getWindowCount () const
 get number of VOI windows (stored in image file) More...
 
EF_VoiLutFunction getVoiLutFunction () const
 get VOI LUT function. More...
 
int setVoiLutFunction (const EF_VoiLutFunction function)
 set VOI LUT function More...
 
int setVoiLut (const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const DcmLongString *explanation, const EL_BitsPerTableEntry descripMode=ELM_UseValue)
 set VOI LUT (given by dcmdata elements). More...
 
int setVoiLut (const unsigned long pos, const EL_BitsPerTableEntry descripMode=ELM_UseValue)
 set VOI LUT (given by index to VOI LUT sequence stored in image file). More...
 
unsigned long getVoiLutCount () const
 get number of VOI LUTs (stored in image file) More...
 
const char * getVoiTransformationExplanation () const
 get description of active VOI transformation More...
 
const char * getVoiWindowExplanation (const unsigned long pos, OFString &explanation) const
 get description of specified VOI window (stored in the image file) More...
 
const char * getVoiLutExplanation (const unsigned long pos, OFString &explanation) const
 get description of specified VOI LUT (stored in the image file) More...
 
const char * getModalityLutExplanation () const
 get description of performed modality LUT transformation More...
 
int setHardcopyParameters (const unsigned int min, const unsigned int max, const unsigned int reflect, const unsigned int illumin)
 set hardcopy parameters. More...
 
ES_PresentationLut getPresentationLutShape () const
 get shape for presentation transformation. More...
 
int setPresentationLutShape (const ES_PresentationLut shape)
 set shape for presentation transformation. More...
 
int setPresentationLut (const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const DcmLongString *explanation=NULL, const EL_BitsPerTableEntry descripMode=ELM_UseValue)
 set LUT for presentation transformation. More...
 
int setInversePresentationLut (const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const EL_BitsPerTableEntry descripMode=ELM_UseValue)
 set inverse LUT for presentation transformation. More...
 
const char * getPresentationLutExplanation () const
 get description of active presentation LUT More...
 
int addOverlay (const unsigned int group, const signed int left_pos, const signed int top_pos, const unsigned int columns, const unsigned int rows, const DcmOverlayData &data, const DcmLongString &label, const DcmLongString &description, const EM_Overlay mode)
 add specified plane to group of additional overlay planes. More...
 
int removeAllOverlays ()
 remove all additional overlay planes More...
 
DiOverlaygetOverlayPtr (const unsigned int idx)
 get pointer to specified overlay managing object More...
 
DiMonoImagegetMonoImagePtr ()
 get pointer to current monochrome image (this) More...
 
int flip (const int horz, const int vert)
 flip current image (horizontally and/or vertically) More...
 
int rotate (const int degree)
 rotate current image (by steps of 90 degrees) More...
 
virtual int getBits (const int bits=0) const
 get number of bits per sample. More...
 
virtual unsigned long getOutputDataSize (const int bits=0) const
 get number of bytes required for the rendered output of a single frame More...
 
virtual const void * getOutputData (const unsigned long frame, const int bits, const int planar=0)=0
 get pixel data with specified format. More...
 
virtual int getOutputData (void *buffer, const unsigned long size, const unsigned long frame, const int bits, const int planar=0)=0
 get pixel data with specified format. More...
 
const void * getOutputPlane (const int dummy) const
 get pixel data of specified plane. More...
 
void deleteOutputData ()
 delete internally handled output memory buffer Save memory if data is no longer needed.
 
const void * getOverlayData (const unsigned long frame, const unsigned int plane, unsigned int &left_pos, unsigned int &top_pos, unsigned int &width, unsigned int &height, EM_Overlay &mode, const unsigned int idx, const int bits=8, const Uint16 fore=0xff, const Uint16 back=0x0)
 create bitmap for specified overlay plane. More...
 
const void * getFullOverlayData (const unsigned long frame, const unsigned int plane, unsigned int &width, unsigned int &height, const unsigned int idx, const int bits=8, const Uint16 fore=0xff, const Uint16 back=0x0)
 create bitmap for specified overlay plane. More...
 
void deleteOverlayData ()
 delete buffer for overlay plane data. More...
 
unsigned long create6xxx3000OverlayData (Uint8 *&buffer, const unsigned int plane, unsigned int &width, unsigned int &height, unsigned long &frames, const unsigned int idx=0)
 create bitmap for specified overlay plane and store it in (6xxx,3000) format. More...
 
const DiPixelgetInterData () const
 get pointer to intermediate pixel data representation More...
 
const DiMonoPixelgetMonoInterData () const
 get pointer to intermediate pixel data representation More...
 
unsigned long createDIB (void *&data, const unsigned long size, const unsigned long frame, const int bits, const int upsideDown, const int padding=1)
 create true color (24/32 bit) or palette (8 bit) bitmap for MS Windows. More...
 
unsigned long createAWTBitmap (void *&data, const unsigned long frame, const int bits)
 create true color (32 bit) or palette (8 bit) bitmap for Java (AWT default format). More...
 
DiImagecreateOutputImage (const unsigned long frame, const int bits)
 create new single frame DiImage with applied grayscale transformations. More...
 
int writeImageToDataset (DcmItem &dataset, const int mode, const int planar)
 write current image and related attributes to DICOM dataset. More...
 
int writePPM (STD_NAMESPACE ostream &stream, const unsigned long frame, const int bits)
 write pixel data to PPM file. More...
 
int writePPM (FILE *stream, const unsigned long frame, const int bits)
 write pixel data to PPM file. More...
 
int writeRawPPM (FILE *stream, const unsigned long frame, const int bits)
 write pixel data to raw PPM file More...
 
int writeBMP (FILE *stream, const unsigned long frame, const int bits)
 write pixel data to BMP file More...
 
- Public Member Functions inherited from DiImage
 DiImage (const DiDocument *docu, const EI_Status status, const int spp)
 constructor More...
 
virtual ~DiImage ()
 destructor
 
EI_Status getStatus () const
 get status of the image object More...
 
Uint32 getNumberOfFrames () const
 get number of frames More...
 
Uint32 getFirstFrame () const
 get index of first frame More...
 
Uint32 getTotalNumberOfFrames () const
 get total number of frames More...
 
Uint32 getRepresentativeFrame () const
 get representative frame More...
 
double getFrameTime () const
 get frame time More...
 
Uint16 getRows () const
 get number of rows More...
 
Uint16 getColumns () const
 get number of columns More...
 
double getPixelWidth () const
 get pixel's width More...
 
double getPixelHeight () const
 get pixel's height More...
 
double getRowColumnRatio () const
 get pixel's rows/column ratio More...
 
double getColumnRowRatio () const
 get pixel's column/rows ratio More...
 
int setRowColumnRatio (const double ratio)
 set pixel's rows/column ratio More...
 
int setColumnRowRatio (const double ratio)
 set pixel's column/rows ratio More...
 
EP_Polarity getPolarity () const
 get polarity. More...
 
int setPolarity (const EP_Polarity polarity)
 set polarity. More...
 
virtual EP_Interpretation getInternalColorModel () const =0
 get color model of internal pixel representation. More...
 
virtual DiImagecreateImage (const unsigned long fstart, const unsigned long fcount) const =0
 create copy of current image object (abstract) More...
 
virtual DiImagecreateScale (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 =0
 create scaled copy of specified (clipping) area of the current image object (abstract). More...
 
virtual DiImagecreateFlip (const int horz, const int vert) const =0
 create a flipped copy of the current image (abstract). More...
 
virtual DiImagecreateRotate (const int degree) const =0
 create a rotated copy of the current image (abstract). More...
 
virtual DiImagecreateMono (const double red, const double green, const double blue) const =0
 create monochrome copy of the current image (abstract). More...
 
int writeFrameToDataset (DcmItem &dataset, const unsigned long frame=0, const int bits=0, const int planar=0)
 render pixel data of given frame and write image related attributes to DICOM dataset. More...
 

Static Public Member Functions

static void * createPackedBitmap (const void *buffer, const unsigned long size, const unsigned long count, const int alloc, const int stored)
 create packed bitmap (e.g. More...
 

Protected Member Functions

 DiMonoImage (const DiDocument *image, const EI_Status status, const char dummy)
 constructor More...
 
 DiMonoImage (const DiMonoImage *image, const unsigned long fstart, const unsigned long fcount)
 constructor, copy More...
 
 DiMonoImage (const DiColorImage *image, const double red, const double green, const double blue)
 constructor, convert color images to monochrome More...
 
 DiMonoImage (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, const int aspect, const Uint16 pvalue)
 constructor, scale/clip More...
 
 DiMonoImage (const DiMonoImage *image, const int horz, const int vert)
 constructor, flip More...
 
 DiMonoImage (const DiMonoImage *image, const int degree)
 constructor, rotate More...
 
 DiMonoImage (const DiMonoImage *image, DiMonoOutputPixel *pixel, const unsigned long frame, const int stored, const int alloc)
 constructor, createMonoOutput More...
 
void Init (DiMonoModality *modality, const OFBool reuse=OFFalse)
 initialize internal data structures and member variables More...
 
void InitUint8 (DiMonoModality *modality)
 initialize internal data structures (for Uint8) More...
 
void InitSint8 (DiMonoModality *modality)
 initialize internal data structures (for Sint8) More...
 
void InitUint16 (DiMonoModality *modality)
 initialize internal data structures (for Uint16) More...
 
void InitSint16 (DiMonoModality *modality)
 initialize internal data structures (for Sint16) More...
 
void InitUint32 (DiMonoModality *modality)
 initialize internal data structures (for Uint32) More...
 
void InitSint32 (DiMonoModality *modality)
 initialize internal data structures (for Sint32) More...
 
int checkInterData (const int mode=1)
 check intermediate pixel representation for consistency More...
 
virtual void updateImagePixelModuleAttributes (DcmItem &dataset)
 update Image Pixel Module attributes in the given dataset. More...
 
const void * getData (void *buffer, const unsigned long size, const unsigned long frame, int bits, const int planar, const int negative)
 get pixel data with specified format. More...
 
void getDataUint8 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Uint8 input (helper function). More...
 
void getDataSint8 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Sint8 input (helper function). More...
 
void getDataUint16 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Uint16 input (helper function). More...
 
void getDataSint16 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Sint16 input (helper function). More...
 
void getDataUint32 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Uint32 input (helper function). More...
 
void getDataSint32 (void *buffer, DiDisplayFunction *disp, const int samples, const unsigned long frame, const int bits, const Uint32 low, const Uint32 high)
 get pixel data with specified format for Sint32 input (helper function). More...
 
int createLinODPresentationLut (const unsigned long count, const int bits)
 create a presentation look-up table converting the pixel data which is linear to Optical Density to DDLs of the softcopy device (used to display print images on screen). More...
 
- Protected Member Functions inherited from DiImage
 DiImage (const DiDocument *docu, const EI_Status status)
 constructor More...
 
 DiImage (const DiImage *image, const unsigned long fstart, const unsigned long fcount)
 constructor, copy More...
 
 DiImage (const DiImage *image, const Uint16 width, const Uint16 height, const int aspect=0)
 constructor, scale/clip More...
 
 DiImage (const DiImage *image, const int degree=0)
 constructor, rotate More...
 
 DiImage (const DiImage *image, const unsigned long frame, const int stored, const int alloc)
 constructor, createMonoOutput More...
 
void deleteInputData ()
 delete internally handled object for the input pixel data conversion
 
void checkPixelExtension ()
 check and possibly correct values for pixel spacing, aspect ratio etc.
 
void convertPixelData ()
 create input pixel data representation from DICOM dataset structures
 
int detachPixelData ()
 detach pixel data. More...
 

Protected Attributes

double WindowCenter
 center of current VOI-window
 
double WindowWidth
 width of current VOI-window
 
unsigned long WindowCount
 number of stored VOI-windows
 
unsigned long VoiLutCount
 number of stored VOU-LUTs
 
int ValidWindow
 true, if current VOI-window is valid
 
OFString VoiExplanation
 free text explanation of current VOI transformation
 
EF_VoiLutFunction VoiLutFunction
 VOI LUT function (linear or sigmoid)
 
ES_PresentationLut PresLutShape
 presentation LUT shape (identity, inverse or lin od)
 
unsigned int MinDensity
 minimum density of a print-out (in hundreds of Optical Density)
 
unsigned int MaxDensity
 maximum density of a print-out (ditto)
 
unsigned int Reflection
 reflected ambient light (in candela per square meter)
 
unsigned int Illumination
 illumination (ditto)
 
DiOverlayOverlays [2]
 points to associated overlay-objects ([0] = built-in, [1] = additional)
 
DiLookupTableVoiLutData
 points to associated VOI-LUT-object
 
DiLookupTablePresLutData
 points to associated presentation-LUT-object
 
DiMonoPixelInterData
 points to intermediate pixel data representation (object)
 
DiDisplayFunctionDisplayFunction
 points to grayscale standard display function (only referenced!)
 
- Protected Attributes inherited from DiImage
EI_Status ImageStatus
 copy of status variable declared in class 'DicomImage'
 
const DiDocumentDocument
 points to special object, which encapsulates the dcmdata module
 
Uint32 FirstFrame
 first frame to be processed
 
Uint32 NumberOfFrames
 number of frames in case of multi-frame images (otherwise '1')
 
Uint32 TotalNumberOfFrames
 total number of frames stored in the dataset
 
Uint32 RepresentativeFrame
 number of representative frame, type 3 attribute (default '0')
 
double FrameTime
 nominal time between individual frames (0 if absent)
 
Uint16 Rows
 number of rows (in pixel)
 
Uint16 Columns
 number of columns (in pixel)
 
double PixelWidth
 width of each pixel according to 'PixelSpacing/AspectRatio'
 
double PixelHeight
 height of each pixel according to 'PixelSpacing/AspectRatio'
 
Uint16 BitsAllocated
 number of bits allocated for each pixel
 
Uint16 BitsStored
 number of bits stored for each pixel (see 'BitsPerSample')
 
Uint16 HighBit
 position of highest stored bit
 
int BitsPerSample
 actual number of bits per sample (depth)
 
int SamplesPerPixel
 number of samples per pixel (1, 3 or 4)
 
EP_Polarity Polarity
 polarity (normal or reverse)
 
int hasSignedRepresentation
 is 'true' if pixel data is signed
 
int hasPixelSpacing
 is 'true' if attribute 'PixelSpacing' is present
 
int hasImagerPixelSpacing
 is 'true' if attribute 'ImagerPixelSpacing' is present
 
int hasNominalScannedPixelSpacing
 is 'true' if attribute 'hasNominalScannedPixelSpacing' is present
 
int hasPixelAspectRatio
 is 'true' if attribute 'PixelAspectRatio' is present
 
int isOriginal
 is 'false' if derived from original image data (e.g. scaled)
 
DiInputPixelInputData
 points to intermediate pixel representation (template object)
 
DcmFileCache FileCache
 file cache object used for partial read
 
Uint32 CurrentFragment
 current pixel item fragment (for encapsulated pixel data)
 

Private Attributes

DiMonoOutputPixelOutputData
 points to current output data (object)
 
void * OverlayData
 points to current overlay plane data (pixel array)
 

Detailed Description

Base class for monochrome images.

Constructor & Destructor Documentation

◆ DiMonoImage() [1/10]

DiMonoImage::DiMonoImage ( const DiDocument docu,
const EI_Status  status 
)

constructor

Parameters
docupointer to the DICOM document
statusstatus of the image object

◆ DiMonoImage() [2/10]

DiMonoImage::DiMonoImage ( const DiDocument docu,
const EI_Status  status,
const double  slope,
const double  intercept 
)

constructor, rescale

Parameters
docupointer to the DICOM document
statusstatus of the image object
sloperescale slope
interceptrescale intercept

◆ DiMonoImage() [3/10]

DiMonoImage::DiMonoImage ( const DiDocument docu,
const EI_Status  status,
const DcmUnsignedShort data,
const DcmUnsignedShort descriptor,
const DcmLongString explanation 
)

constructor, modality LUT

Parameters
docupointer to the DICOM document
statusstatus of the image object
dataelement containing the modality LUT data
descriptorelement containing the modality LUT descriptor
explanationelement containing the modality LUT explanation (optional)

◆ DiMonoImage() [4/10]

DiMonoImage::DiMonoImage ( const DiDocument image,
const EI_Status  status,
const char  dummy 
)
protected

constructor

Parameters
imagepointer to dataset (encapsulated)
statuscurrent image status
dummy(necessary to be different from another constructor)

◆ DiMonoImage() [5/10]

DiMonoImage::DiMonoImage ( const DiMonoImage image,
const unsigned long  fstart,
const unsigned long  fcount 
)
protected

constructor, copy

Parameters
imagepointer to reference image
fstartfirst frame to be processed
fcountnumber of frames

◆ DiMonoImage() [6/10]

DiMonoImage::DiMonoImage ( const DiColorImage image,
const double  red,
const double  green,
const double  blue 
)
protected

constructor, convert color images to monochrome

Parameters
imagepointer to reference image
redcoefficient by which the red component is weighted
greencoefficient by which the green component is weighted
bluecoefficient by which the blue component is weighted
Returns
pointer to new DiImage object (NULL if an error occurred)

◆ DiMonoImage() [7/10]

DiMonoImage::DiMonoImage ( 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,
const int  aspect,
const Uint16  pvalue 
)
protected

constructor, scale/clip

Parameters
imagepointer to reference image
left_posx coordinate of top left corner of area to be scaled (referring to image origin, negative values create a border around the image)
top_posy coordinate of top left corner of area to be scaled
src_colswidth of area to be scaled
src_rowsheight of area to be scaled
dest_colswidth of scaled image (in pixels)
dest_rowsheight of scaled image (in pixels)
interpolatespecifies 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
aspectspecifies 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)
pvalueP-value used for the border outside the image (0..65535)

◆ DiMonoImage() [8/10]

DiMonoImage::DiMonoImage ( const DiMonoImage image,
const int  horz,
const int  vert 
)
protected

constructor, flip

Parameters
imagepointer to reference image
horzflip horizontally if true
vertflip vertically if true

◆ DiMonoImage() [9/10]

DiMonoImage::DiMonoImage ( const DiMonoImage image,
const int  degree 
)
protected

constructor, rotate

Parameters
imagepointer to reference image
degreeangle by which the image shall be rotated

◆ DiMonoImage() [10/10]

DiMonoImage::DiMonoImage ( const DiMonoImage image,
DiMonoOutputPixel pixel,
const unsigned long  frame,
const int  stored,
const int  alloc 
)
protected

constructor, createMonoOutput

Parameters
imagepointer to reference image
pixelpointer to output pixel data used for the new image
framenumber of frame stored in the new image object
storednumber of bits stored
allocnumber of bits allocated

Member Function Documentation

◆ addOverlay()

int DiMonoImage::addOverlay ( const unsigned int  group,
const signed int  left_pos,
const signed int  top_pos,
const unsigned int  columns,
const unsigned int  rows,
const DcmOverlayData data,
const DcmLongString label,
const DcmLongString description,
const EM_Overlay  mode 
)

add specified plane to group of additional overlay planes.

replaces old overlay plane if group number already exists.

Parameters
groupgroup number (0x60nn) of overlay plane
left_posx coordinate of plane orgin (referring to image origin)
top_posy coordinate of plane origin
columnswidth of overlay plane (in pixels)
rowsheight of overlay plane (in pixels)
dataoverlay plane data (dcmdata element)
labeloverlay plane label
descriptionoverlay plane description
modedisplay mode (see 'diutils.h')
Returns
false (0) if an error occurred, true otherwise (1 = added new plane, 2 = replaced existing plane)

◆ checkInterData()

int DiMonoImage::checkInterData ( const int  mode = 1)
protected

check intermediate pixel representation for consistency

Parameters
modecheck number of pixels stored in the dataset if true
Returns
status, true if successful, false otherwise

◆ convertPValueToDDL()

int DiMonoImage::convertPValueToDDL ( const Uint16  pvalue,
Uint16 &  ddl,
const int  bits 
)

convert P-value to DDL.

conversion uses display LUT if present, linear scaling otherwise.

Parameters
pvalueP-value to be converted (0..65535)
ddlreference to resulting DDL
bitsnumber of bits for output
Returns
true if successful (1 = display function transformation, 2 = linear scaling), false otherwise

◆ create6xxx3000OverlayData()

unsigned long DiMonoImage::create6xxx3000OverlayData ( Uint8 *&  buffer,
const unsigned int  plane,
unsigned int &  width,
unsigned int &  height,
unsigned long &  frames,
const unsigned int  idx = 0 
)

create bitmap for specified overlay plane and store it in (6xxx,3000) format.

(1 bit allocated and stored, foreground color is 1, background color is 0, data is 16 bit padded - even length) memory is not handled internally - must be deleted from calling program.

Parameters
bufferstores pointer to overlay data (memory is allocated internally)
planenumber (0..15) or group number (0x60nn) of overlay plane
widthreturns width of overlay plane (in pixels)
heightreturns height of overlay plane (in pixels)
framesreturns number of frames (multiple overlay frames possible!)
idxindex of overlay group (0 = dataset, planes stored in the image dataset; 1 = additional, planes added by addOverlay()), default: 0
Returns
number of bytes allocated for the 'buffer' if successful, 0 otherwise

◆ createAWTBitmap()

unsigned long DiMonoImage::createAWTBitmap ( void *&  data,
const unsigned long  frame,
const int  bits 
)
virtual

create true color (32 bit) or palette (8 bit) bitmap for Java (AWT default format).

Memory is not handled internally - must be deleted from calling program.

Parameters
dataresulting pointer to bitmap data (set to NULL if an error occurred)
frameindex of frame to be converted (starting from 0)
bitsnumber of bits per pixel used for the output bitmap (8 or 32)
Returns
number of bytes allocated by the bitmap, or 0 if an error occurred

Implements DiImage.

◆ createDIB()

unsigned long DiMonoImage::createDIB ( void *&  data,
const unsigned long  size,
const unsigned long  frame,
const int  bits,
const int  upsideDown,
const int  padding = 1 
)
virtual

create true color (24/32 bit) or palette (8 bit) bitmap for MS Windows.

memory is not handled internally - must be deleted from calling program.

Parameters
datauntyped pointer memory buffer (set to NULL if not allocated externally)
sizesize of the memory buffer in bytes (if 0 'data' is set to NULL)
frameindex of frame to be converted (starting from 0)
bitsnumber of bits per pixel used for the output bitmap (8, 24 or 32)
upsideDownspecifies the order of lines in the images (0 = top-down, bottom-up otherwise)
paddingalign each line to a 32-bit address if true (default)
Returns
number of bytes allocated by the bitmap, or 0 if an error occurred

Implements DiImage.

◆ createLinODPresentationLut()

int DiMonoImage::createLinODPresentationLut ( const unsigned long  count,
const int  bits 
)
protected

create a presentation look-up table converting the pixel data which is linear to Optical Density to DDLs of the softcopy device (used to display print images on screen).

Parameters
countnumber of LUT entries
bitsnumber of bits per entry
Returns
true if successful, false otherwise

◆ createOutputImage()

DiImage* DiMonoImage::createOutputImage ( const unsigned long  frame,
const int  bits 
)

create new single frame DiImage with applied grayscale transformations.

The method getOutputData() is used internally for the new bitmap.

Parameters
frameindex of frame to be converted
bitsnumber of bits per pixel used for the output bitmap
Returns
pointer to new DiImage object (NULL if an error occurred)

◆ createPackedBitmap()

static void* DiMonoImage::createPackedBitmap ( const void *  buffer,
const unsigned long  size,
const unsigned long  count,
const int  alloc,
const int  stored 
)
static

create packed bitmap (e.g.

12/16 bit -> 12/12 bit for DICOM printers). Memory is not handled internally - must be deleted from calling program.

Parameters
bufferpointer to input memory buffer
sizesize of memory buffer (will be checked whether it is sufficient)
countnumber of entries (pixels) in input buffer
allocnumber of bits allocated for the pixels stored in the buffer (e.g. 16)
storednumber of bits stored for the pixels stored in the buffer (e.g. 12)
Returns
pointer to memory buffer containing the packed output bitmap data (NULL if an error occurred)

Referenced by DicomImage::create12BitPackedBitmap().

◆ deleteDisplayLUT()

int DiMonoImage::deleteDisplayLUT ( const int  bits)
inline

delete specified display LUT(s)

Parameters
bitsparameter of LUT to be deleted (0 = all)
Returns
true if successful, false otherwise

◆ deleteOverlayData()

void DiMonoImage::deleteOverlayData ( )

delete buffer for overlay plane data.

Save memory if data is no longer needed.

◆ flip()

int DiMonoImage::flip ( const int  horz,
const int  vert 
)
virtual

flip current image (horizontally and/or vertically)

Parameters
horzflip horizontally if true
vertflip vertically if true
Returns
true if successful (1 = flipped at least direction, 2 = not flipped, because of image resolution - width and/or height equal to 1), false otherwise

Implements DiImage.

◆ getBits()

virtual int DiMonoImage::getBits ( const int  bits = 0) const
inlinevirtual

get number of bits per sample.

If the optional parameter is specified the value will be checked and in any case a valid value will be returned.

Parameters
bitsvalue to be returned (if less than 1 or greater than the maximum (32) the default value will be used which is equal to the bits per sample value stored in the DICOM dataset)
Returns
status, true if successful, false otherwise

Reimplemented from DiImage.

◆ getData()

const void* DiMonoImage::getData ( void *  buffer,
const unsigned long  size,
const unsigned long  frame,
int  bits,
const int  planar,
const int  negative 
)
protected

get pixel data with specified format.

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
sizesize of the memory buffer in bytes (will be checked)
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
planarflag, only useful for multi-planar images (color)
negativeinvert pixel data if true
Returns
untyped pointer to the pixel data if successful, NULL otherwise

◆ getDataSint16()

void DiMonoImage::getDataSint16 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Sint16 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDataSint32()

void DiMonoImage::getDataSint32 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Sint32 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDataSint8()

void DiMonoImage::getDataSint8 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Sint8 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDataUint16()

void DiMonoImage::getDataUint16 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Uint16 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDataUint32()

void DiMonoImage::getDataUint32 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Uint32 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDataUint8()

void DiMonoImage::getDataUint8 ( void *  buffer,
DiDisplayFunction disp,
const int  samples,
const unsigned long  frame,
const int  bits,
const Uint32  low,
const Uint32  high 
)
protected

get pixel data with specified format for Uint8 input (helper function).

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
disppointer to current display function object
samplesnumber of samples per pixel
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
lowoutput pixel value to which 0 is mapped (min)
highoutput pixel value to which 2^bits-1 is mapped (max)

◆ getDisplayFunction()

DiDisplayFunction* DiMonoImage::getDisplayFunction ( ) const
inline

get display function

Returns
pointer to current display function, NULL if absent

◆ getFullOverlayData()

const void* DiMonoImage::getFullOverlayData ( const unsigned long  frame,
const unsigned int  plane,
unsigned int &  width,
unsigned int &  height,
const unsigned int  idx,
const int  bits = 8,
const Uint16  fore = 0xff,
const Uint16  back = 0x0 
)

create bitmap for specified overlay plane.

(up to 16 bits per pixel with two values: fore and back)

Parameters
frameindex of frame used for output
planenumber (0..15) or group number (0x60nn) of overlay plane
widthreturns width of overlay plane (in pixels)
heightreturns height of overlay plane (in pixels)
idxindex of overlay group (0 = dataset, 1 = additional, 2 = '1' plane hides '0' plane)
bitsnumber of bits (stored) in the resulting array, default: 8
foreforeground color to be set in bitmap, default: 255
backbackground color to be set in bitmap (transparent), default: 0
Returns
pointer to overlay plane data (internal memory buffer)

◆ getInterData()

const DiPixel* DiMonoImage::getInterData ( ) const
inlinevirtual

get pointer to intermediate pixel data representation

Returns
pointer to intermediate pixel data

Implements DiImage.

◆ getMinMaxValues()

int DiMonoImage::getMinMaxValues ( double &  min,
double &  max,
const int  mode 
) const

get minimum and maximum pixel values.

the resulting pixel values are stored in 'double' variables to avoid problems with different number ranges, limited to monochrome images

Parameters
minminimum pixel value (reference parameter)
maxmaximum pixel value (reference parameter)
mode0 = min/max 'used' pixel values, 1 = min/max 'possible' pixel values (absolute min/max)
Returns
status code (true if successful)

◆ getModalityLutExplanation()

const char* DiMonoImage::getModalityLutExplanation ( ) const
inline

get description of performed modality LUT transformation

Returns
pointer to description text (NULL if absent)

◆ getMonoImagePtr()

DiMonoImage* DiMonoImage::getMonoImagePtr ( )
inlinevirtual

get pointer to current monochrome image (this)

Returns
pointer to this object

Reimplemented from DiImage.

◆ getMonoInterData()

const DiMonoPixel* DiMonoImage::getMonoInterData ( ) const
inline

get pointer to intermediate pixel data representation

Returns
pointer to intermediate pixel data

◆ getOutputData() [1/2]

virtual const void* DiMonoImage::getOutputData ( const unsigned long  frame,
const int  bits,
const int  planar = 0 
)
pure virtual

get pixel data with specified format.

(memory is handled internally)

Parameters
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
planarflag, only useful for multi-planar images (color)
Returns
untyped pointer to the pixel data if successful, NULL otherwise

Implements DiImage.

Implemented in DiMono2Image, and DiMono1Image.

◆ getOutputData() [2/2]

virtual int DiMonoImage::getOutputData ( void *  buffer,
const unsigned long  size,
const unsigned long  frame,
const int  bits,
const int  planar = 0 
)
pure virtual

get pixel data with specified format.

(memory is handled externally)

Parameters
bufferuntyped pointer to the externally allocated memory buffer
sizesize of the memory buffer in bytes (will be checked)
framenumber of frame to be rendered
bitsnumber of bits for the output pixel data (depth)
planarflag, only useful for multi-planar images (color)
Returns
status, true if successful, false otherwise

Implements DiImage.

Implemented in DiMono2Image, and DiMono1Image.

◆ getOutputDataSize()

virtual unsigned long DiMonoImage::getOutputDataSize ( const int  bits = 0) const
virtual

get number of bytes required for the rendered output of a single frame

Parameters
bitsnumber of bits for the output pixel data (depth)
Returns
number of bytes if successful, 0 otherwise

Implements DiImage.

◆ getOutputPlane()

const void* DiMonoImage::getOutputPlane ( const int  dummy) const
virtual

get pixel data of specified plane.

(memory is handled internally)

Parameters
dummy(not used)
Returns
untyped pointer to the pixel data if successful, NULL otherwise

Implements DiImage.

◆ getOverlayData()

const void* DiMonoImage::getOverlayData ( const unsigned long  frame,
const unsigned int  plane,
unsigned int &  left_pos,
unsigned int &  top_pos,
unsigned int &  width,
unsigned int &  height,
EM_Overlay mode,
const unsigned int  idx,
const int  bits = 8,
const Uint16  fore = 0xff,
const Uint16  back = 0x0 
)

create bitmap for specified overlay plane.

(up to 16 bits per pixel with two values: fore and back)

Parameters
frameindex of frame used for output
planenumber (0..15) or group number (0x60nn) of overlay plane
left_posreturns x coordinate of plane's origin
top_posreturns y coordinate of plane's origin
widthreturns width of overlay plane (in pixels)
heightreturns height of overlay plane (in pixels)
modereturn display mode (see 'diutils.h')
idxindex of overlay group (0 = dataset, 1 = additional, 2 = '1' plane hides '0' plane)
bitsnumber of bits (stored) in the resulting array, default: 8
foreforeground color to be set in bitmap, default: 255
backbackground color to be set in bitmap (transparent), default: 0
Returns
pointer to overlay plane data (internal memory buffer)

◆ getOverlayPtr()

DiOverlay* DiMonoImage::getOverlayPtr ( const unsigned int  idx)
inlinevirtual

get pointer to specified overlay managing object

Parameters
idxindex of overlay group (0 = dataset, 1 = additional)
Returns
pointer to overlay managing object (NULL if absent or invalid)

Reimplemented from DiImage.

◆ getPresentationLutExplanation()

const char* DiMonoImage::getPresentationLutExplanation ( ) const
inline

get description of active presentation LUT

Returns
pointer to description text (NULL if absent)

◆ getPresentationLutShape()

ES_PresentationLut DiMonoImage::getPresentationLutShape ( ) const

get shape for presentation transformation.

possible values are: ESP_Default, ESP_Identity, ESP_Inverse, ESP_LinOD If a presentation LUT is currently active ESP_Default is always returned.

Returns
currently active presentation LUT shape

◆ getVoiLutCount()

unsigned long DiMonoImage::getVoiLutCount ( ) const
inline

get number of VOI LUTs (stored in image file)

Returns
number of VOI LUTs

◆ getVoiLutExplanation()

const char* DiMonoImage::getVoiLutExplanation ( const unsigned long  pos,
OFString explanation 
) const

get description of specified VOI LUT (stored in the image file)

Parameters
posindex of the stored VOI LUT (0..n-1)
explanationvariable in which the result text is stored
Returns
pointer to description text (NULL if absent or index invalid)

◆ getVoiLutFunction()

EF_VoiLutFunction DiMonoImage::getVoiLutFunction ( ) const

get VOI LUT function.

possible values are: EFV_Default, EFV_Linear, EFV_Sigmoid.

Returns
currently active VOI LUT function

◆ getVoiTransformationExplanation()

const char* DiMonoImage::getVoiTransformationExplanation ( ) const
inline

get description of active VOI transformation

Returns
pointer to description text (NULL if absent)

◆ getVoiWindowExplanation()

const char* DiMonoImage::getVoiWindowExplanation ( const unsigned long  pos,
OFString explanation 
) const

get description of specified VOI window (stored in the image file)

Parameters
posindex of the stored VOI window (0..n-1)
explanationvariable in which the result text is stored
Returns
pointer to description text (NULL if absent or index invalid)

◆ getWindow()

int DiMonoImage::getWindow ( double &  center,
double &  width 
)

get current window center and width values

Parameters
centerreturn current window center value
widthreturn current window width value
Returns
true if successful, false otherwise

◆ getWindowCount()

unsigned long DiMonoImage::getWindowCount ( ) const
inline

get number of VOI windows (stored in image file)

Returns
number of VOI windows

◆ Init()

void DiMonoImage::Init ( DiMonoModality modality,
const OFBool  reuse = OFFalse 
)
protected

initialize internal data structures and member variables

Parameters
modalitypointer to object handling the modality transform
reusereuse particular information determined in a previous call

◆ InitSint16()

void DiMonoImage::InitSint16 ( DiMonoModality modality)
protected

initialize internal data structures (for Sint16)

Parameters
modalitypointer to object handling the modality transform

◆ InitSint32()

void DiMonoImage::InitSint32 ( DiMonoModality modality)
protected

initialize internal data structures (for Sint32)

Parameters
modalitypointer to object handling the modality transform

◆ InitSint8()

void DiMonoImage::InitSint8 ( DiMonoModality modality)
protected

initialize internal data structures (for Sint8)

Parameters
modalitypointer to object handling the modality transform

◆ InitUint16()

void DiMonoImage::InitUint16 ( DiMonoModality modality)
protected

initialize internal data structures (for Uint16)

Parameters
modalitypointer to object handling the modality transform

◆ InitUint32()

void DiMonoImage::InitUint32 ( DiMonoModality modality)
protected

initialize internal data structures (for Uint32)

Parameters
modalitypointer to object handling the modality transform

◆ InitUint8()

void DiMonoImage::InitUint8 ( DiMonoModality modality)
protected

initialize internal data structures (for Uint8)

Parameters
modalitypointer to object handling the modality transform

◆ isValueUnused()

int DiMonoImage::isValueUnused ( const unsigned long  value)
inline

check whether given output value is unused

Parameters
valueoutput value to be checked
Returns
status, true if unused (1 = within output range, 2 = out of range), false otherwise

◆ processNextFrames()

virtual int DiMonoImage::processNextFrames ( const unsigned long  fcount)
virtual

process next couple of frames

Parameters
fcountnumber of frames to be processed (0 = same number as before)
Returns
status, true if successful, false otherwise

Reimplemented from DiImage.

◆ removeAllOverlays()

int DiMonoImage::removeAllOverlays ( )

remove all additional overlay planes

Returns
false (0) if an error occurred, true otherwise

◆ rotate()

int DiMonoImage::rotate ( const int  degree)
virtual

rotate current image (by steps of 90 degrees)

Parameters
degreeangle by which the image shall be rotated (-360, -270, -180, -90, 0, 90, 180, 270, 360)
Returns
true if successful (1 = rotated by at least 90 degrees, 2 = not rotated, because of image resolution or angle), false otherwise

Reimplemented from DiImage.

◆ setDisplayFunction()

int DiMonoImage::setDisplayFunction ( DiDisplayFunction display)

set display function

Parameters
displayobject describing the output device characteristic (only referenced!)
Returns
true if successful, false otherwise

◆ setHardcopyParameters()

int DiMonoImage::setHardcopyParameters ( const unsigned int  min,
const unsigned int  max,
const unsigned int  reflect,
const unsigned int  illumin 
)

set hardcopy parameters.

(used to display LinOD images)

Parameters
minminimum density of the print-out (in hundreds of Optical Density, e.g. 150 means 1.5 OD)
maxmaximum density of the print-out (ditto)
reflectreflected ambient light (in candela per square meter - cd/m^2)
illuminillumination (ditto)
Returns
true if successful (1 = at least one of the parameters has changed, 2 = no parameter has changed) false otherwise

◆ setHistogramWindow()

int DiMonoImage::setHistogramWindow ( const double  thresh)

set automatically calculated histogram window.

possibly active VOI LUT is implicitly disabled.

Parameters
threshthreshold value specifying percentage of histogram border which shall be ignored
Returns
true if successful, false otherwise

◆ setInversePresentationLut()

int DiMonoImage::setInversePresentationLut ( const DcmUnsignedShort data,
const DcmUnsignedShort descriptor,
const EL_BitsPerTableEntry  descripMode = ELM_UseValue 
)

set inverse LUT for presentation transformation.

this LUT transform is e.g. used for DICOM print (12->8, 8->12 bit) possibly active presentation LUT will not be considered !

Parameters
datacontains LUT data
descriptordescribes LUT structure
descripModemode specifying the use of the bits per table entry value
Returns
true if successful, false otherwise

◆ setMinMaxWindow()

int DiMonoImage::setMinMaxWindow ( const int  idx = 1)

set automatically calculated minimum/maximum window.

possibly active VOI LUT is implicitly disabled.

Parameters
idxignore global min/max values if false (0)
Returns
true if successful (1 = window has changed, 2 = new window is the same as previous one), false otherwise

◆ setNoDisplayFunction()

int DiMonoImage::setNoDisplayFunction ( )

set no display function.

disables display function transformation, object is not deleted!

Returns
true if successful (1 = disabled current function, 2 = there was no function to disable) false otherwise

◆ setNoVoiTransformation()

int DiMonoImage::setNoVoiTransformation ( )

unset all VOI transformations (windows and LUTs).

only applicable for monochrome images

Returns
true if successful (1 = previous window/LUT has been valid, 2 = otherwise), false otherwise (image is invalid or not monochrome)

◆ setPresentationLut()

int DiMonoImage::setPresentationLut ( const DcmUnsignedShort data,
const DcmUnsignedShort descriptor,
const DcmLongString explanation = NULL,
const EL_BitsPerTableEntry  descripMode = ELM_UseValue 
)

set LUT for presentation transformation.

possibly active presentation LUT is implicitly disabled.

Parameters
datacontains LUT data
descriptordescribes LUT structure
explanationfree form description of presentation LUT (optional)
descripModemode specifying the use of the bits per table entry value
Returns
true if successful, false otherwise

◆ setPresentationLutShape()

int DiMonoImage::setPresentationLutShape ( const ES_PresentationLut  shape)

set shape for presentation transformation.

possibly active presentation LUT is implicitly disabled.

Parameters
shapepresentation LUT shape (default, identity or inverse). 'default' means that the output data is always created with 0 for black and maxvalue for white (i.e. monochrome2 data is created for output).
Returns
true if successful (1 = shape has changed, 2 = shape has not changed) false otherwise

◆ setRoiWindow()

int DiMonoImage::setRoiWindow ( const unsigned long  left_pos,
const unsigned long  top_pos,
const unsigned long  width,
const unsigned long  height,
const unsigned long  frame 
)

set automatically calculated VOI window for the specified Region of Interest (ROI).

The ROI is specified by means of a rectangle (left_pos, top_pos, width, height). Possibly active VOI LUT is implicitly disabled.

Parameters
left_posx-coordinate of the top left-hand corner of the ROI (starting from 0)
top_posy-coordinate of the top left-hand corner of the ROI (starting from 0)
widthwidth in pixels of the rectangular ROI (minimum: 1)
heightheight in pixels of the rectangular ROI (minimum: 1)
frameindex of the frame to be used for the calculation
Returns
true if successful (1 = window has changed, 2 = new window is the same as previous one), false otherwise

◆ setVoiLut() [1/2]

int DiMonoImage::setVoiLut ( const DcmUnsignedShort data,
const DcmUnsignedShort descriptor,
const DcmLongString explanation,
const EL_BitsPerTableEntry  descripMode = ELM_UseValue 
)

set VOI LUT (given by dcmdata elements).

possibly active window/center is implicitly disabled.

Parameters
datacontains LUT data
descriptordescribes LUT structure
explanationfree form description of VOI LUT (optional)
descripModemode specifying the use of the bits per table entry value
Returns
true if successful, false otherwise

◆ setVoiLut() [2/2]

int DiMonoImage::setVoiLut ( const unsigned long  pos,
const EL_BitsPerTableEntry  descripMode = ELM_UseValue 
)

set VOI LUT (given by index to VOI LUT sequence stored in image file).

possibly active window/center is implicitly disabled.

Parameters
posindex to VOI LUT sequence
descripModemode specifying the use of the bits per table entry value
Returns
true if successful, false otherwise

◆ setVoiLutFunction()

int DiMonoImage::setVoiLutFunction ( const EF_VoiLutFunction  function)

set VOI LUT function

Parameters
functiontype of VOI LUT function (default, linear or sigmoid). 'default' basically means the same as 'linear'.
Returns
true if successful (1 = function has changed, 2 = function has not changed) false otherwise

◆ setWindow() [1/2]

int DiMonoImage::setWindow ( const unsigned long  pos = 0)

set specified window (given by index to window width/center sequence stored in image file).

possibly active VOI LUT is implicitly disabled.

Parameters
posindex to window width/center sequence
Returns
true if successful, false otherwise

◆ setWindow() [2/2]

int DiMonoImage::setWindow ( const double  center,
const double  width,
const char *  explanation = NULL 
)

set specified window (given by window width and center).

possibly active VOI LUT is implicitly disabled.

Parameters
centercenter of specified window
widthwidth of specified window
explanationwindow explanation (optional)
Returns
true if successful (1 = window has changed, 2 = new window is the same as previous one), false otherwise

◆ updateImagePixelModuleAttributes()

virtual void DiMonoImage::updateImagePixelModuleAttributes ( DcmItem dataset)
protectedvirtual

update Image Pixel Module attributes in the given dataset.

Removes possibly existing embedded overlay planes and replaces any present modality transformation by a linear rescale/slope. Used in writeXXXToDataset() routines.

Parameters
datasetreference to DICOM image dataset

Reimplemented from DiImage.

◆ writeBMP()

int DiMonoImage::writeBMP ( FILE *  stream,
const unsigned long  frame,
const int  bits 
)
virtual

write pixel data to BMP file

Parameters
streamopen C output stream
frameindex of frame used for output (default: first frame = 0)
bitsnumber of bits used for output of pixel data (8, 24 or 32, default (0) = 8)
Returns
true if successful, false otherwise

Reimplemented from DiImage.

◆ writeImageToDataset()

int DiMonoImage::writeImageToDataset ( DcmItem dataset,
const int  mode,
const int  planar 
)
virtual

write current image and related attributes to DICOM dataset.

Parameters
datasetreference to DICOM dataset where the image attributes are stored
mode0 = determine value of BitsStored from 'used' pixel values, 1 = determine value of BitsStored from 'possible' pixel values
planardummy parameter (only used for color images)
Returns
true if successful, false otherwise

Implements DiImage.

◆ writePPM() [1/2]

int DiMonoImage::writePPM ( STD_NAMESPACE ostream &  stream,
const unsigned long  frame,
const int  bits 
)
virtual

write pixel data to PPM file.

pixel data is written in ASCII format.

Parameters
streamopen C++ output stream
frameindex of frame used for output
bitsnumber of bits used for output of pixel data
Returns
true if successful, false otherwise

Implements DiImage.

◆ writePPM() [2/2]

int DiMonoImage::writePPM ( FILE *  stream,
const unsigned long  frame,
const int  bits 
)
virtual

write pixel data to PPM file.

pixel data is written in ASCII format.

Parameters
streamopen C output stream
frameindex of frame used for output
bitsnumber of bits used for output of pixel data
Returns
true if successful, false otherwise

Implements DiImage.

◆ writeRawPPM()

int DiMonoImage::writeRawPPM ( FILE *  stream,
const unsigned long  frame,
const int  bits 
)
virtual

write pixel data to raw PPM file

Parameters
streamopen C output stream
frameindex of frame used for output
bitsnumber of bits used for output of pixel data
Returns
true if successful, false otherwise

Implements DiImage.


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


Generated on Mon Oct 28 2019 for DCMTK Version 3.6.5 by Doxygen 1.8.15