Public Member Functions | |
| DVPSOverlay () | |
| default constructor | |
| DVPSOverlay (const DVPSOverlay ©) | |
| copy constructor | |
| DVPSOverlay * | clone () const |
| clone method. | |
| virtual | ~DVPSOverlay () |
| destructor | |
| OFCondition | read (DcmItem &dset, Uint8 ovGroup, Uint8 asGroup=0xFF) |
| reads the specified overlay group from a DICOM dataset. | |
| OFCondition | write (DcmItem &dset) |
| writes the overlay plane managed by this object to a DICOM dataset. | |
| Uint8 | getOverlayGroup () const |
| get group number of overlay repeating group managed by this object. | |
| void | setOverlayGroup (Uint8 newGroup) |
| sets the group number for the overlay repeating group managed by this object. | |
| OFBool | isSuitableAsShutter (unsigned long x, unsigned long y) |
| checks if the overlay is suitable as a bitmap shutter for an image with the given image size. | |
| const char * | getOverlayLabel () |
| gets the overlay label if present. | |
| const char * | getOverlayDescription () |
| gets the overlay description if present. | |
| OFBool | isROI () |
| checks whether this overlay is ROI type. | |
| OFCondition | getValues (Sint16 &originX, Sint16 &originY, Uint16 &sizeX, Uint16 &sizeY) |
| retrieve origin and size values for this overlay | |
| DcmOverlayData & | getData () |
| return reference to overlay data | |
| DcmLongString & | getLabel () |
| return reference to overlay label | |
| DcmLongString & | getDescription () |
| return reference to overlay description | |
Private Member Functions | |
| DVPSOverlay & | operator= (const DVPSOverlay &) |
| private undefined assignment operator | |
Private Attributes | |
| Uint8 | overlayGroup |
| lower byte of the overlay repeating group managed by this object | |
| DcmUnsignedShort | overlayRows |
| VR=US, VM=1, Type=1. | |
| DcmUnsignedShort | overlayColumns |
| VR=US, VM=1, Type=1. | |
| DcmCodeString | overlayType |
| VR=CS, VM=1, Type=1. | |
| DcmSignedShort | overlayOrigin |
| VR=SS, VM=2, Type=1. | |
| DcmUnsignedShort | overlayBitsAllocated |
| VR=US, VM=1, Type=1. | |
| DcmUnsignedShort | overlayBitPosition |
| VR=US, VM=1, Type=1. | |
| DcmOverlayData | overlayData |
| VR=OW, VM=1, Type=1C. | |
| DcmLongString | overlayDescription |
| VR=LO, VM=1, Type=3. | |
| DcmLongString | overlayLabel |
| VR=LO, VM=1, Type=3. | |
This class manages the data structures comprising a single overlay (one instance of the Overlay Plane Module repeating elements) that is contained in a Presentation State object.
Definition at line 44 of file dvpsov.h.
| DVPSOverlay* DVPSOverlay::clone | ( | ) | const [inline] |
clone method.
Definition at line 57 of file dvpsov.h.
References DVPSOverlay().
| OFCondition DVPSOverlay::read | ( | DcmItem & | dset, | |
| Uint8 | ovGroup, | |||
| Uint8 | asGroup = 0xFF | |||
| ) |
reads the specified overlay group from a DICOM dataset.
The DICOM elements of the Overlay Plane module are copied from the dataset to this object. The OverlayData element, which is optional in the Overlay Plane Module but required for presentation states, must be present. The completeness of the overlay plane (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 DICOM dataset from which the overlay is to be read | |
| ovGroup | the lower byte of the overlay group to be read | |
| asGroup | the lower byte of the overlay group to be assigned to the overlay plane in the presentation state. Default: identical to ovGroup. |
| OFCondition DVPSOverlay::write | ( | DcmItem & | dset | ) |
writes the overlay plane managed by this object to a DICOM dataset.
Copies of the DICOM element managed by this object are inserted into the DICOM dataset.
| dset | the DICOM dataset to which the overlay is written |
| Uint8 DVPSOverlay::getOverlayGroup | ( | ) | const [inline] |
get group number of overlay repeating group managed by this object.
Definition at line 89 of file dvpsov.h.
References overlayGroup.
| void DVPSOverlay::setOverlayGroup | ( | Uint8 | newGroup | ) | [inline] |
sets the group number for the overlay repeating group managed by this object.
| newGroup | lower byte of the repeating group number. |
Definition at line 95 of file dvpsov.h.
References overlayGroup.
| OFBool DVPSOverlay::isSuitableAsShutter | ( | unsigned long | x, | |
| unsigned long | y | |||
| ) |
checks if the overlay is suitable as a bitmap shutter for an image with the given image size.
Checks overlay type, origin and size.
| x | image width in pixels | |
| y | image height in pixels |
| const char* DVPSOverlay::getOverlayLabel | ( | ) |
gets the overlay label if present.
If the label string is absent, this method returns NULL.
| const char* DVPSOverlay::getOverlayDescription | ( | ) |
gets the overlay description if present.
If the label string is absent, this method returns NULL.
| OFBool DVPSOverlay::isROI | ( | ) |
checks whether this overlay is ROI type.
| OFCondition DVPSOverlay::getValues | ( | Sint16 & | originX, | |
| Sint16 & | originY, | |||
| Uint16 & | sizeX, | |||
| Uint16 & | sizeY | |||
| ) |
retrieve origin and size values for this overlay
| originX | horizontal origin returned in this parameter | |
| originY | vertical origin returned in this parameter | |
| sizeX | horizontal size returned in this parameter | |
| sizeY | vertical size returned in this parameter |