/usr/include/dcmtk/dcmpstat/dvpstx.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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | /*
*
* 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: DVPSTextObject
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:37 $
* CVS/RCS Revision: $Revision: 1.11 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DVPSTX_H
#define DVPSTX_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dctk.h"
#include "dcmtk/dcmpstat/dvpstyp.h"
/** an item of the text object sequence in a presentation state (internal use only).
* This class manages the data structures comprising one item
* of the Text Object Sequence which is contained
* in the Graphic Annotation Sequence in a Presentation State object.
*/
class DVPSTextObject
{
public:
/// default constructor
DVPSTextObject();
/// copy constructor
DVPSTextObject(const DVPSTextObject& copy);
/** clone method.
* @return a pointer to a new DVPSTextObject object containing
* a copy of this object.
*/
DVPSTextObject *clone() { return new DVPSTextObject(*this); }
/// destructor
virtual ~DVPSTextObject();
/** reads a text object from a DICOM dataset.
* The DICOM elements of the Text Object 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 TextObjectSequence from which the data is to be read
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition read(DcmItem &dset);
/** writes the text object 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 TextObjectSequence to which the data is written
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition write(DcmItem &dset);
/** checks if this text object contains an anchor point.
* @return OFTrue if anchor point present
*/
OFBool haveAnchorPoint();
/** checks if this text object contains bounding box.
* @return OFTrue if bounding box present
*/
OFBool haveBoundingBox();
/** sets an anchor point for this text object.
* @param x anchor point X value
* @param y anchor point Y value
* @param unit anchor point annotation units (pixel/display)
* @param isVisible anchor point visibility
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setAnchorPoint(double x, double y, DVPSannotationUnit unit, OFBool isVisible);
/** sets bounding box for this text object.
* @param TLHC_x bounding box top-lefthand corner X value
* @param TLHC_x bounding box top-lefthand corner Y value
* @param BRHC_x bounding box bottom-righthand corner X value
* @param BRHC_x bounding box bottom-righthand corner Y value
* @param unit bounding box annotation units (pixel/display)
* @param justification bounding box horizontal justification (left/right/center)
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setBoundingBox(double TLHC_x, double TLHC_y, double BRHC_x,
double BRHC_y, DVPSannotationUnit unit, DVPSTextJustification justification);
/** assigns a new "unformatted text value" for this text object.
* @param text unformatted text value. Must not be NULL or empty string.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setText(const char *text);
/** removes any anchor point from the text object.
* Attention: A text object must always contain either anchor point, bounding box
* or both. This property is not asserted by the text object itself.
*/
void removeAnchorPoint();
/** removes any bounding box from the text object.
* Attention: A text object must always contain either anchor point, bounding box
* or both. This property is not asserted by the text object itself.
*/
void removeBoundingBox();
/** gets the unformatted text value for this text object.
* @return unformatted text value
*/
const char *getText();
/** gets the bounding box TLHC x value.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box TLHC x value
*/
double getBoundingBoxTLHC_x();
/** gets the bounding box TLHC y value.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box TLHC y value
*/
double getBoundingBoxTLHC_y();
/** gets the bounding box BRHC x value.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box BRHC x value
*/
double getBoundingBoxBRHC_x();
/** gets the bounding box BRHC y value.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box BRHC y value
*/
double getBoundingBoxBRHC_y();
/** gets the bounding box annotation units.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box annotation units
*/
DVPSannotationUnit getBoundingBoxAnnotationUnits();
/** gets the bounding box horizontal justification.
* May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
* @return bounding box horizontal justification
*/
DVPSTextJustification getBoundingBoxHorizontalJustification();
/** gets the anchor point x value.
* May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
* @return anchor point x value
*/
double getAnchorPoint_x();
/** gets the anchor point y value.
* May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
* @return anchor point y value
*/
double getAnchorPoint_y();
/** gets the anchor point visibility
* May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
* @return OFTrue if anchor point is visible
*/
OFBool anchorPointIsVisible();
/** gets the anchor point annotation units.
* May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
* @return anchor point annotation units
*/
DVPSannotationUnit getAnchorPointAnnotationUnits();
private:
/** private undefined assignment operator
*/
DVPSTextObject& operator=(const DVPSTextObject&);
/// VR=CS, VM=1, Type 1c
DcmCodeString boundingBoxAnnotationUnits;
/// VR=CS, VM=1, Type 1c
DcmCodeString anchorPointAnnotationUnits;
/// VR=ST, VM=1, Type 1
DcmShortText unformattedTextValue;
/// VR=FL, VM=2, Type 1c
DcmFloatingPointSingle boundingBoxTLHC;
/// VR=FL, VM=2, Type 1c
DcmFloatingPointSingle boundingBoxBRHC;
/// VR=CS, VM=1, Type 1c
DcmCodeString boundingBoxTextHorizontalJustification;
/// VR=FL, VM=2, Type 1c
DcmFloatingPointSingle anchorPoint;
/// VR=CS, VM=1, Type 1c
DcmCodeString anchorPointVisibility;
};
#endif
/*
* $Log: dvpstx.h,v $
* Revision 1.11 2010-10-14 13:16:37 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.10 2010-10-07 14:31:36 joergr
* Removed leading underscore characters from preprocessor symbols (reserved).
*
* Revision 1.9 2009-11-24 14:12:58 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.8 2005-12-08 16:04:08 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.7 2001/09/26 15:36:18 meichel
* Adapted dcmpstat to class OFCondition
*
* Revision 1.6 2001/06/01 15:50:24 meichel
* Updated copyright header
*
* Revision 1.5 2000/06/02 16:00:54 meichel
* Adapted all dcmpstat classes to use OFConsole for log and error output
*
* Revision 1.4 2000/03/08 16:28:58 meichel
* Updated copyright header.
*
* Revision 1.3 1999/07/22 16:39:14 meichel
* Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
*
* Revision 1.2 1998/12/14 16:10:36 meichel
* Implemented Presentation State interface for graphic layers,
* text and graphic annotations, presentation LUTs.
*
* Revision 1.1 1998/11/27 14:50:34 meichel
* Initial Release.
*
*
*/
|