/usr/include/dcmtk/dcmpstat/dvpsga.h is in libdcmtk2-dev 3.6.0-15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | /*
*
* Copyright (C) 1998-2010, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmpstat
*
* Author: Marco Eichelberg
*
* Purpose:
* classes: DVPSGraphicAnnotation
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:36 $
* CVS/RCS Revision: $Revision: 1.12 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DVPSGA_H
#define DVPSGA_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dcvrcs.h" /* for DcmCodeString */
#include "dcmtk/dcmpstat/dvpstxl.h" /* for DVPSTextObject_PList */
#include "dcmtk/dcmpstat/dvpsgrl.h" /* for DVPSGraphicObject_PList */
#include "dcmtk/dcmpstat/dvpsril.h" /* for DVPSReferencedImage_PList */
#include "dcmtk/dcmpstat/dvpstyp.h" /* for enum types */
/** an item of the graphic annotation sequence in a presentation state (internal use only).
* This class manages the data structures comprising one item
* of the Graphic Annotation Sequence in a Presentation State object.
*/
class DVPSGraphicAnnotation
{
public:
/// default constructor
DVPSGraphicAnnotation();
/// copy constructor
DVPSGraphicAnnotation(const DVPSGraphicAnnotation& copy);
/** clone method.
* @return a pointer to a new DVPSGraphicAnnotation object containing
* a deep copy of this object.
*/
DVPSGraphicAnnotation *clone() { return new DVPSGraphicAnnotation(*this); }
/// destructor
virtual ~DVPSGraphicAnnotation();
/** reads a graphic annotation from a DICOM dataset.
* The DICOM elements of the Graphic Annotation item are copied
* from the dataset to this object.
* The completeness of the item (presence of all required elements,
* value multiplicity) is checked.
* If this method returns an error code, the object is in undefined state afterwards.
* @param dset the item of the GraphicAnnotationSequence from which the data is to be read
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition read(DcmItem &dset);
/** writes the graphic annotation managed by this object to a DICOM dataset.
* Copies of the DICOM element managed by this object are inserted into
* the DICOM dataset.
* @param dset the the item of the GraphicAnnotationSequence to which the data is written
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition write(DcmItem &dset);
/** get annotation layer name.
* @return a pointer to the annotation layer name
*/
const char *getAnnotationLayer();
/** set annotation layer name of this annotation.
* @param aLayer a pointer to the annotation layer name, which is copied into this object.
*/
void setAnnotationLayer(const char *aLayer);
/** add a new image reference.
* Checks if the referenced SOP instance UID already exists in this sequence.
* If it exists, an error code is returned. Otherwise a new image reference
* is created and added to the ReferencedImageSequence.
* @param sopclassUID the SOP class UID of the image reference to be added.
* @param instanceUID the SOP instance UID of the image reference to be added.
* @param frame the frame number of the image reference (current image) to be added.
* @param applicability the applicability of the image reference (DVPSB_currentFrame or DVPSX_currentImage)
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition addImageReference(
const char *sopclassUID,
const char *instanceUID,
unsigned long frame,
DVPSObjectApplicability applicability);
/** checks if this annotation layer is empty.
* An annotation layer is empty when it contains no text object and no graphic object.
* @return OFTrue if empty.
*/
OFBool isEmpty();
/** checks if this annotation layer is applicable to the given image and frame.
* @param instanceUID SOP instance UID of the current image
* @param frame number of the current frame
* @param applicability the required (minimum) applicability of the reference. Default:
* annotation layer applies to the current frame of the current image.
* @return OFTrue if applicable.
*/
OFBool isApplicable(
const char *instanceUID,
unsigned long frame,
DVPSObjectApplicability applicability=DVPSB_currentFrame);
/** returns the number of text objects in this annotation.
* @return number of text objects
*/
size_t getNumberOfTextObjects();
/** returns the number of graphic objects in this annotation.
* @return number of graphic objects
*/
size_t getNumberOfGraphicObjects();
/** returns a pointer to the text object with the given
* index or NULL if it does not exist.
* @param idx index, must be < getNumberOfTextObjects()
* @return pointer to text object or NULL
*/
DVPSTextObject *getTextObject(size_t idx);
/** returns a pointer to the graphic object with the given
* index or NULL if it does not exist.
* @param idx index, must be < getNumberOfGraphicObjects()
* @return pointer to graphic object or NULL
*/
DVPSGraphicObject *getGraphicObject(size_t idx);
/** adds the given text object to
* the list of text objects managed by this object.
* @param text text object to be inserted.
*/
void addTextObject(DVPSTextObject *text);
/** adds the given graphic object to
* the list of graphic objects managed by this object.
* @param text graphic object to be inserted.
*/
void addGraphicObject(DVPSGraphicObject *graphic);
/** returns a pointer to the text object with the given
* index (or NULL if it does not exist) and removes it from the list.
* @param idx index, must be < getNumberOfTextObjects()
* @return pointer to text object or NULL
*/
DVPSTextObject *removeTextObject(size_t idx);
/** returns a pointer to the graphic object with the given
* index (or NULL if it does not exist) and removes it from the list.
* @param idx index, must be < getNumberOfGraphicObjects()
* @return pointer to graphic object or NULL
*/
DVPSGraphicObject *removeGraphicObject(size_t idx);
private:
/// private undefined assignment operator
DVPSGraphicAnnotation& operator=(const DVPSGraphicAnnotation&);
/// ReferencedImageSequence, Type 1c
DVPSReferencedImage_PList referencedImageList;
/// VR=CS, VM=1, Type 1
DcmCodeString graphicAnnotationLayer;
/// TextObjectSequence, Type 1c
DVPSTextObject_PList textObjectList;
/// GraphicObjectSequence, Type 1c
DVPSGraphicObject_PList graphicObjectList;
};
#endif
/*
* $Log: dvpsga.h,v $
* Revision 1.12 2010-10-14 13:16:36 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.11 2010-10-07 14:31:35 joergr
* Removed leading underscore characters from preprocessor symbols (reserved).
*
* Revision 1.10 2009-11-24 14:12:57 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.9 2009-09-30 10:42:38 uli
* Make dcmpstat's include headers self-sufficient by including all
* needed headers directly and stop using dctk.h
*
* Revision 1.8 2005-12-08 16:03:43 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.7 2001/09/26 15:36:10 meichel
* Adapted dcmpstat to class OFCondition
*
* Revision 1.6 2001/06/01 15:50:15 meichel
* Updated copyright header
*
* Revision 1.5 2000/06/02 16:00:45 meichel
* Adapted all dcmpstat classes to use OFConsole for log and error output
*
* Revision 1.4 2000/03/08 16:28:51 meichel
* Updated copyright header.
*
* Revision 1.3 1999/07/22 16:39:06 meichel
* Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
*
* Revision 1.2 1998/12/14 16:10:27 meichel
* Implemented Presentation State interface for graphic layers,
* text and graphic annotations, presentation LUTs.
*
* Revision 1.1 1998/11/27 14:50:26 meichel
* Initial Release.
*
*
*/
|