preparePresStateMetadata Method

Prepares Presentation State metadata based on current image display settings and annotations.

Syntax

public static ImGearMetadataHead preparePresStateMetadata( 
   ImGearRasterPage page,
   IImGearPageDisplay pageDisplay,
   ImGearMetadataHead userMetadata,
   ImGearPresStateOptions options
)

Parameters

page: Page from which presentation state settings shall be extracted.
pageDisplay: PageDisplay from which presentation state settings shall be extracted.
userMetadata: User supplied metadata.
options: Options structure telling which settings shall be extracted to the presentation state metadata.

Return Value

New instance of com.accusoft.imagegear.core.ImGearMetadataTree class object, containing presentation state metadata.

This method prepares metadata for a presentation state object, based on page's DICOMDisplaySettings member, on pageDisplay settings, and on annotations that are attached to image, if any.

After that presentation state metadata has been prepared, application may add or edit it, and then save as presentation state object using method.

The following features of the ImGearDICOMDisplaySettings class are saved to presentation state metadata:

VOI LUT
Modality LUT
Presentation LUT

The following settings of pageDisplay are saved to presentation state metadata:

Orientation
Image rectangle

The following annotations are saved to saved to presentation state metadata: Text, Callout, Polygon, Polyline, Point, Curve, Ellipse.

This method takes user metadata as a parameter. If this parameter is not null and contains a DICOM metadata tree, the method will use it as a base for building output metadata.

com.accusoft.imagegear.core.ImGearRasterPageT:com.accusoft.imagegear.formats.dicom.ImGearPresStateOptionsT:com.accusoft.imagegear.core.ImGearMetadataTree

Reference

ImGearDICOM Class
ImGearDICOM Members