33 #include "dcmtk/config/osconfig.h" 34 #include "dcmtk/dcmdata/dctk.h" 36 #include "dcmtk/ofstd/ofstring.h" 37 #include "dcmtk/dcmpstat/dvpstyp.h" 38 #include "dcmtk/dcmpstat/dvpsovl.h" 39 #include "dcmtk/dcmpstat/dvpsgll.h" 40 #include "dcmtk/dcmpstat/dvpsrsl.h" 41 #include "dcmtk/dcmpstat/dvpsall.h" 42 #include "dcmtk/dcmpstat/dvpsgal.h" 43 #include "dcmtk/dcmpstat/dvpscul.h" 44 #include "dcmtk/dcmpstat/dvpsvll.h" 45 #include "dcmtk/dcmpstat/dvpsvwl.h" 46 #include "dcmtk/dcmpstat/dvpsdal.h" 47 #include "dcmtk/dcmpstat/dvpssvl.h" 48 #include "dcmtk/dcmpstat/dvpspl.h" 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);
155 const char *aetitle=NULL,
156 const char *filesetID=NULL,
157 const char *filesetUID=NULL);
166 const char *studyUID,
167 const char *seriesUID,
168 const char *instanceUID);
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);
645 const char *gLayerDescription=NULL);
the list of displayed area selections contained in a presentation state (internal use only)...
a class representing the DICOM value representation 'Integer String' (IS)
DcmTime presentationCreationTime
Module=Presentation_State, VR=TM, VM=1, Type 1.
DVPSPresentationLUTType getPresentationLUT()
gets the current Presentation LUT type.
a class representing a list of DICOM elements in which each element has a different tag and elements ...
OFBool useShutterRectangular
if true, a rectangular shutter is in use
the list of graphic layers contained in a presentation state (internal use only). ...
DVPSGraphicAnnotation_PList graphicAnnotationList
GraphicAnnotationSequence, Module=Graphic_Annotation.
DcmIntegerString verticesOfThePolygonalShutter
Module=Display_Shutter, VR=IS, VM=2-2n, Type 1C.
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
a class representing the DICOM value representation 'Decimal String' (DS)
DcmDate studyDate
Module=General_Study, VR=DA, VM=1, Type 2.
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.
a class representing the DICOM value representation 'Unique Identifier' (UI)
a class representing the DICOM value representation 'Person Name' (PN)
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.
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.
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.
DcmUnsignedShort shutterOverlayGroup
Module=Bitmap_Display_Shutter, VR=US, VM=1, Type 1.
DVPScharacterSet getCharset()
gets the specific character set for this presentation state.
DcmDate instanceCreationDate
Module=SOP_Common, VR=DA, VM=1, Type 3.
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).
DcmCodeString specificCharacterSet
Module=SOP_Common, VR=CS, VM=1-n, Type 1C.
DVPSReferencedSeries_PList referencedSeriesList
ReferencedSeriesSequence, Module=Presentation_State.
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.
DcmIntegerString shutterRightVerticalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
DcmIntegerString radiusOfCircularShutter
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
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.
DcmCodeString shutterShape
Module=Display_Shutter, VM=CS, VR=1-3, Type 1.
DcmPersonName presentationCreatorsName
Module=Presentation_State, VR=PN, VM=1, Type 2.
DcmShortString accessionNumber
Module=General_Study, VR=SH, VM=1, Type 2.
Sint32 getRectShutterRV()
gets rectangular shutter right vertical edge.
DcmLongString patientID
Module=Patient, VR=LO, VM=1, Type 2.
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.
a class representing the DICOM value representation 'Date' (DA)
the list of curve and overlay activation layers contained in a presentation state (internal use only)...
DcmUnsignedShort modalityLUTData
Module=Modality_LUT, VR=xs, VM=1-n, Type 1c.
OFBool useModalityLUT
if true, a modality LUT is set
const char * getPresentationLUTExplanation()
returns the LUT explanation of the presentation LUT if it exists and is non-empty.
DcmLongString presentationDescription
Module=Presentation_State, VR=LO, VM=1, Type 2.
DVPSPresentationLUT * getPresentationLUTData()
gets the current Presentation LUT object.
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.
DcmIntegerString shutterUpperHorizontalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
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.
DVPSPresentationLUT presentationLUT
Module=Softcopy_Presentation_LUT, VR=SQ, Card=1, Type 1C.
size_t getNumberOfGraphicLayers()
returns the number of graphic layers.
OFBool useModalityRescale
if true, a modality rescale slope/intercept is set
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
DcmPersonName referringPhysicianName
Module=General_Study, VR=PN, VM=1, Type 2.
DcmDecimalString rescaleIntercept
Module=Modality_LUT, VR=DS, VM=1, Type 1c.
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)
DVPSSoftcopyVOI_PList softcopyVOIList
Module=Softcopy_VOI_LUT, VR=SQ, Card=1-n, Type 1.
DcmIntegerString centerOfCircularShutter
Module=Display_Shutter, VR=IS, VM=2, Type 1C.
a class representing the DICOM value representation 'Code String' (CS)
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.
const char * getInstanceUID()
returns the current SOP Instance UID for the Presentation State.
DcmDecimalString rescaleSlope
Module=Modality_LUT, VR=DS, VM=1, Type 1c.
DcmIntegerString seriesNumber
Module=General_Series, VR=IS, VM=1, Type 2.
const char * getCurrentPresentationLUTExplanation()
gets a description of the current presentation LUT.
DcmIntegerString shutterLowerHorizontalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
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
DcmCodeString imageHorizontalFlip
Module=Spatial_Transform, VR=CS, VM=1, Type 1.
DVPSOverlayCurveActivationLayer_PList activationLayerList
Overlay/Curve Activation Layer(s), Module=Overlay_Activation/Curve_Activation.
a class representing the DICOM value representation 'Time' (TM)
a class representing the DICOM value representation 'Short String' (SH)
OFCondition setPresentationCreatorsName(const char *name)
sets the presentation state creator's name.
DcmIntegerString shutterLeftVerticalEdge
Module=Display_Shutter, VR=IS, VM=1, Type 1C.
OFBool useShutterBitmap
if true, a bitmap shutter is in use
an item of the graphic object sequence in a presentation state (internal use only).
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.
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)
an item of the displayed area selection sequence in a presentation state.
DVPSRotationType getRotation()
gets the current rotation status of the presentation state.
the representation of one item of the Softcopy VOI LUT Sequence
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).
DcmIntegerString imageNumber
Module=Presentation_State, VR=IS, VM=1, Type 1.
Sint32 getCenterOfCircularShutter_x()
gets circular shutter center x component.
DVPSDisplayedArea_PList displayedAreaSelectionList
Module=Displayed_Area, VR=SQ, Card=1-n, Type 1.
DcmShortString studyID
Module=General_Study, VR=SH, VM=1, Type 2.
the list of softcopy VOI LUT items contained in a presentation state (internal use only)...
DVPSPresentationLUTType getType()
gets the current Presentation LUT type.
the list of referenced series contained in a presentation state (internal use only).
OFCondition getPolyShutterVertex(size_t idx, Sint32 &x, Sint32 &y)
get polygonal shutter point.
DcmLongString modalityLUTType
Module=Modality_LUT, VR=LO, VM=1, Type 3.
the representation of one Curve in a DICOM image.
DcmUniqueIdentifier seriesInstanceUID
Module=General_Series, VR=UI, VM=1, Type 1.
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.
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)
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.
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).
OFBool havePresentationLookupTable()
checks if a real Presentation LUT (not shape) is available in the presentation state.
OFCondition setCharset(DVPScharacterSet charset)
sets the specific character set for this presentation state.
DcmTime instanceCreationTime
Module=SOP_Common, VR=TM, VM=1, Type 3.
void clear()
resets the object to initial state.
DcmCodeString patientSex
Module=Patient, VR=CS, VM=1, Type 2.
DcmPresentationState & operator=(const DcmPresentationState &obj)
private undefined assignment operator
DcmUniqueIdentifier studyInstanceUID
Module=General_Study, VR=UI, VM=1, Type 1.
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.
const char * getOverlayInPresentationStateDescription(size_t idx)
gets the overlay description of the given overlay in the presentation state.
General purpose class for condition codes.
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.
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.