Returns a secondary capture version of the image, complete with labels etc.
| Visual Basic |
|---|
Public Function Capture( _ ByVal WholeImage As Boolean _ ) As DicomImage |
The image is copied, at its present display resolution, zoom, orientation and scrolling, complete with annotations (if ShowLabels is true).
If WholeImage is false, then just the area of the image currently displayed is captured, but if WholeImage is true, then the entire image is captured. In whole image mode, the scroll properties are ignored, but other display properties, including Zoom are still used, so this method should be used with caution if Zoom is large, as very large images may result.
A new Instance UID is generated, and the type is set to secondary, but most image properties are copied unchanged. If the resulting image is entirely monochrome, then it is generated as a MONOCHROME2 image, but if any colour is present (even in annotations), then a full RGB image is produced, unless used with the screen set to an 8 bit display mode, in which case a PALETTE COLOR image results.
The SOP class and instance UID of the original image are correctly stored in the (0008,2112) sequence, and a new Instance UID is generated as described in the UIDs section.
If the image is not associated with a DicomViewer, then WholeImage is regarded as TRUE, irrespective of the value given, as the “displayed” size could not be calculated.