DVPSReferencedImage Class Reference
an item of the referenced image sequence in a presentation state (internal use only).
More...
List of all members.
Public Member Functions |
| DVPSReferencedImage () |
| default constructor
|
| DVPSReferencedImage (const DVPSReferencedImage ©) |
| copy constructor
|
DVPSReferencedImage * | clone () |
| clone method.
|
virtual | ~DVPSReferencedImage () |
| destructor
|
OFCondition | read (DcmItem &dset) |
| reads an image reference from a DICOM dataset.
|
OFCondition | write (DcmItem &dset) |
| writes the image reference managed by this object to a DICOM dataset.
|
OFBool | validateSOPClassUID (OFString &sopclassuid) |
| check if the passed SOP Class UID is equal to the one stored in this object.
|
void | setSOPClassUID (const char *uid) |
| set SOP Class UID of this image reference.
|
void | setSOPInstanceUID (const char *uid) |
| set SOP Instance UID of this image reference.
|
void | setFrameNumbers (const char *frames) |
| set the list of frame numbers of this image reference.
|
OFBool | isSOPInstanceUID (const char *uid) |
| compare SOP Instance UID.
|
OFCondition | getImageReference (OFString &sopclassUID, OFString &instanceUID, OFString &frames) |
| gets the image reference managed by this object.
|
OFBool | appliesToFrame (unsigned long frame) |
| checks whether this image reference applies to the given frame number.
|
OFBool | appliesOnlyToFrame (unsigned long frame) |
| checks whether this image reference applies exactly to the given frame number.
|
OFBool | appliesToAllFrames () |
| checks whether this image reference applies all frames because the referencedFrameNumber is empty.
|
void | removeFrameReference (unsigned long frame, unsigned long numberOfFrames) |
| update the reference such that the given frame is not referenced any more.
|
void | setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode) |
| sets a new log stream
|
Private Member Functions |
DVPSReferencedImage & | operator= (const DVPSReferencedImage &source) |
| undefined private assignment operator
|
void | flushCache () |
| flushes the frame cache.
|
void | updateCache () |
| updated the frame cache.
|
Private Attributes |
DcmUniqueIdentifier | referencedSOPClassUID |
| VR=UI, VM=1, Type 1c.
|
DcmUniqueIdentifier | referencedSOPInstanceUID |
| VR=UI, VM=1, Type 1c.
|
DcmIntegerString | referencedFrameNumber |
| VR=IS, VM=1-n, Type 1c.
|
Sint32 * | frameCache |
| if exists, contains binary representation of referencedFrameNumber
|
unsigned long | frameCacheEntries |
| describes array size of frameCache
|
OFConsole * | logstream |
| output stream for error messages, never NULL
|
OFBool | verboseMode |
| flag indicating whether we're operating in verbose mode
|
OFBool | debugMode |
| flag indicating whether we're operating in debug mode
|
Detailed Description
an item of the referenced image sequence in a presentation state (internal use only).
This class manages the data structures comprising one item of the Reference Image Sequence which is contained in the Referenced Series Sequence in a Presentation State object.
Definition at line 46 of file dvpsri.h.
Member Function Documentation
OFBool DVPSReferencedImage::appliesOnlyToFrame |
( |
unsigned long |
frame |
) |
|
checks whether this image reference applies exactly to the given frame number.
This is the case if the referencedFrameNumber only contains the given frame number.
- Parameters:
-
| frame | frame number to be checked |
- Returns:
- OFTrue if the image reference applies only to the given frame number, OFFalse otherwise.
OFBool DVPSReferencedImage::appliesToAllFrames |
( |
|
) |
|
checks whether this image reference applies all frames because the referencedFrameNumber is empty.
- Returns:
- OFTrue if the image reference applies to all frames, OFFalse otherwise.
OFBool DVPSReferencedImage::appliesToFrame |
( |
unsigned long |
frame |
) |
|
checks whether this image reference applies to the given frame number.
An image reference applies to a frame if the frame number is explicitly listed in the referencedFrameNumber attribute or if the referencedFrameNumber is empty.
- Parameters:
-
| frame | frame number to be checked |
- Returns:
- OFTrue if the image reference applies to the given frame number, OFFalse otherwise.
gets the image reference managed by this object.
- Parameters:
-
| sopclassUID | the SOP Class UID is returned in this string |
| instanceUID | the SOP Instance UID is returned in this string |
| frames | the list of frames is returned in this string |
- Returns:
- EC_Normal if successful, an error code otherwise.
OFBool DVPSReferencedImage::isSOPInstanceUID |
( |
const char * |
uid |
) |
|
compare SOP Instance UID.
- Parameters:
-
| uid | the UID to be compared |
- Returns:
- OFTrue if the referencedSOPInstanceUID of this object is equal to uid, OFFalse otherwise.
reads an image reference from a DICOM dataset.
The DICOM elements of the referenced image 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.
- Parameters:
-
| dset | the item of the ReferencedImageSequence from which the data is to be read |
- Returns:
- EC_Normal if successful, an error code otherwise.
void DVPSReferencedImage::removeFrameReference |
( |
unsigned long |
frame, |
|
|
unsigned long |
numberOfFrames | |
|
) |
| | |
update the reference such that the given frame is not referenced any more.
- Parameters:
-
| frame | the frame reference |
| numberOfFrames | the number of frames of the image reference |
void DVPSReferencedImage::setFrameNumbers |
( |
const char * |
frames |
) |
|
set the list of frame numbers of this image reference.
- Parameters:
-
| frames | a list of frame numbers in DICOM IS format (integer numbers separated by '\' characters) |
void DVPSReferencedImage::setLog |
( |
OFConsole * |
stream, |
|
|
OFBool |
verbMode, |
|
|
OFBool |
dbgMode | |
|
) |
| | |
sets a new log stream
- Parameters:
-
| stream | new log stream, NULL for default logstream |
| verbMode | verbose mode flag |
| dbgMode | debug mode flag |
void DVPSReferencedImage::setSOPClassUID |
( |
const char * |
uid |
) |
|
set SOP Class UID of this image reference.
- Parameters:
-
| uid | a pointer to the UID, which is copied into this object. |
void DVPSReferencedImage::setSOPInstanceUID |
( |
const char * |
uid |
) |
|
set SOP Instance UID of this image reference.
- Parameters:
-
| uid | a pointer to the UID, which is copied into this object. |
OFBool DVPSReferencedImage::validateSOPClassUID |
( |
OFString & |
sopclassuid |
) |
|
check if the passed SOP Class UID is equal to the one stored in this object.
If sopclassuid is empty, the referencedSOPClassUID is assigned to it and the method returns OFTrue. Otherwise the passed UID is compared with the referencedSOPClassUID. OFTrue is returned if they are equal, OFFalse otherwise. This method is used to check whether all image references in a presentation state share the same SOP Class UID.
- Parameters:
-
| sopclassuid | the SOP class UID to be validated |
- Returns:
- OFTrue if successful, OFFalse if unsuccessful.
writes the image reference managed by this object to a DICOM dataset.
Copies of the DICOM element managed by this object are inserted into the DICOM dataset.
- Parameters:
-
| dset | the the item of the ReferencedImageSequence to which the data is written |
- Returns:
- EC_Normal if successful, an error code otherwise.
The documentation for this class was generated from the following file:
- dcmpstat/include/dcmtk/dcmpstat/dvpsri.h