DcmPresentationState Class Reference

a Grayscale Softcopy Presentation State. More...

Inheritance diagram for DcmPresentationState:

DVPresentationState List of all members.

Public Member Functions

 DcmPresentationState ()
 default constructor
virtual ~DcmPresentationState ()
 destructor
OFCondition read (DcmItem &dset)
 reads a presentation state from a DICOM dataset.
OFCondition write (DcmItem &dset, OFBool replaceSOPInstanceUID)
 writes the presentation state managed by this object to a DICOM dataset.
const char * createInstanceUID ()
 generates a new SOP Instance UID for the Presentation State.
const char * getInstanceUID ()
 returns the current SOP Instance UID for the Presentation State.
const char * getSOPClassUID ()
 returns the (currently hard-coded) SOP Class UID of the Presentation State.
const char * getPatientID ()
 returns the patient ID of the presentation state
const char * getStudyUID ()
 returns the Study Instance UID of the presentation state.
OFCondition addImageReference (const char *studyUID, const char *seriesUID, const char *sopclassUID, const char *instanceUID, const char *frames=NULL, const char *aetitle=NULL, const char *filesetID=NULL, const char *filesetUID=NULL)
 adds a reference to an image to this presentation state.
OFCondition addImageReference (DcmItem &dset, const char *aetitle=NULL, const char *filesetID=NULL, const char *filesetUID=NULL)
 adds a reference to an image to this presentation state.
OFCondition removeImageReference (const char *studyUID, const char *seriesUID, const char *instanceUID)
 removes a reference to an image from this presentation state.
OFCondition removeImageReference (DcmItem &dset)
 removes a reference to an image from this presentation state.
size_t numberOfImageReferences ()
 gets the number of image references in all series managed by this list.
OFCondition getImageReference (size_t idx, OFString &studyUID, OFString &seriesUID, OFString &sopclassUID, OFString &instanceUID, OFString &frames, OFString &aetitle, OFString &filesetID, OFString &filesetUID)
 gets an image reference with the given index.
void clear ()
 resets the object to initial state.
OFCondition createFromImage (DcmItem &dset, DVPSoverlayActivation overlayActivation=DVPSO_copyOverlays, DVPSVOIActivation voiActivation=DVPSV_preferVOILUT, OFBool curveActivation=OFTrue, OFBool shutterActivation=OFTrue, OFBool presentationActivation=OFTrue, DVPSGraphicLayering layering=DVPSG_twoLayers, const char *aetitle=NULL, const char *filesetID=NULL, const char *filesetUID=NULL)
 creates a default presentation state for a DICOM image.
DVPSPresentationLUTType getPresentationLUT ()
 gets the current Presentation LUT type.
OFBool havePresentationLookupTable ()
 checks if a real Presentation LUT (not shape) is available in the presentation state.
const char * getCurrentPresentationLUTExplanation ()
 gets a description of the current presentation LUT.
const char * getPresentationLUTExplanation ()
 returns the LUT explanation of the presentation LUT if it exists and is non-empty.
DVPSPresentationLUT * getPresentationLUTData ()
 gets the current Presentation LUT object.
DVPSRotationType getRotation ()
 gets the current rotation status of the presentation state.
OFBool getFlip ()
 gets the current horizontal flip status of the presentation state.
OFCondition setRotation (DVPSRotationType rotation)
 sets rotation status of the presentation state.
OFCondition setFlip (OFBool isFlipped)
 sets horizontal flip status of the presentation state.
OFBool haveShutter (DVPSShutterType type)
 checks if a display shutter of given type is active.
Sint32 getRectShutterLV ()
 gets rectangular shutter left vertical edge.
Sint32 getRectShutterRV ()
 gets rectangular shutter right vertical edge.
Sint32 getRectShutterUH ()
 gets rectangular shutter upper horitontal edge.
Sint32 getRectShutterLH ()
 gets rectangular shutter lower horiztonal edge.
Sint32 getCenterOfCircularShutter_x ()
 gets circular shutter center x component.
Sint32 getCenterOfCircularShutter_y ()
 gets circular shutter center y component.
Sint32 getRadiusOfCircularShutter ()
 gets circular shutter radius.
size_t getNumberOfPolyShutterVertices ()
 gets polygonal shutter number of points.
OFCondition getPolyShutterVertex (size_t idx, Sint32 &x, Sint32 &y)
 get polygonal shutter point.
OFCondition setPolyShutterOrigin (Sint32 x, Sint32 y)
 sets polygonal display shutter origin.
Uint16 getShutterPresentationValue ()
 gets the shutter presentation value.
OFCondition setShutterPresentationValue (Uint16 pvalue)
 sets the shutter presentation value to the given P-value.
const char * getPresentationLabel ()
 returns a label for the presentation state.
const char * getPresentationDescription ()
 returns a description for the presentation state.
const char * getPresentationCreatorsName ()
 returns the creator's name for the presentation state.
OFCondition setPresentationLabel (const char *label)
 sets the presentation state label.
OFCondition setPresentationDescription (const char *descr)
 sets the presentation state description.
OFCondition setPresentationCreatorsName (const char *name)
 sets the presentation state creator's name.
OFCondition setCharset (DVPScharacterSet charset)
 sets the specific character set for this presentation state.
DVPScharacterSet getCharset ()
 gets the specific character set for this presentation state.
const char * getCharsetString ()
 gets the specific character set string for this presentation state.
void sortGraphicLayers ()
 sorts the graphic layers according to the graphic layer order.
size_t getNumberOfGraphicLayers ()
 returns the number of graphic layers.
const char * getGraphicLayerName (size_t idx)
 gets the unique name of the graphic layer with the given index.
size_t getGraphicLayerIndex (const char *name)
 gets the index of the graphic layer with the given unique name.
const char * getGraphicLayerDescription (size_t idx)
 gets a description string for the graphic layer with the given index.
OFBool haveGraphicLayerRecommendedDisplayValue (size_t idx)
 checks whether a recommended display value (grayscale, color or both) for the given graphic layer exists.
OFCondition getGraphicLayerRecommendedDisplayValueGray (size_t idx, Uint16 &gray)
 gets the recommended grayscale display value for the given graphic layer.
OFCondition getGraphicLayerRecommendedDisplayValueRGB (size_t idx, Uint16 &r, Uint16 &g, Uint16 &b)
 gets the recommended RGB display value for the given graphic layer.
OFCondition setGraphicLayerRecommendedDisplayValueGray (size_t idx, Uint16 gray)
 set graphic layer recommended grayscale display value for the given graphic layer.
OFCondition setGraphicLayerRecommendedDisplayValueRGB (size_t idx, Uint16 r, Uint16 g, Uint16 b)
 set graphic layer recommended RGB display value for the given graphic layer.
void removeGraphicLayerRecommendedDisplayValue (size_t idx, OFBool rgb, OFBool monochrome)
 removes recommended display values for the given graphic layer.
OFCondition setGraphicLayerName (size_t idx, const char *name)
 assigns a new unique name to the given graphic layer.
OFCondition setGraphicLayerDescription (size_t idx, const char *descr)
 sets a new description to the given graphic layer.
OFCondition toFrontGraphicLayer (size_t idx)
 makes a graphic layer the highest layer for display.
OFCondition toBackGraphicLayer (size_t idx)
 makes a graphic layer the lowest layer for display.
OFCondition exchangeGraphicLayers (size_t idx1, size_t idx2)
 exchanges the layer order of the two graphic layers with the given indices.
OFCondition addGraphicLayer (const char *gLayer, const char *gLayerDescription=NULL)
 creates a new graphic layer with the given name and optional description.
size_t getNumberOfCurves (size_t layer)
 returns the number of curve activations for the given graphic layer.
OFCondition removeCurve (size_t layer, size_t idx)
 deletes the curve activation with the given index on the given layer.
OFCondition moveCurve (size_t old_layer, size_t idx, size_t new_layer)
 moves the curve activation with the given index on the given layer to a different layer.
size_t getNumberOfActiveOverlays (size_t layer)
 gets the number of overlays that are currently activated on the given graphic layer.
Uint16 getActiveOverlayGroup (size_t layer, size_t idx)
 gets the repeating group number of the given activated overlay.
size_t getNumberOfOverlaysInPresentationState ()
 gets the number of overlays which are embedded in the presentation state.
Uint16 getOverlayInPresentationStateGroup (size_t idx)
 gets the repeating group number of the given overlay in the presentation state.
const char * getOverlayInPresentationStateLabel (size_t idx)
 gets the overlay label of the given overlay in the presentation state.
const char * getOverlayInPresentationStateDescription (size_t idx)
 gets the overlay description of the given overlay in the presentation state.
size_t getOverlayInPresentationStateActivationLayer (size_t idx)
 gets the index of the activation layer on which the given overlay from the presentation state is activated.
OFBool overlayIsBitmapShutter (size_t idx)
 checks if the given overlay in the presentation state is currently activated as a bitmap shutter.
OFBool overlayInPresentationStateIsROI (size_t idx)
 checks whether the given overlay in the presentation state is a ROI (region of interest) overlay.
OFCondition moveOverlay (size_t old_layer, size_t idx, size_t new_layer)
 moves the overlay activation with the given index on the given layer to a different layer.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Protected Member Functions

OFCondition createDefaultDisplayedArea (DcmItem &dset)
 creates a default displayed area selection for the given dataset.

Protected Attributes

DcmPersonName patientName
 Module=Patient, VR=PN, VM=1, Type 1.
DcmLongString patientID
 Module=Patient, VR=LO, VM=1, Type 2.
DcmDate patientBirthDate
 Module=Patient, VR=DA, VM=1, Type 2.
DcmCodeString patientSex
 Module=Patient, VR=CS, VM=1, Type 2.
DcmUniqueIdentifier studyInstanceUID
 Module=General_Study, VR=UI, VM=1, Type 1.
DcmDate studyDate
 Module=General_Study, VR=DA, VM=1, Type 2.
DcmTime studyTime
 Module=General_Study, VR=TM, VM=1, Type 2.
DcmPersonName referringPhysiciansName
 Module=General_Study, VR=PN, VM=1, Type 2.
DcmShortString studyID
 Module=General_Study, VR=SH, VM=1, Type 2.
DcmShortString accessionNumber
 Module=General_Study, VR=SH, VM=1, Type 2.
DcmUniqueIdentifier seriesInstanceUID
 Module=General_Series, VR=UI, VM=1, Type 1.
DcmIntegerString seriesNumber
 Module=General_Series, VR=IS, VM=1, Type 2.
DcmLongString manufacturer
 Module=General_Equipment, VR=LO, VM=1, Type 2.
DVPSDisplayedArea_PList displayedAreaSelectionList
DVPSPresentationLUT presentationLUT
DcmIntegerString imageNumber
 Module=Presentation_State, VR=IS, VM=1, Type 1.
DcmCodeString presentationLabel
 Module=Presentation_State, VR=CS, VM=1, Type 1.
DcmLongString presentationDescription
 Module=Presentation_State, VR=LO, VM=1, Type 2.
DcmDate presentationCreationDate
 Module=Presentation_State, VR=DA, VM=1, Type 1.
DcmTime presentationCreationTime
 Module=Presentation_State, VR=TM, VM=1, Type 1.
DcmPersonName presentationCreatorsName
 Module=Presentation_State, VR=PN, VM=1, Type 2.
DVPSReferencedSeries_PList referencedSeriesList
 ReferencedSeriesSequence, Module=Presentation_State.
DcmUniqueIdentifier sOPInstanceUID
 Module=SOP_Common, VR=UI, VM=1, Type 1.
DcmCodeString specificCharacterSet
 Module=SOP_Common, VR=CS, VM=1-n, Type 1C.
DcmDate instanceCreationDate
 Module=SOP_Common, VR=DA, VM=1, Type 3.
DcmTime instanceCreationTime
 Module=SOP_Common, VR=TM, VM=1, Type 3.
DcmUniqueIdentifier instanceCreatorUID
 Module=SOP_Common, VR=UI, VM=1, Type 3.
OFBool useShutterRectangular
 if true, a rectangular shutter is in use
OFBool useShutterCircular
 if true, a circular shutter is in use
OFBool useShutterPolygonal
 if true, a polygonal shutter is in use
OFBool useShutterBitmap
 if true, a bitmap shutter is in use
DcmCodeString shutterShape
 Module=Display_Shutter, VM=CS, VR=1-3, Type 1.
DcmIntegerString shutterLeftVerticalEdge
 Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString shutterRightVerticalEdge
 Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString shutterUpperHorizontalEdge
 Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString shutterLowerHorizontalEdge
 Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString centerOfCircularShutter
 Module=Display_Shutter, VR=IS, VM=2, Type 1C.
DcmIntegerString radiusOfCircularShutter
 Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString verticesOfThePolygonalShutter
 Module=Display_Shutter, VR=IS, VM=2-2n, Type 1C.
DcmUnsignedShort shutterPresentationValue
 Module=Display_Shutter, VR=US, VM=1, Type 3 (1c in other modules).
DcmUnsignedShort shutterOverlayGroup
 Module=Bitmap_Display_Shutter, VR=US, VM=1, Type 1.
DVPSOverlay_PList overlayList
 Overlay(s), Module=Overlay_Plane.
DVPSOverlayCurveActivationLayer_PList activationLayerList
 Overlay/Curve Activation Layer(s), Module=Overlay_Activation/Curve_Activation.
DVPSGraphicAnnotation_PList graphicAnnotationList
 GraphicAnnotationSequence, Module=Graphic_Annotation.
DcmUnsignedShort imageRotation
 Module=Spatial_Transform, VR=US, VM=1, Type 1.
DcmCodeString imageHorizontalFlip
 Module=Spatial_Transform, VR=CS, VM=1, Type 1.
DVPSGraphicLayer_PList graphicLayerList
 GraphicLayerSequence, Module=Graphic_Layer.
OFBool useModalityRescale
 if true, a modality rescale slope/intercept is set
OFBool useModalityLUT
 if true, a modality LUT is set
DcmUnsignedShort modalityLUTDescriptor
 Module=Modality_LUT, VR=xs, VM=3, Type 1c.
DcmLongString modalityLUTExplanation
 Module=Modality_LUT, VR=LO, VM=1, Type 3.
DcmLongString modalityLUTType
 Module=Modality_LUT, VR=LO, VM=1, Type 3.
DcmUnsignedShort modalityLUTData
 Module=Modality_LUT, VR=xs, VM=1-n, Type 1c.
DcmDecimalString rescaleIntercept
 Module=Modality_LUT, VR=DS, VM=1, Type 1c.
DcmDecimalString rescaleSlope
 Module=Modality_LUT, VR=DS, VM=1, Type 1c.
DcmLongString rescaleType
 Module=Modality_LUT, VR=LO, VM=1, Type 1c.
DVPSSoftcopyVOI_PList softcopyVOIList
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

Private Member Functions

 DcmPresentationState (const DcmPresentationState &copy)
 private undefined copy constructor
DcmPresentationState & operator= (const DcmPresentationState &obj)
 private undefined assignment operator
OFCondition createDummyValues (OFBool replaceSOPInstanceUID)
 create dummy values for all missing type 1 elements.
void cleanupLayers ()
 removes and deletes all graphic layer for which no matching text, graphic, curve or overlay object exists.

Detailed Description

a Grayscale Softcopy Presentation State.

This class manages the data structures comprising a Presentation State object. Presentation states can be created, read, written, and modified.

Definition at line 65 of file dcmpstat.h.

Member Function Documentation

OFCondition DcmPresentationState::addGraphicLayer (  const char *  gLayer,
const char *  gLayerDescription = NULL
) 
 

creates a new graphic layer with the given name and optional description.

The new name must be unique, otherwise an error code is returned. The toFrontGraphicLayer() method is implicitly called for the new layer.

Parameters:
gLayer the name of the graphic layer. Must be a valid DICOM Code String.
gLayerDescription the optional description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::addImageReference (  DcmItem &  dset,
const char *  aetitle = NULL,
const char *  filesetID = NULL,
const char *  filesetUID = NULL
) 
 

adds a reference to an image to this presentation state.

This method checks if the given SOP class and Study UID match for this presentation state and returns an error code otherwise.

Parameters:
dset the DICOM dataset containing the image IOD
aetitle the series retrieveAETitle. Must be a valid DICOM 'AE' value. Default: value absent.
filesetID the series storageMediaFileSetID. Must be a valid DICOM 'SH' value. Default: value absent.
filesetUID the series storageMediaFileSetUID. Must be a valid DICOM UID. Default: value absent.
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::addImageReference (  const char *  studyUID,
const char *  seriesUID,
const char *  sopclassUID,
const char *  instanceUID,
const char *  frames = NULL,
const char *  aetitle = NULL,
const char *  filesetID = NULL,
const char *  filesetUID = NULL
) 
 

adds a reference to an image to this presentation state.

This method checks if the given SOP class and Study UID match for this presentation state and returns an error code otherwise.

Parameters:
studyUID the Study Instance UID of the image reference to be added.
seriesUID the Series Instance UID of the image reference to be added.
sopclassUID the SOP class UID of the image reference to be added.
instanceUID the SOP instance UID of the image reference to be added.
frames a list of frame numbers in DICOM IS format (integer numbers separated by '\' characters). Default: frame numbers absent. The frame numbers are required if the referenced image is a multiframe image.
aetitle the series retrieveAETitle. Must be a valid DICOM 'AE' value. Default: value absent.
filesetID the series storageMediaFileSetID. Must be a valid DICOM 'SH' value. Default: value absent.
filesetUID the series storageMediaFileSetUID. Must be a valid DICOM UID. Default: value absent.
Returns:
EC_Normal if successful, an error code otherwise.

void DcmPresentationState::cleanupLayers (   )  [private]
 

removes and deletes all graphic layer for which no matching text, graphic, curve or overlay object exists.

Also deletes all graphic annotation sequence items containing no text and no graphic object. Called before writing a presentation state.

void DcmPresentationState::clear (   ) 
 

resets the object to initial state.

After this call, the object is in the same state as after creation with the default constructor.

Reimplemented in DVPresentationState.

OFCondition DcmPresentationState::createDefaultDisplayedArea (  DcmItem &  dset  )  [protected]
 

creates a default displayed area selection for the given dataset.

Used in createFromImage().

Parameters:
dset the DICOM dataset containing the image IOD
Returns:
EC_Normal upon success, an error code otherwise.

OFCondition DcmPresentationState::createDummyValues (  OFBool  replaceSOPInstanceUID  )  [private]
 

create dummy values for all missing type 1 elements.

Called before a presentation state is written to make sure that the presentation state is complete.

Parameters:
replaceSOPInstanceUID flag indicating whether the SOP Instance UID should be replaced by a new UID. If true, a new UID is always generated. If false, a new UID is generated only if no UID has been assigned before.
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::createFromImage (  DcmItem &  dset,
DVPSoverlayActivation  overlayActivation = DVPSO_copyOverlays,
DVPSVOIActivation  voiActivation = DVPSV_preferVOILUT,
OFBool  curveActivation = OFTrue,
OFBool  shutterActivation = OFTrue,
OFBool  presentationActivation = OFTrue,
DVPSGraphicLayering  layering = DVPSG_twoLayers,
const char *  aetitle = NULL,
const char *  filesetID = NULL,
const char *  filesetUID = NULL
) 
 

creates a default presentation state for a DICOM image.

A number of flags specify how curves, overlays, VOI transformations, a display shutter and a presentation LUT shape should be treated when found in the image IOD. If this method returns an error code, the object is in undefined state afterwards.

Parameters:
dset the DICOM dataset containing the image IOD
overlayActivation flag defining how overlays should be handled (copied, activated or ignored). Default: Copy overlays.
voiActivation flag defining how VOI LUTs or VOI window width/center should be handled. Default: Use VOI and prefer VOI LUT from VOI window.
curveActivation flag defining whether curves in the image should be activated. Default: Activate curves.
shutterActivation flag defining whether a shutter (not bitmap shutter) should be copied to the presentation state when found in the image. Default: Copy shutter.
presentationActivation flag defining whether a presentation LUT shape should be copied to the presentation state when found in the image. Default: Copy presentation LUT shape.
layering flag defining how graphic layers should be created for activated overlays and curves. Default: Create one layer for all overlays and another layer for all curves.
aetitle the series retrieveAETitle. Must be a valid DICOM 'AE' value. Default: value absent.
filesetID the series storageMediaFileSetID. Must be a valid DICOM 'SH' value. Default: value absent.
filesetUID the series storageMediaFileSetUID. Must be a valid DICOM UID. Default: value absent.
Returns:
EC_Normal upon success, an error code otherwise.

Reimplemented in DVPresentationState.

const char* DcmPresentationState::createInstanceUID (   ) 
 

generates a new SOP Instance UID for the Presentation State.

Returns:
new SOP Instance UID if successfully set, NULL otherwise.

OFCondition DcmPresentationState::exchangeGraphicLayers (  size_t  idx1,
size_t  idx2
) 
 

exchanges the layer order of the two graphic layers with the given indices.

This method does not sort or renumber the graphic layers.

Parameters:
idx1 index of the first graphic layer, must be < getNumberOfGraphicLayers()
idx2 index of the second graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

Uint16 DcmPresentationState::getActiveOverlayGroup (  size_t  layer,
size_t  idx
) 
 

gets the repeating group number of the given activated overlay.

Parameters:
layer index of the graphic layer, must be < getNumberOfGraphicLayers()
idx index of the overlay, must be < getNumberOfActiveOverlays().
Returns:
repeating group number if found, 0 otherwise.

Sint32 DcmPresentationState::getCenterOfCircularShutter_x (   ) 
 

gets circular shutter center x component.

May only be called if a circular shutter is active.

Returns:
the circ shutter center x component

Sint32 DcmPresentationState::getCenterOfCircularShutter_y (   ) 
 

gets circular shutter center y component.

May only be called if a circular shutter is active.

Returns:
the circ shutter center y component

DVPScharacterSet DcmPresentationState::getCharset (   ) 
 

gets the specific character set for this presentation state.

Returns:
character set identifier

const char* DcmPresentationState::getCharsetString (   ) 
 

gets the specific character set string for this presentation state.

Returns:
character set if present, NULL otherwise

const char* DcmPresentationState::getCurrentPresentationLUTExplanation (   )  [inline]
 

gets a description of the current presentation LUT.

For well-known presentation LUT shapes, a standard text is returned. For presentation LUTs, the LUT explanation is returned if it exists and a standard text otherwise. This method never returns NULL.

Returns:
a pointer to a string describing the current presentation LUT.

Definition at line 275 of file dcmpstat.h.

References DVPSPresentationLUT::getCurrentExplanation(), and presentationLUT.

OFBool DcmPresentationState::getFlip (   ) 
 

gets the current horizontal flip status of the presentation state.

Returns:
OFTrue if flip is on, OFFalse if flip is off.

const char* DcmPresentationState::getGraphicLayerDescription (  size_t  idx  ) 
 

gets a description string for the graphic layer with the given index.

If no layer for the given index exists, or if the description is empty, NULL is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
description of the graphic layer

size_t DcmPresentationState::getGraphicLayerIndex (  const char *  name  ) 
 

gets the index of the graphic layer with the given unique name.

If no matching layer is found, DVPS_IDX_NONE is returned.

Parameters:
name name of the graphic layer
Returns:
index of the graphic layer

const char* DcmPresentationState::getGraphicLayerName (  size_t  idx  ) 
 

gets the unique name of the graphic layer with the given index.

If no layer for the given index exists, NULL is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
name of the graphic layer

OFCondition DcmPresentationState::getGraphicLayerRecommendedDisplayValueGray (  size_t  idx,
Uint16 &  gray
) 
 

gets the recommended grayscale display value for the given graphic layer.

If the graphic layer contains an RGB display value but no grayscale display value, the RGB value is implicitly converted to grayscale.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
gray the recommended display value as an unsigned 16-bit P-value is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::getGraphicLayerRecommendedDisplayValueRGB (  size_t  idx,
Uint16 &  r,
Uint16 &  g,
Uint16 &  b
) 
 

gets the recommended RGB display value for the given graphic layer.

If the graphic layer contains a grayscale display value but no RGB display value, the grayscale value is implicitly converted to RGB.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
r returns the R component of the recommended display value as unsigned 16-bit P-value
g returns the G component of the recommended display value as unsigned 16-bit P-value
b returns the B component of the recommended display value as unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::getImageReference (  size_t  idx,
OFString &  studyUID,
OFString &  seriesUID,
OFString &  sopclassUID,
OFString &  instanceUID,
OFString &  frames,
OFString &  aetitle,
OFString &  filesetID,
OFString &  filesetUID
) 
 

gets an image reference with the given index.

Parameters:
idx index, must be < numberOfImageReferences().
studyUID the Study Instance UID is returned in this string
seriesUID the Series Instance UID is returned in this string
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
aetitle the series retrieveAETitle is returned in this string
filesetID the series storageMediaFileSetID is returned in this string
filesetUID the series storageMediaFileSetUID is returned in this string
Returns:
EC_Normal if successful, an error code otherwise.

const char* DcmPresentationState::getInstanceUID (   ) 
 

returns the current SOP Instance UID for the Presentation State.

Returns:
SOP Instance UID if present, NULL otherwise.

size_t DcmPresentationState::getNumberOfActiveOverlays (  size_t  layer  ) 
 

gets the number of overlays that are currently activated on the given graphic layer.

Parameters:
layer index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of active overlays

size_t DcmPresentationState::getNumberOfCurves (  size_t  layer  ) 
 

returns the number of curve activations for the given graphic layer.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of curves

size_t DcmPresentationState::getNumberOfGraphicLayers (   ) 
 

returns the number of graphic layers.

Returns:
number of graphic layers

size_t DcmPresentationState::getNumberOfOverlaysInPresentationState (   ) 
 

gets the number of overlays which are embedded in the presentation state.

Returns:
number of overlays in presentation state

size_t DcmPresentationState::getNumberOfPolyShutterVertices (   ) 
 

gets polygonal shutter number of points.

May only be called if a polygonal shutter is active.

Returns:
the number of points describing the poly shutter

size_t DcmPresentationState::getOverlayInPresentationStateActivationLayer (  size_t  idx  ) 
 

gets the index of the activation layer on which the given overlay from the presentation state is activated.

If an overlay is used as a bitmap shutter, it is reported as being not activated by this method.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
layer index (which is < getNumberOfGraphicLayers()) if overlay exists and is activated, DVPS_IDX_NONE otherwise.

const char* DcmPresentationState::getOverlayInPresentationStateDescription (  size_t  idx  ) 
 

gets the overlay description of the given overlay in the presentation state.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
description string if it exists, NULL otherwise.

Uint16 DcmPresentationState::getOverlayInPresentationStateGroup (  size_t  idx  ) 
 

gets the repeating group number of the given overlay in the presentation state.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
repeating group number if found, 0 otherwise.

const char* DcmPresentationState::getOverlayInPresentationStateLabel (  size_t  idx  ) 
 

gets the overlay label of the given overlay in the presentation state.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
label string if it exists, NULL otherwise.

OFCondition DcmPresentationState::getPolyShutterVertex (  size_t  idx,
Sint32 &  x,
Sint32 &  y
) 
 

get polygonal shutter point.

May only be called if a polygonal shutter is active. Shutter points are relative to the origin 1 which is the left upper edge of the image.

Parameters:
idx the index of the shutter point, must be < getNumberOfPolyShutterVertices()
x returns the x component of the point
y returns the y component of the point
Returns:
EC_Normal upon success, an error code otherwise.

const char* DcmPresentationState::getPresentationCreatorsName (   ) 
 

returns the creator's name for the presentation state.

If no name is available, NULL is returned.

Returns:
a pointer to a string or NULL.

const char* DcmPresentationState::getPresentationDescription (   ) 
 

returns a description for the presentation state.

If no description is available, NULL is returned.

Returns:
a pointer to a string or NULL.

const char* DcmPresentationState::getPresentationLabel (   ) 
 

returns a label for the presentation state.

If no label is available, NULL is returned.

Returns:
a pointer to a string or NULL.

DVPSPresentationLUTType DcmPresentationState::getPresentationLUT (   )  [inline]
 

gets the current Presentation LUT type.

Returns:
the current presentation LUT type

Definition at line 258 of file dcmpstat.h.

References DVPSPresentationLUT::getType(), and presentationLUT.

DVPSPresentationLUT* DcmPresentationState::getPresentationLUTData (   )  [inline]
 

gets the current Presentation LUT object.

Returns:
the current presentation LUT object

Definition at line 287 of file dcmpstat.h.

References presentationLUT.

const char* DcmPresentationState::getPresentationLUTExplanation (   )  [inline]
 

returns the LUT explanation of the presentation LUT if it exists and is non-empty.

Otherwise returns NULL.

Returns:
a string pointer

Definition at line 282 of file dcmpstat.h.

References DVPSPresentationLUT::getLUTExplanation(), and presentationLUT.

Sint32 DcmPresentationState::getRadiusOfCircularShutter (   ) 
 

gets circular shutter radius.

May only be called if a circular shutter is active. Note: In DICOM, a circular shutter must be rendered with consideration of the image pixel aspect ratio. The radius returned by this method is the number of pixels describing a horizontal line from the center of the circle to its border. See sample figures in NEMA PS3.3:1998.

Returns:
the circ shutter radius

Sint32 DcmPresentationState::getRectShutterLH (   ) 
 

gets rectangular shutter lower horiztonal edge.

May only be called if a rectangular shutter is active.

Returns:
the rect shutter LH edge.

Sint32 DcmPresentationState::getRectShutterLV (   ) 
 

gets rectangular shutter left vertical edge.

May only be called if a rectangular shutter is active.

Returns:
the rect shutter LV edge.

Sint32 DcmPresentationState::getRectShutterRV (   ) 
 

gets rectangular shutter right vertical edge.

May only be called if a rectangular shutter is active.

Returns:
the rect shutter RV edge.

Sint32 DcmPresentationState::getRectShutterUH (   ) 
 

gets rectangular shutter upper horitontal edge.

May only be called if a rectangular shutter is active.

Returns:
the rect shutter UH edge.

DVPSRotationType DcmPresentationState::getRotation (   ) 
 

gets the current rotation status of the presentation state.

Returns:
the current rotation status

Uint16 DcmPresentationState::getShutterPresentationValue (   ) 
 

gets the shutter presentation value.

If no shutter display value exists, a default of 0 (black) is set.

Returns:
the shutter presentation value as 16bit unsigned P-value

const char* DcmPresentationState::getSOPClassUID (   ) 
 

returns the (currently hard-coded) SOP Class UID of the Presentation State.

Returns:
SOP Class UID of the presentation state

const char* DcmPresentationState::getStudyUID (   ) 
 

returns the Study Instance UID of the presentation state.

Returns:
Study Instance UID if successful, NULL otherwise.

OFBool DcmPresentationState::haveGraphicLayerRecommendedDisplayValue (  size_t  idx  ) 
 

checks whether a recommended display value (grayscale, color or both) for the given graphic layer exists.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
OFTrue if a recommended display value exists

OFBool DcmPresentationState::havePresentationLookupTable (   )  [inline]
 

checks if a real Presentation LUT (not shape) is available in the presentation state.

Returns:
OFTrue if the presentation state contains a presentation LUT, no matter if it is activated or not. Returns OFFalse otherwise.

Definition at line 266 of file dcmpstat.h.

References DVPSPresentationLUT::haveTable(), and presentationLUT.

OFBool DcmPresentationState::haveShutter (  DVPSShutterType  type  ) 
 

checks if a display shutter of given type is active.

Parameters:
type the shutter type
Returns:
OFTrue if this type of shutter is currently active.

OFCondition DcmPresentationState::moveCurve (  size_t  old_layer,
size_t  idx,
size_t  new_layer
) 
 

moves the curve activation with the given index on the given layer to a different layer.

Parameters:
old_layer index of the graphic layer on which the curve is, must be < getNumberOfGraphicLayers()
idx index of the curve activation, must be < getNumberOfCurves(layer)
new_layer index of the graphic layer to which the curve is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::moveOverlay (  size_t  old_layer,
size_t  idx,
size_t  new_layer
) 
 

moves the overlay activation with the given index on the given layer to a different layer.

Parameters:
old_layer index of the graphic layer on which the curve is, must be < getNumberOfGraphicLayers()
idx index of the overlay activation, must be < getNumberOfActiveOverlays(layer)
new_layer index of the graphic layer to which the curve is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

size_t DcmPresentationState::numberOfImageReferences (   ) 
 

gets the number of image references in all series managed by this list.

Returns:
number of image references

OFBool DcmPresentationState::overlayInPresentationStateIsROI (  size_t  idx  ) 
 

checks whether the given overlay in the presentation state is a ROI (region of interest) overlay.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
OFTrue if overlay exists and is ROI, OFFalse otherwise.

OFBool DcmPresentationState::overlayIsBitmapShutter (  size_t  idx  ) 
 

checks if the given overlay in the presentation state is currently activated as a bitmap shutter.

Parameters:
idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
OFTrue if overlay exists and is activated as bitmap shutter, OFFalse otherwise.

OFCondition DcmPresentationState::read (  DcmItem &  dset  ) 
 

reads a presentation state from a DICOM dataset.

The DICOM elements of the presentation state are copied from the dataset to this object. The completeness and correctness of the presentation state (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 dataset from which the presentation state is to be read
Returns:
EC_Normal if successful, an error code otherwise.

Reimplemented in DVPresentationState.

OFCondition DcmPresentationState::removeCurve (  size_t  layer,
size_t  idx
) 
 

deletes the curve activation with the given index on the given layer.

Parameters:
layer index of the graphic layer, must be < getNumberOfGraphicLayers()
idx index of the curve activation, must be < getNumberOfCurves(layer)
Returns:
EC_Normal upon success, an error code otherwise

void DcmPresentationState::removeGraphicLayerRecommendedDisplayValue (  size_t  idx,
OFBool  rgb,
OFBool  monochrome
) 
 

removes recommended display values for the given graphic layer.

Parameters:
rgb if true, the RGB recommended display value is removed
monochrome if true the monochrome recommended display value is removed

OFCondition DcmPresentationState::removeImageReference (  DcmItem &  dset  ) 
 

removes a reference to an image from this presentation state.

Parameters:
dset the DICOM dataset containing the image IOD
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::removeImageReference (  const char *  studyUID,
const char *  seriesUID,
const char *  instanceUID
) 
 

removes a reference to an image from this presentation state.

Parameters:
studyUID the Study Instance UID of the image reference to be removed.
seriesUID the Series Instance UID of the image reference to be removed.
instanceUID the SOP instance UID of the image reference to be removed.
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::setCharset (  DVPScharacterSet  charset  ) 
 

sets the specific character set for this presentation state.

Parameters:
charset the new character set for this text object
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::setFlip (  OFBool  isFlipped  ) 
 

sets horizontal flip status of the presentation state.

Parameters:
isFlipped the flip status, OFTrue for on, OFFalse for off.
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::setGraphicLayerDescription (  size_t  idx,
const char *  descr
) 
 

sets a new description to the given graphic layer.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
descr description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::setGraphicLayerName (  size_t  idx,
const char *  name
) 
 

assigns a new unique name to the given graphic layer.

The new name must be unique, otherwise an error code is returned. Upon success, all references (for graphic annotations, curves and overlays) to the given graphic layer are also renamed so that the presentation state remains consistent.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
name the new name of the graphic layer. Must be a valid DICOM Code String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::setGraphicLayerRecommendedDisplayValueGray (  size_t  idx,
Uint16  gray
) 
 

set graphic layer recommended grayscale display value for the given graphic layer.

This method does not affect (set or modify) the recommended RGB display value which should be set separately.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
gray the recommended display value as an unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::setGraphicLayerRecommendedDisplayValueRGB (  size_t  idx,
Uint16  r,
Uint16  g,
Uint16  b
) 
 

set graphic layer recommended RGB display value for the given graphic layer.

This method does not affect (set or modify) the recommended grayscale display value which should be set separately.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
r the R component of the recommended display value as unsigned 16-bit P-value
g the G component of the recommended display value as unsigned 16-bit P-value
b the B component of the recommended display value as unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

void DcmPresentationState::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

Reimplemented in DVPresentationState.

OFCondition DcmPresentationState::setPolyShutterOrigin (  Sint32  x,
Sint32  y
) 
 

sets polygonal display shutter origin.

This method creates a polygonal shutter consisting only of a single point. The polygonal display shutter is deactivated after this method.

Parameters:
x the x component of the shutter origin
y the x component of the shutter origin
Returns:
EC_Normal upon success, an error code otherwise.

OFCondition DcmPresentationState::setPresentationCreatorsName (  const char *  name  ) 
 

sets the presentation state creator's name.

The passed string must be a valid DICOM Person Name String (see NEMA PS3.5:1998).

Parameters:
name the new creator's name
Returns:
EC_Normal upon success, an error code otherwise.

OFCondition DcmPresentationState::setPresentationDescription (  const char *  descr  ) 
 

sets the presentation state description.

The passed string must be a valid DICOM Long String (i.e. max 64 characters, no backslash or control chars).

Parameters:
descr the new presentation state description
Returns:
EC_Normal upon success, an error code otherwise.

OFCondition DcmPresentationState::setPresentationLabel (  const char *  label  ) 
 

sets the presentation state label.

The passed string must be a valid DICOM Code String (i.e. max 16 characters, only uppercase and numbers).

Parameters:
label the new presentation state label
Returns:
EC_Normal upon success, an error code otherwise.

OFCondition DcmPresentationState::setRotation (  DVPSRotationType  rotation  ) 
 

sets rotation status of the presentation state.

Parameters:
rotation the rotation to be set
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DcmPresentationState::setShutterPresentationValue (  Uint16  pvalue  ) 
 

sets the shutter presentation value to the given P-value.

Parameters:
pvalue the shutter presentation value.
Returns:
EC_Normal upon success, an error code otherwise.

void DcmPresentationState::sortGraphicLayers (   ) 
 

sorts the graphic layers according to the graphic layer order.

Layers with lower order have lower indices after sorting which means that the layers can be drawn to the screen in ascending index order. Calling this routine may result in a re-numbering of the graphic layer orders in a way that does not affect their sequence.

OFCondition DcmPresentationState::toBackGraphicLayer (  size_t  idx  ) 
 

makes a graphic layer the lowest layer for display.

This method assigns a graphic layer order lower than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index 0.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::toFrontGraphicLayer (  size_t  idx  ) 
 

makes a graphic layer the highest layer for display.

This method assigns a graphic layer order higher than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index (getNumberOfGraphicLayers()-1).

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmPresentationState::write (  DcmItem &  dset,
OFBool  replaceSOPInstanceUID
) 
 

writes the presentation state managed by this object to a DICOM dataset.

Copies of the DICOM elements managed by this object are inserted into the DICOM dataset.

Parameters:
dset the dataset to which the presentation state is written
replaceSOPInstanceUID flag indicating whether the SOP Instance UID should be replaced by a new UID. If true, a new UID is always generated. If false, a new UID is generated only if no UID has been assigned before.
Returns:
EC_Normal if successful, an error code otherwise.

The documentation for this class was generated from the following file:

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5