OFFIS DCMTK
Version 3.6.0
|
the representation of one item of the Softcopy VOI LUT Sequence More...
Public Member Functions | |
DVPSSoftcopyVOI () | |
default constructor | |
DVPSSoftcopyVOI (const DVPSSoftcopyVOI ©) | |
copy constructor | |
DVPSSoftcopyVOI * | clone () |
clone method. More... | |
virtual | ~DVPSSoftcopyVOI () |
destructor | |
OFCondition | read (DcmItem &dset) |
reads a softcopy VOI LUT item from a DICOM dataset. More... | |
OFCondition | write (DcmItem &dset) |
writes the dsoftcopy VOI LUT item managed by this object to a DICOM dataset. More... | |
OFBool | isApplicable (const char *instanceUID, unsigned long frame) |
checks if this displayed area is applicable to the given image and frame. More... | |
OFBool | matchesApplicability (const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability) |
checks if this displayed area matches exactly the applicability defined by the instanceUID, frame and applicability parameters. More... | |
OFCondition | addImageReference (const char *sopclassUID, const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability) |
add a new image reference. More... | |
void | removeImageReference (DVPSReferencedSeries_PList &allReferences, const char *instanceUID, unsigned long frame, unsigned long numberOfFrames, DVPSObjectApplicability applicability) |
removes a reference to an image or frame. More... | |
void | clearImageReferences () |
removes all image references for this displayed area. | |
OFBool | imageReferencesEmpty () |
checks if the list of image references for this displayed area is empty. More... | |
OFBool | haveLUT () |
check if a VOI LUT is currently active More... | |
const char * | getCurrentVOIDescription () |
returns a description string for a currently active VOI transform. More... | |
OFCondition | getCurrentWindowWidth (double &w) |
gets the width of the current VOI window. More... | |
OFCondition | getCurrentWindowCenter (double &c) |
get the center of the current VOI window. More... | |
DcmUnsignedShort & | getLUTDescriptor () |
returns a reference to the current VOI LUT descriptor. More... | |
DcmUnsignedShort & | getLUTData () |
returns a reference to the current VOI LUT data. More... | |
OFCondition | setVOIWindow (double wCenter, double wWidth, const char *description=NULL) |
sets a user defined VOI window center and width. More... | |
OFCondition | setVOILUT (DcmUnsignedShort &lutDescriptor, DcmUnsignedShort &lutData, DcmLongString &lutExplanation) |
stores (copies) a VOI lookup table. More... | |
Private Member Functions | |
DVPSSoftcopyVOI & | operator= (const DVPSSoftcopyVOI &) |
private undefined assignment operator | |
Private Attributes | |
DVPSReferencedImage_PList | referencedImageList |
ReferencedImageSequence, Type 1c. | |
OFBool | useLUT |
If true, a VOI LUT is set, otherwise a VOI Window is set. | |
DcmUnsignedShort | voiLUTDescriptor |
Module=VOI_LUT, VR=xs, VM=3, Type 1c. | |
DcmLongString | voiLUTExplanation |
Module=VOI_LUT, VR=LO, VM=1, Type 3. | |
DcmUnsignedShort | voiLUTData |
Module=VOI_LUT, VR=xs, VM=1-n, Type 1c. | |
DcmDecimalString | windowCenter |
Module=VOI_LUT, VR=DS, VM=1-n, Type 1c (unlike VOI LUT module!) | |
DcmDecimalString | windowWidth |
Module=VOI_LUT, VR=DS, VM=1-n, Type 1c. | |
DcmLongString | windowCenterWidthExplanation |
Module=VOI_LUT, VR=LO, VM=1-n, Type 3. | |
the representation of one item of the Softcopy VOI LUT Sequence
OFCondition DVPSSoftcopyVOI::addImageReference | ( | const char * | sopclassUID, |
const char * | instanceUID, | ||
unsigned long | frame, | ||
DVPSObjectApplicability | applicability | ||
) |
add a new image reference.
Checks if the referenced SOP instance UID already exists in this sequence. If it exists, an error code is returned. Otherwise a new image reference is created and added to the ReferencedImageSequence.
sopclassUID | the SOP class UID of the image reference to be added. |
instanceUID | the SOP instance UID of the image reference to be added. |
frame | the frame number of the image reference (current image) to be added. |
applicability | the applicability of the image reference (DVPSB_currentFrame or DVPSB_currentImage) |
Referenced by clone().
|
inline |
clone method.
Definition at line 58 of file dvpssv.h.
References addImageReference(), DVPSSoftcopyVOI(), isApplicable(), matchesApplicability(), read(), removeImageReference(), write(), and ~DVPSSoftcopyVOI().
const char* DVPSSoftcopyVOI::getCurrentVOIDescription | ( | ) |
returns a description string for a currently active VOI transform.
If no description is available, NULL is returned.
Referenced by haveLUT().
OFCondition DVPSSoftcopyVOI::getCurrentWindowCenter | ( | double & | c | ) |
OFCondition DVPSSoftcopyVOI::getCurrentWindowWidth | ( | double & | w | ) |
|
inline |
returns a reference to the current VOI LUT data.
May only be called if haveLUT() is OFTrue.
Definition at line 178 of file dvpssv.h.
References operator=(), setVOILUT(), setVOIWindow(), and voiLUTData.
|
inline |
returns a reference to the current VOI LUT descriptor.
May only be called if haveLUT() is OFTrue.
Definition at line 172 of file dvpssv.h.
References voiLUTDescriptor.
|
inline |
check if a VOI LUT is currently active
Definition at line 146 of file dvpssv.h.
References getCurrentVOIDescription(), getCurrentWindowCenter(), getCurrentWindowWidth(), and useLUT.
|
inline |
checks if the list of image references for this displayed area is empty.
Definition at line 141 of file dvpssv.h.
References referencedImageList, and DVPSReferencedImage_PList::size().
OFBool DVPSSoftcopyVOI::isApplicable | ( | const char * | instanceUID, |
unsigned long | frame | ||
) |
checks if this displayed area is applicable to the given image and frame.
instanceUID | SOP instance UID of the current image |
frame | number of the current frame |
Referenced by clone().
OFBool DVPSSoftcopyVOI::matchesApplicability | ( | const char * | instanceUID, |
unsigned long | frame, | ||
DVPSObjectApplicability | applicability | ||
) |
checks if this displayed area matches exactly the applicability defined by the instanceUID, frame and applicability parameters.
instanceUID | SOP instance UID of the current image |
frame | number of the current frame |
Referenced by clone().
OFCondition DVPSSoftcopyVOI::read | ( | DcmItem & | dset | ) |
reads a softcopy VOI LUT item from a DICOM dataset.
The DICOM elements of the softcopy VOI LUT item are copied from the dataset to this object. The completeness of the item (presence of all required elements, value multiplicity) is checked. If this method returns an error code, the object is in undefined state afterwards.
dset | the item of the SoftcopyVOILUTSequence from which the data is to be read |
Referenced by clone().
void DVPSSoftcopyVOI::removeImageReference | ( | DVPSReferencedSeries_PList & | allReferences, |
const char * | instanceUID, | ||
unsigned long | frame, | ||
unsigned long | numberOfFrames, | ||
DVPSObjectApplicability | applicability | ||
) |
removes a reference to an image or frame.
If the current reference is empty ("global"), an explicit list of references is constructed from the list of series/instance references. The image or frame reference is removed from the total list of references in this object. If the only reference contained in this object is removed, the reference list becomes empty which means that the current reference becomes "global". This case must be handled by the called (e.g. by deleting the displayed area selection object).
allReferences | list of series/instance references registered for the presentation state. |
instanceUID | SOP instance UID of the current image |
frame | number of the current frame |
numberOfFrames | the number of frames of the current image |
applicability | applicability of the new displayed area selection |
applicability | the applicability of the image reference to be removed (DVPSB_currentFrame or DVPSB_currentImage) |
Referenced by clone().
OFCondition DVPSSoftcopyVOI::setVOILUT | ( | DcmUnsignedShort & | lutDescriptor, |
DcmUnsignedShort & | lutData, | ||
DcmLongString & | lutExplanation | ||
) |
stores (copies) a VOI lookup table.
If the method returns an error code, an old LUT is left unchanged.
lutDescriptor | the LUT Descriptor in DICOM format (VM=3) |
lutData | the LUT Data in DICOM format |
lutExplanation | the LUT Explanation in DICOM format, may be empty. |
Referenced by getLUTData().
OFCondition DVPSSoftcopyVOI::setVOIWindow | ( | double | wCenter, |
double | wWidth, | ||
const char * | description = NULL |
||
) |
sets a user defined VOI window center and width.
wCenter | the window center |
wWidth | the window width |
description | an optional description. Default: absent. |
Referenced by getLUTData().
OFCondition DVPSSoftcopyVOI::write | ( | DcmItem & | dset | ) |
writes the dsoftcopy VOI LUT item managed by this object to a DICOM dataset.
Copies of the DICOM elements managed by this object are inserted into the DICOM dataset.
dset | the the item of the SoftcopyVOILUTSequence to which the data is written |
Referenced by clone().