/usr/include/dcmtk/dcmsr/dsrsc3vl.h is in libdcmtk-dev 3.6.1~20160216-4.
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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | /*
*
* Copyright (C) 2010-2015, 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: dcmsr
*
* Author: Joerg Riesmeier
*
* Purpose:
* classes: DSRSpatialCoordinates3DValue
*
*/
#ifndef DSRSC3VL_H
#define DSRSC3VL_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/dcmsr/dsrsc3gr.h"
/*---------------------*
* class declaration *
*---------------------*/
/** Class for spatial coordinate (3D) values
*/
class DCMTK_DCMSR_EXPORT DSRSpatialCoordinates3DValue
{
// allow access to getValuePtr()
friend class DSRContentItem;
public:
/** default constructor
*/
DSRSpatialCoordinates3DValue();
/** constructor
** @param graphicType graphic type specifying the geometry of the coordinates
*/
DSRSpatialCoordinates3DValue(const DSRTypes::E_GraphicType3D graphicType);
/** copy constructor
** @param coordinatesValue spatial coordinates value to be copied (not checked !)
*/
DSRSpatialCoordinates3DValue(const DSRSpatialCoordinates3DValue &coordinatesValue);
/** destructor
*/
virtual ~DSRSpatialCoordinates3DValue();
/** assignment operator
** @param coordinatesValue spatial coordinates value to be copied (not checked !)
** @return reference to this spatial coordinates value after 'coordinatesValue' has
* been copied
*/
DSRSpatialCoordinates3DValue &operator=(const DSRSpatialCoordinates3DValue &coordinatesValue);
/** clear all internal variables.
* Graphic type is set to GT3_invalid. Since an empty list of graphic data is invalid
* the spatial coordinates value becomes invalid afterwards.
*/
virtual void clear();
/** check whether the current spatial coordinates value is valid.
* The value is valid if the graphic type is not GT3_invalid and the graphic data as well
* as the referenced frame of reference UID are valid. See checkXXX() methods for
* details.
** @return OFTrue if reference value is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** check whether the content is short.
* This method is used to check whether the rendered output of this content item can be
* expanded inline or not (used for renderHTML()).
** @param flags flag used to customize the output (see DSRTypes::HF_xxx)
** @return OFTrue if the content is short, OFFalse otherwise
*/
virtual OFBool isShort(const size_t flags) const;
/** print spatial coordinates.
* The output of a typical spatial coordinates value looks like this: (POINT,,100/100/100).
** @param stream output stream to which the spatial coordinates value should be printed
* @param flags flag used to customize the output (see DSRTypes::PF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition print(STD_NAMESPACE ostream &stream,
const size_t flags) const;
/** read spatial coordinates value from dataset
** @param dataset DICOM dataset from which the value should be read
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition read(DcmItem &dataset,
const size_t flags);
/** write spatial coordinates reference value to dataset
** @param dataset DICOM dataset to which the value should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition write(DcmItem &dataset) const;
/** read spatial coordinates value from XML document
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
* @param flags flag used to customize the reading process (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** write spatial coordinates value in XML format
** @param stream output stream to which the XML document is written
* @param flags flag used to customize the output (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags) const;
/** render spatial coordinates value in HTML/XHTML format
** @param docStream output stream to which the main HTML/XHTML document is written
* @param annexStream output stream to which the HTML/XHTML document annex is written
* @param annexNumber reference to the variable where the current annex number is
* stored. Value is increased automatically by 1 after a new entry
* has been added.
* @param flags flag used to customize the output (see DSRTypes::HF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition renderHTML(STD_NAMESPACE ostream &docStream,
STD_NAMESPACE ostream &annexStream,
size_t &annexNumber,
const size_t flags) const;
/** get copy of spatial coordinates value
** @param coordinatesValue reference to variable in which the value should be stored
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getValue(DSRSpatialCoordinates3DValue &coordinatesValue) const;
/** get reference to spatial coordinates value
** @return reference to spatial coordinates value
*/
inline const DSRSpatialCoordinates3DValue &getValue() const
{
return *this;
}
/** get current graphic type.
* The graphic type specifies the geometry of the coordinates stored in the graphic data
* list.
** @return graphic type (might be GT3_invalid)
*/
inline DSRTypes::E_GraphicType3D getGraphicType() const
{
return GraphicType;
}
/** get reference to graphic data list.
* This list contains an ordered set of (x,y,z) triplets that denote positions in
* an image. The allowed number of triplets is depending on the graphic type.
** @return reference to graphic data list
*/
inline DSRGraphicData3DList &getGraphicDataList()
{
return GraphicDataList;
}
/** get referenced frame of reference UID.
* Uniquely identifies the frame of reference within which the coordinates are defined.
** @return referenced frame of reference UID (might be invalid or an empty string)
*/
inline const OFString &getFrameOfReferenceUID() const
{
return FrameOfReferenceUID;
}
/** get fiducial UID.
* Optional - This is the globally unique identifier for this fiducial item. It can be
* used to associate these spatial coordinates with other content items.
** @return fiducial UID (might be invalid or an empty string)
*/
inline const OFString &getFiducialUID() const
{
return FiducialUID;
}
/** set spatial coordinates value.
* Before setting the value, the graphic type, graphic data and frame of reference UID
* are usually checked. If the value is invalid, the current value is not replaced and
* remains unchanged.
** @param coordinatesValue value to be set
* @param check if enabled, check values for validity before setting them.
* See checkXXX() methods for details. Empty values are only
* accepted for non-mandatory attributes.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setValue(const DSRSpatialCoordinates3DValue &coordinatesValue,
const OFBool check = OFTrue);
/** set current graphic type.
* The graphic type specifies the geometry of the coordinates stored in the graphic data
* list.
** @param graphicType graphic type to be set (GT3_invalid is not allowed)
* @param check dummy parameter (currently not used)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setGraphicType(const DSRTypes::E_GraphicType3D graphicType,
const OFBool check = OFTrue);
/** set current referenced frame of reference UID.
* Uniquely identifies the frame of reference within which the coordinates are defined.
** @param frameOfReferenceUID value to be set (VR=UI, mandatory)
* @param check if enabled, check value for validity before setting it.
* See checkFrameOfReferenceUID() method for details. An
* empty value is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setFrameOfReferenceUID(const OFString &frameOfReferenceUID,
const OFBool check = OFTrue);
/** set current fiducial UID.
* Globally unique identifier that can be used to associate these spatial coordinates
* with other content items.
** @param fiducialUID value to be set (VR=UI, optional)
* @param check if enabled, check value for validity before setting it. See
* checkFiducialUID() method for details.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setFiducialUID(const OFString &fiducialUID,
const OFBool check = OFTrue);
protected:
/** get pointer to spatial coordinates value
** @return pointer to spatial coordinates value (never NULL)
*/
inline DSRSpatialCoordinates3DValue *getValuePtr()
{
return this;
}
/** check the specified graphic type and data for validity.
* If 'graphicType' is valid, the number of entries in the 'graphicDatalist' are checked.
* A POINT needs exactly 1 value triplets (x,y,z), a MULTIPOINT at least 1?, a POLYLINE
* at least 1?, a POLYGON at least 1? where the first and last triplet are equal, an
* ELLIPSE exactly 4 and an ELLIPSOID exactly 6.
** @param graphicType graphic type to be checked
* @param graphicDataList list of graphic data to be checked
* @param reportWarnings if enabled, report a warning message on each deviation from
* an expected value to the logger
** @return status, EC_Normal if graphic type and data are valid, an error code otherwise
*/
OFCondition checkGraphicData(const DSRTypes::E_GraphicType3D graphicType,
const DSRGraphicData3DList &graphicDataList,
const OFBool reportWarnings = OFFalse) const;
/** check the specified frame of reference UID for validity
** @param frameOfReferenceUID referenced frame of reference UID to be checked
** @return status, EC_Normal if frame of reference UID is valid, an error code otherwise
*/
OFCondition checkFrameOfReferenceUID(const OFString &frameOfReferenceUID) const;
/** check the specified fiducial UID for validity
** @param fiducialUID fiducial UID to be checked
** @return status, EC_Normal if fiducial UID is valid, an error code otherwise
*/
OFCondition checkFiducialUID(const OFString &fiducialUID) const;
private:
/// Graphic Type (associated DICOM VR=CS, type 1)
DSRTypes::E_GraphicType3D GraphicType;
/// Graphic Data (associated DICOM VR=FL, VM=2-n, type 1)
DSRGraphicData3DList GraphicDataList;
/// Referenced Frame of Reference UID (VR=UI, VM=1, type 1)
OFString FrameOfReferenceUID;
/// Fiducial UID (VR=UI, VM=1, type 3)
OFString FiducialUID;
};
#endif
|