OFFIS DCMTK  Version 3.6.0
dcmpstat.h
1 /*
2  *
3  * Copyright (C) 1998-2010, OFFIS e.V.
4  * All rights reserved. See COPYRIGHT file for details.
5  *
6  * This software and supporting documentation were developed by
7  *
8  * OFFIS e.V.
9  * R&D Division Health
10  * Escherweg 2
11  * D-26121 Oldenburg, Germany
12  *
13  *
14  * Module: dcmpstat
15  *
16  * Author: Marco Eichelberg
17  *
18  * Purpose:
19  * classes: DcmPresentationState
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:35 $
23  * CVS/RCS Revision: $Revision: 1.7 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 #ifndef DCMPSTAT_H
31 #define DCMPSTAT_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 #include "dcmtk/dcmdata/dctk.h"
35 
36 #include "dcmtk/ofstd/ofstring.h" /* for class OFString */
37 #include "dcmtk/dcmpstat/dvpstyp.h" /* for enum types */
38 #include "dcmtk/dcmpstat/dvpsovl.h" /* for DVPSOverlay_PList */
39 #include "dcmtk/dcmpstat/dvpsgll.h" /* for DVPSGraphicLayer_PList */
40 #include "dcmtk/dcmpstat/dvpsrsl.h" /* for DVPSReferencedSeries_PList */
41 #include "dcmtk/dcmpstat/dvpsall.h" /* for DVPSOverlayCurveActivationLayer_PList */
42 #include "dcmtk/dcmpstat/dvpsgal.h" /* for DVPSGraphicObject_PList */
43 #include "dcmtk/dcmpstat/dvpscul.h" /* for DVPSCurve_PList */
44 #include "dcmtk/dcmpstat/dvpsvll.h" /* for DVPSVOILUT_PList */
45 #include "dcmtk/dcmpstat/dvpsvwl.h" /* for DVPSVOIWindow_PList */
46 #include "dcmtk/dcmpstat/dvpsdal.h" /* for DVPSDisplayedArea_PList */
47 #include "dcmtk/dcmpstat/dvpssvl.h" /* for DVPSSoftcopyVOI_PList */
48 #include "dcmtk/dcmpstat/dvpspl.h" /* for DVPSPresentationLUT */
49 
50 class DVPSTextObject;
51 class DVPSGraphicObject;
52 class DVPSCurve;
53 class DVPSDisplayedArea;
54 class DVPSSoftcopyVOI;
55 
62 {
63 public:
67 
69  virtual ~DcmPresentationState();
70 
81  OFCondition read(DcmItem &dset);
82 
93  OFCondition write(DcmItem &dset, OFBool replaceSOPInstanceUID);
94 
98  const char *createInstanceUID();
99 
103  const char *getInstanceUID();
104 
108  const char *getSOPClassUID();
109 
112  const char *getPatientID();
113 
117  const char *getStudyUID();
118 
135  const char *studyUID,
136  const char *seriesUID,
137  const char *sopclassUID,
138  const char *instanceUID,
139  const char *frames=NULL,
140  const char *aetitle=NULL,
141  const char *filesetID=NULL,
142  const char *filesetUID=NULL);
143 
154  DcmItem &dset,
155  const char *aetitle=NULL,
156  const char *filesetID=NULL,
157  const char *filesetUID=NULL);
158 
166  const char *studyUID,
167  const char *seriesUID,
168  const char *instanceUID);
169 
175 
179  size_t numberOfImageReferences();
180 
194  size_t idx,
195  OFString& studyUID,
196  OFString& seriesUID,
197  OFString& sopclassUID,
198  OFString& instanceUID,
199  OFString& frames,
200  OFString& aetitle,
201  OFString& filesetID,
202  OFString& filesetUID);
203 
204 
209  void clear();
210 
238  DVPSoverlayActivation overlayActivation = DVPSO_copyOverlays,
239  DVPSVOIActivation voiActivation = DVPSV_preferVOILUT,
240  OFBool curveActivation = OFTrue,
241  OFBool shutterActivation = OFTrue,
242  OFBool presentationActivation = OFTrue,
243  DVPSGraphicLayering layering = DVPSG_twoLayers,
244  const char * aetitle = NULL,
245  const char * filesetID = NULL,
246  const char * filesetUID = NULL);
247 
248 
249  /* Presentation LUT Interface */
250 
254  DVPSPresentationLUTType getPresentationLUT() { return presentationLUT.getType(); }
255 
263 
272 
279 
284 
285  /* Rotate/Flip Interface */
286 
290  DVPSRotationType getRotation();
291 
295  OFBool getFlip();
296 
301  OFCondition setRotation(DVPSRotationType rotation);
302 
307  OFCondition setFlip(OFBool isFlipped);
308 
309 
310  /* VOI Transform Interface */
311 
312  /* Displayed Area Interface */
313 
314 
315  /* shutter Interface */
316 
321  OFBool haveShutter(DVPSShutterType type);
322 
323  /* rectangular shutter Interface */
324 
329  Sint32 getRectShutterLV();
330 
335  Sint32 getRectShutterRV();
336 
341  Sint32 getRectShutterUH();
342 
347  Sint32 getRectShutterLH();
348 
349 
350  /* circular shutter Interface */
351 
357 
363 
375 
376  /* polygonal shutter Interface */
377 
383 
393  OFCondition getPolyShutterVertex(size_t idx, Sint32& x, Sint32& y);
394 
403  OFCondition setPolyShutterOrigin(Sint32 x, Sint32 y);
404 
405  /* bitmap shutter Interface
406  *
407  * see methods:
408  * overlayIsBitmapShutter(),
409  * overlayIsSuitableAsBitmapShutter(),
410  * activateOverlayAsBitmapShutter()
411  * in overlay interface definitions.
412  */
413 
414  /* shutter presentation value Interface */
415 
421 
427 
428  /* Presentation State Label, Description and Name Interface */
429 
434  const char *getPresentationLabel();
435 
440  const char *getPresentationDescription();
441 
446  const char *getPresentationCreatorsName();
447 
454  OFCondition setPresentationLabel(const char *label);
455 
462  OFCondition setPresentationDescription(const char *descr);
463 
470  OFCondition setPresentationCreatorsName(const char *name);
471 
472  /* specific character set */
473 
478  OFCondition setCharset(DVPScharacterSet charset);
479 
483  DVPScharacterSet getCharset();
484 
488  const char *getCharsetString();
489 
490  /* graphic layers */
491 
500  void sortGraphicLayers();
501 
505  size_t getNumberOfGraphicLayers();
506 
513  const char *getGraphicLayerName(size_t idx);
514 
521  size_t getGraphicLayerIndex(const char *name);
522 
523 
530  const char *getGraphicLayerDescription(size_t idx);
531 
536  OFBool haveGraphicLayerRecommendedDisplayValue(size_t idx);
537 
547 
557  OFCondition getGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16& r, Uint16& g, Uint16& b);
558 
567 
577  OFCondition setGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16 r, Uint16 g, Uint16 b);
578 
584  void removeGraphicLayerRecommendedDisplayValue(size_t idx, OFBool rgb, OFBool monochrome);
585 
595  OFCondition setGraphicLayerName(size_t idx, const char *name);
596 
602  OFCondition setGraphicLayerDescription(size_t idx, const char *descr);
603 
613  OFCondition toFrontGraphicLayer(size_t idx);
614 
623  OFCondition toBackGraphicLayer(size_t idx);
624 
632  OFCondition exchangeGraphicLayers(size_t idx1, size_t idx2);
633 
644  const char *gLayer,
645  const char *gLayerDescription=NULL);
646 
647 
648  /* text objects */
649 
650  /* graphic objects */
651 
652  /* curves */
653 
659  size_t getNumberOfCurves(size_t layer);
660 
667  OFCondition removeCurve(size_t layer, size_t idx);
668 
678  OFCondition moveCurve(size_t old_layer, size_t idx, size_t new_layer);
679 
680 
681  /* overlays */
682 
688  size_t getNumberOfActiveOverlays(size_t layer);
689 
695  Uint16 getActiveOverlayGroup(size_t layer, size_t idx);
696 
702 
707  Uint16 getOverlayInPresentationStateGroup(size_t idx);
708 
713  const char *getOverlayInPresentationStateLabel(size_t idx);
714 
719  const char *getOverlayInPresentationStateDescription(size_t idx);
720 
729 
735  OFBool overlayIsBitmapShutter(size_t idx);
736 
742  OFBool overlayInPresentationStateIsROI(size_t idx);
743 
753  OFCondition moveOverlay(size_t old_layer, size_t idx, size_t new_layer);
754 
755  /* attached image */
756 
757  /* Display transform */
758 
759  /* print related methods */
760 
761 private:
762 
766 
770 
780  OFCondition createDummyValues(OFBool replaceSOPInstanceUID);
781 
787  void cleanupLayers();
788 
789 protected:
790 
797 
798  /* Module: Patient (M)
799  */
808 
809  /* Module: General Study (M)
810  */
823 
824  /* Module: General Series (M)
825  */
830 
831  /* Module: Presentation Series (M) - specializes general series
832  */
833  // modality; see General Series
834 
835  /* Module: General Equipment (M)
836  */
839 
840  /* Module: Displayed Area (M)
841  */
844 
845  /* Module: Softcopy Presentation LUT (M)
846  * There must never be more that one Presentation LUT for one Presentation State,
847  * therefore we need not save a list of LUTs.
848  */
851 
852  /* Module: Presentation State (M)
853  * specializes mask and display shutter
854  */
869  // shutterPresentationValue; Type 1c. See Display Shutter module
870 
871  /* Module: SOP Common (M)
872  * we don't store the SOP Class UID because it is well known.
873  */
884 
885  /* Module: Display Shutter (C)
886  * "required if display shutter to be applied and BitmapDispShutter not present"
887  */
914 
915  /* Module: Bitmap Display Shutter (C)
916  * "required if display shutter to be applied and DispShutter not present"
917  */
920  // shutterPresentationValue already defined in Display Shutter module
921  // shutterShape already defined in Display Shutter module
922 
923  /* Module: Overlay Plane (C)
924  * "required if overlay to be applied or BitmapDispShutter present"
925  */
928 
929  /* Module: Overlay/Curve Activation (C)
930  * "required if ref. image contains overlay or curve to be displayed"
931  */
934 
935  /* Module: Graphic Annotation (C)
936  * "required if graphical annotation to be applied"
937  */
940 
941  /* Module: Spatial Transformation (C)
942  * "required if rotation/flipping/magnification to be applied"
943  */
948 
949  /* Module: Graphic Layer (C)
950  * "required if graphic annotation, overlays or curves to be applied"
951  */
954 
955  /* Module: Modality LUT (C)
956  * "required if modality LUT to be applied"
957  * There must never be more that one Modality LUT for one Presentation State,
958  * therefore we need not save a list of LUTs.
959  */
978 
979  /* Module: Softcopy VOI LUT (C)
980  * "required if VOI LUT to be applied"
981  */
984 
985 };
986 
987 #endif
988 
989 /*
990  * $Log: dcmpstat.h,v $
991  * Revision 1.7 2010-10-14 13:16:35 joergr
992  * Updated copyright header. Added reference to COPYRIGHT file.
993  *
994  * Revision 1.6 2010-10-07 14:31:35 joergr
995  * Removed leading underscore characters from preprocessor symbols (reserved).
996  *
997  * Revision 1.5 2010-08-09 13:20:50 joergr
998  * Updated data dictionary to 2009 edition of the DICOM standard. From now on,
999  * the official "keyword" is used for the attribute name which results in a
1000  * number of minor changes (e.g. "PatientsName" is now called "PatientName").
1001  *
1002  * Revision 1.4 2009-11-24 14:12:57 uli
1003  * Switched to logging mechanism provided by the "new" oflog module.
1004  *
1005  * Revision 1.3 2009-05-28 10:40:20 joergr
1006  * Fixed various Doxygen API documentation issues.
1007  *
1008  * Revision 1.2 2005/12/08 16:03:29 meichel
1009  * Changed include path schema for all DCMTK header files
1010  *
1011  * Revision 1.1 2003/08/27 14:57:19 meichel
1012  * Splitted class DVPresentationState into a base class DcmPresentationState
1013  * that does not depend on module dcmimgle and current derived class with
1014  * public API identical to the previous version.
1015  *
1016  *
1017  */
the list of displayed area selections contained in a presentation state (internal use only)...
Definition: dvpsdal.h:45
a class representing the DICOM value representation 'Integer String' (IS)
Definition: dcvris.h:39
DcmTime presentationCreationTime
Module=Presentation_State, VR=TM, VM=1, Type 1.
Definition: dcmpstat.h:864
DVPSPresentationLUTType getPresentationLUT()
gets the current Presentation LUT type.
Definition: dcmpstat.h:254
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
OFBool useShutterRectangular
if true, a rectangular shutter is in use
Definition: dcmpstat.h:889
the list of graphic layers contained in a presentation state (internal use only). ...
Definition: dvpsgll.h:45
DVPSGraphicAnnotation_PList graphicAnnotationList
GraphicAnnotationSequence, Module=Graphic_Annotation.
Definition: dcmpstat.h:939
DcmIntegerString verticesOfThePolygonalShutter
Module=Display_Shutter, VR=IS, VM=2-2n, Type 1C.
Definition: dcmpstat.h:911
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.
OFBool useShutterPolygonal
if true, a polygonal shutter is in use
Definition: dcmpstat.h:893
a class representing the DICOM value representation 'Decimal String' (DS)
Definition: dcvrds.h:41
DcmDate studyDate
Module=General_Study, VR=DA, VM=1, Type 2.
Definition: dcmpstat.h:814
OFBool haveGraphicLayerRecommendedDisplayValue(size_t idx)
checks whether a recommended display value (grayscale, color or both) for the given graphic layer exi...
DVPSOverlay_PList overlayList
Overlay(s), Module=Overlay_Plane.
Definition: dcmpstat.h:927
a class representing the DICOM value representation 'Unique Identifier' (UI)
Definition: dcvrui.h:39
a class representing the DICOM value representation 'Person Name' (PN)
Definition: dcvrpn.h:40
size_t getNumberOfActiveOverlays(size_t layer)
gets the number of overlays that are currently activated on the given graphic layer.
DcmTime studyTime
Module=General_Study, VR=TM, VM=1, Type 2.
Definition: dcmpstat.h:816
size_t getNumberOfCurves(size_t layer)
returns the number of curve activations for the given graphic layer.
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.
Sint32 getRectShutterUH()
gets rectangular shutter upper horitontal edge.
OFCondition setPolyShutterOrigin(Sint32 x, Sint32 y)
sets polygonal display shutter origin.
size_t numberOfImageReferences()
gets the number of image references in all series managed by this list.
DcmCodeString presentationLabel
Module=Presentation_State, VR=CS, VM=1, Type 1.
Definition: dcmpstat.h:858
size_t getNumberOfOverlaysInPresentationState()
gets the number of overlays which are embedded in the presentation state.
Uint16 getActiveOverlayGroup(size_t layer, size_t idx)
gets the repeating group number of the given activated overlay.
a Grayscale Softcopy Presentation State.
Definition: dcmpstat.h:61
DcmUnsignedShort shutterOverlayGroup
Module=Bitmap_Display_Shutter, VR=US, VM=1, Type 1.
Definition: dcmpstat.h:919
DVPScharacterSet getCharset()
gets the specific character set for this presentation state.
DcmDate instanceCreationDate
Module=SOP_Common, VR=DA, VM=1, Type 3.
Definition: dcmpstat.h:879
const char * getOverlayInPresentationStateLabel(size_t idx)
gets the overlay label of the given overlay in the presentation state.
const char * getGraphicLayerDescription(size_t idx)
gets a description string for the graphic layer with the given index.
OFBool haveTable()
checks if a real Presentation LUT (not shape) is available.
OFCondition getGraphicLayerRecommendedDisplayValueGray(size_t idx, Uint16 &gray)
gets the recommended grayscale display value for the given graphic layer.
an item of the text object sequence in a presentation state (internal use only).
Definition: dvpstx.h:43
DcmCodeString specificCharacterSet
Module=SOP_Common, VR=CS, VM=1-n, Type 1C.
Definition: dcmpstat.h:877
DVPSReferencedSeries_PList referencedSeriesList
ReferencedSeriesSequence, Module=Presentation_State.
Definition: dcmpstat.h:868
OFCondition toBackGraphicLayer(size_t idx)
makes a graphic layer the lowest layer for display.
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...
DcmUnsignedShort imageRotation
Module=Spatial_Transform, VR=US, VM=1, Type 1.
Definition: dcmpstat.h:945
DcmIntegerString shutterRightVerticalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
Definition: dcmpstat.h:901
DcmIntegerString radiusOfCircularShutter
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
Definition: dcmpstat.h:909
OFBool overlayInPresentationStateIsROI(size_t idx)
checks whether the given overlay in the presentation state is a ROI (region of interest) overlay...
OFCondition setGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16 r, Uint16 g, Uint16 b)
set graphic layer recommended RGB display value for the given graphic layer.
DcmUnsignedShort modalityLUTDescriptor
Module=Modality_LUT, VR=xs, VM=3, Type 1c.
Definition: dcmpstat.h:965
DcmCodeString shutterShape
Module=Display_Shutter, VM=CS, VR=1-3, Type 1.
Definition: dcmpstat.h:897
DcmPersonName presentationCreatorsName
Module=Presentation_State, VR=PN, VM=1, Type 2.
Definition: dcmpstat.h:866
DcmShortString accessionNumber
Module=General_Study, VR=SH, VM=1, Type 2.
Definition: dcmpstat.h:822
Sint32 getRectShutterRV()
gets rectangular shutter right vertical edge.
DcmLongString patientID
Module=Patient, VR=LO, VM=1, Type 2.
Definition: dcmpstat.h:803
Sint32 getCenterOfCircularShutter_y()
gets circular shutter center y component.
virtual ~DcmPresentationState()
destructor
OFCondition setRotation(DVPSRotationType rotation)
sets rotation status of the presentation state.
OFCondition setFlip(OFBool isFlipped)
sets horizontal flip status of the presentation state.
OFCondition setGraphicLayerDescription(size_t idx, const char *descr)
sets a new description to the given graphic layer.
DcmUniqueIdentifier sOPInstanceUID
Module=SOP_Common, VR=UI, VM=1, Type 1.
Definition: dcmpstat.h:875
a class representing the DICOM value representation 'Date' (DA)
Definition: dcvrda.h:40
the list of curve and overlay activation layers contained in a presentation state (internal use only)...
Definition: dvpsall.h:49
DcmUnsignedShort modalityLUTData
Module=Modality_LUT, VR=xs, VM=1-n, Type 1c.
Definition: dcmpstat.h:971
OFBool useModalityLUT
if true, a modality LUT is set
Definition: dcmpstat.h:963
const char * getPresentationLUTExplanation()
returns the LUT explanation of the presentation LUT if it exists and is non-empty.
Definition: dcmpstat.h:278
DcmLongString presentationDescription
Module=Presentation_State, VR=LO, VM=1, Type 2.
Definition: dcmpstat.h:860
DVPSPresentationLUT * getPresentationLUTData()
gets the current Presentation LUT object.
Definition: dcmpstat.h:283
Uint16 getOverlayInPresentationStateGroup(size_t idx)
gets the repeating group number of the given overlay in the presentation state.
OFCondition read(DcmItem &dset)
reads a presentation state from a DICOM dataset.
DcmLongString rescaleType
Module=Modality_LUT, VR=LO, VM=1, Type 1c.
Definition: dcmpstat.h:977
DcmIntegerString shutterUpperHorizontalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
Definition: dcmpstat.h:903
const char * getSOPClassUID()
returns the (currently hard-coded) SOP Class UID of the Presentation State.
OFCondition removeCurve(size_t layer, size_t idx)
deletes the curve activation with the given index on the given layer.
const char * getPresentationCreatorsName()
returns the creator's name for the presentation state.
Sint32 getRectShutterLV()
gets rectangular shutter left vertical edge.
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...
OFCondition setPresentationDescription(const char *descr)
sets the presentation state description.
DcmDate presentationCreationDate
Module=Presentation_State, VR=DA, VM=1, Type 1.
Definition: dcmpstat.h:862
DVPSPresentationLUT presentationLUT
Module=Softcopy_Presentation_LUT, VR=SQ, Card=1, Type 1C.
Definition: dcmpstat.h:850
size_t getNumberOfGraphicLayers()
returns the number of graphic layers.
OFBool useModalityRescale
if true, a modality rescale slope/intercept is set
Definition: dcmpstat.h:961
OFCondition exchangeGraphicLayers(size_t idx1, size_t idx2)
exchanges the layer order of the two graphic layers with the given indices.
OFCondition createDummyValues(OFBool replaceSOPInstanceUID)
create dummy values for all missing type 1 elements.
OFBool useShutterCircular
if true, a circular shutter is in use
Definition: dcmpstat.h:891
DcmPersonName referringPhysicianName
Module=General_Study, VR=PN, VM=1, Type 2.
Definition: dcmpstat.h:818
DcmDecimalString rescaleIntercept
Module=Modality_LUT, VR=DS, VM=1, Type 1c.
Definition: dcmpstat.h:973
const char * getCurrentExplanation()
gets a description of the current presentation LUT.
Sint32 getRadiusOfCircularShutter()
gets circular shutter radius.
const char * getCharsetString()
gets the specific character set string for this presentation state.
a class representing the DICOM value representation 'Long String' (LO)
Definition: dcvrlo.h:40
DVPSSoftcopyVOI_PList softcopyVOIList
Module=Softcopy_VOI_LUT, VR=SQ, Card=1-n, Type 1.
Definition: dcmpstat.h:983
DcmIntegerString centerOfCircularShutter
Module=Display_Shutter, VR=IS, VM=2, Type 1C.
Definition: dcmpstat.h:907
a class representing the DICOM value representation 'Code String' (CS)
Definition: dcvrcs.h:40
OFCondition setGraphicLayerName(size_t idx, const char *name)
assigns a new unique name to the given graphic layer.
OFCondition write(DcmItem &dset, OFBool replaceSOPInstanceUID)
writes the presentation state managed by this object to a DICOM dataset.
size_t getNumberOfPolyShutterVertices()
gets polygonal shutter number of points.
DcmPresentationState()
default constructor
DcmPersonName patientName
Module=Patient, VR=PN, VM=1, Type 1.
Definition: dcmpstat.h:801
const char * getInstanceUID()
returns the current SOP Instance UID for the Presentation State.
DcmDecimalString rescaleSlope
Module=Modality_LUT, VR=DS, VM=1, Type 1c.
Definition: dcmpstat.h:975
DcmIntegerString seriesNumber
Module=General_Series, VR=IS, VM=1, Type 2.
Definition: dcmpstat.h:829
const char * getCurrentPresentationLUTExplanation()
gets a description of the current presentation LUT.
Definition: dcmpstat.h:271
DcmIntegerString shutterLowerHorizontalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
Definition: dcmpstat.h:905
const char * getPresentationLabel()
returns a label for the presentation state.
OFCondition createDefaultDisplayedArea(DcmItem &dset)
creates a default displayed area selection for the given dataset.
the representation of a Presentation LUT Content SQ item for Stored Print
Definition: dvpspl.h:48
DcmCodeString imageHorizontalFlip
Module=Spatial_Transform, VR=CS, VM=1, Type 1.
Definition: dcmpstat.h:947
DVPSOverlayCurveActivationLayer_PList activationLayerList
Overlay/Curve Activation Layer(s), Module=Overlay_Activation/Curve_Activation.
Definition: dcmpstat.h:933
a class representing the DICOM value representation 'Time' (TM)
Definition: dcvrtm.h:41
a class representing the DICOM value representation 'Short String' (SH)
Definition: dcvrsh.h:40
OFCondition setPresentationCreatorsName(const char *name)
sets the presentation state creator's name.
DcmIntegerString shutterLeftVerticalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
Definition: dcmpstat.h:899
OFBool useShutterBitmap
if true, a bitmap shutter is in use
Definition: dcmpstat.h:895
an item of the graphic object sequence in a presentation state (internal use only).
Definition: dvpsgr.h:43
size_t getOverlayInPresentationStateActivationLayer(size_t idx)
gets the index of the activation layer on which the given overlay from the presentation state is acti...
DcmDate patientBirthDate
Module=Patient, VR=DA, VM=1, Type 2.
Definition: dcmpstat.h:805
OFCondition addGraphicLayer(const char *gLayer, const char *gLayerDescription=NULL)
creates a new graphic layer with the given name and optional description.
a class representing the DICOM value representation 'Unsigned Short' (US)
Definition: dcvrus.h:40
an item of the displayed area selection sequence in a presentation state.
Definition: dvpsda.h:43
DVPSRotationType getRotation()
gets the current rotation status of the presentation state.
the representation of one item of the Softcopy VOI LUT Sequence
Definition: dvpssv.h:45
OFBool overlayIsBitmapShutter(size_t idx)
checks if the given overlay in the presentation state is currently activated as a bitmap shutter...
the list of overlays contained in a presentation state (internal use only).
Definition: dvpsovl.h:44
DcmIntegerString imageNumber
Module=Presentation_State, VR=IS, VM=1, Type 1.
Definition: dcmpstat.h:856
Sint32 getCenterOfCircularShutter_x()
gets circular shutter center x component.
DVPSDisplayedArea_PList displayedAreaSelectionList
Module=Displayed_Area, VR=SQ, Card=1-n, Type 1.
Definition: dcmpstat.h:843
DcmShortString studyID
Module=General_Study, VR=SH, VM=1, Type 2.
Definition: dcmpstat.h:820
the list of softcopy VOI LUT items contained in a presentation state (internal use only)...
Definition: dvpssvl.h:45
DVPSPresentationLUTType getType()
gets the current Presentation LUT type.
Definition: dvpspl.h:101
the list of referenced series contained in a presentation state (internal use only).
Definition: dvpsrsl.h:45
OFCondition getPolyShutterVertex(size_t idx, Sint32 &x, Sint32 &y)
get polygonal shutter point.
DcmLongString modalityLUTType
Module=Modality_LUT, VR=LO, VM=1, Type 3.
Definition: dcmpstat.h:969
the representation of one Curve in a DICOM image.
Definition: dvpscu.h:44
DcmUniqueIdentifier seriesInstanceUID
Module=General_Series, VR=UI, VM=1, Type 1.
Definition: dcmpstat.h:827
size_t getGraphicLayerIndex(const char *name)
gets the index of the graphic layer with the given unique name.
DcmUniqueIdentifier instanceCreatorUID
Module=SOP_Common, VR=UI, VM=1, Type 3.
Definition: dcmpstat.h:883
const char * getLUTExplanation()
returns the LUT explanation of the presentation LUT if it exists and is non-empty.
OFBool getFlip()
gets the current horizontal flip status of the presentation state.
DcmUnsignedShort shutterPresentationValue
Module=Display_Shutter, VR=US, VM=1, Type 3 (1c in other modules)
Definition: dcmpstat.h:913
const char * getPatientID()
returns the patient ID of the presentation state
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.
a simple string class that implements a subset of std::string.
Definition: ofstring.h:86
const char * getGraphicLayerName(size_t idx)
gets the unique name of the graphic layer with the given index.
the list of graphic annotations contained in a presentation state (internal use only).
Definition: dvpsgal.h:46
OFBool havePresentationLookupTable()
checks if a real Presentation LUT (not shape) is available in the presentation state.
Definition: dcmpstat.h:262
OFCondition setCharset(DVPScharacterSet charset)
sets the specific character set for this presentation state.
DcmTime instanceCreationTime
Module=SOP_Common, VR=TM, VM=1, Type 3.
Definition: dcmpstat.h:881
void clear()
resets the object to initial state.
DcmCodeString patientSex
Module=Patient, VR=CS, VM=1, Type 2.
Definition: dcmpstat.h:807
DcmPresentationState & operator=(const DcmPresentationState &obj)
private undefined assignment operator
DcmUniqueIdentifier studyInstanceUID
Module=General_Study, VR=UI, VM=1, Type 1.
Definition: dcmpstat.h:812
Uint16 getShutterPresentationValue()
gets the shutter presentation value.
const char * getStudyUID()
returns the Study Instance UID of the presentation state.
OFCondition setPresentationLabel(const char *label)
sets the presentation state label.
void cleanupLayers()
removes and deletes all graphic layer for which no matching text, graphic, curve or overlay object ex...
const char * getPresentationDescription()
returns a description for the presentation state.
OFCondition removeImageReference(const char *studyUID, const char *seriesUID, const char *instanceUID)
removes a reference to an image from this presentation state.
OFCondition getGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16 &r, Uint16 &g, Uint16 &b)
gets the recommended RGB display value for the given graphic layer.
OFCondition setShutterPresentationValue(Uint16 pvalue)
sets the shutter presentation value to the given P-value.
OFCondition setGraphicLayerRecommendedDisplayValueGray(size_t idx, Uint16 gray)
set graphic layer recommended grayscale display value for the given graphic layer.
void sortGraphicLayers()
sorts the graphic layers according to the graphic layer order.
OFCondition toFrontGraphicLayer(size_t idx)
makes a graphic layer the highest layer for display.
void removeGraphicLayerRecommendedDisplayValue(size_t idx, OFBool rgb, OFBool monochrome)
removes recommended display values for the given graphic layer.
DVPSGraphicLayer_PList graphicLayerList
GraphicLayerSequence, Module=Graphic_Layer.
Definition: dcmpstat.h:953
const char * getOverlayInPresentationStateDescription(size_t idx)
gets the overlay description of the given overlay in the presentation state.
General purpose class for condition codes.
Definition: ofcond.h:305
OFBool haveShutter(DVPSShutterType type)
checks if a display shutter of given type is active.
DcmLongString manufacturer
Module=General_Equipment, VR=LO, VM=1, Type 2.
Definition: dcmpstat.h:838
const char * createInstanceUID()
generates a new SOP Instance UID for the Presentation State.
Sint32 getRectShutterLH()
gets rectangular shutter lower horiztonal edge.
DcmLongString modalityLUTExplanation
Module=Modality_LUT, VR=LO, VM=1, Type 3.
Definition: dcmpstat.h:967


Generated on Wed Dec 28 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.8