/usr/include/dcmtk/dcmfg/fgfracon.h is in libdcmtk-dev 3.6.2-3build3.
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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | /*
*
* Copyright (C) 2015-2016, Open Connections GmbH
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation are maintained by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmfg
*
* Author: Michael Onken
*
* Purpose: Class for managing the Frame Content Functional Group
*
*/
#ifndef FGFRACON_H
#define FGFRACON_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofvector.h"
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/dcmdata/dctk.h"
#include "dcmtk/dcmfg/fgbase.h"
/** Class representing the "Frame Content" Functional Group Macro. Can only be
* used as per-frame functional group (never shared).
*/
class DCMTK_DCMFG_EXPORT FGFrameContent : public FGBase
{
public:
/** Constructor, creates empty functional group
*/
FGFrameContent();
/** Virtual destructor
*/
virtual ~FGFrameContent();
/** Returns a deep copy of this object
* @return Deep copy of this object
*/
virtual FGBase *clone() const;
/** Returns shared functional group type (always "per-frame")
* @return The functional group type (DcmFGTypes::EFGS_ONLYPERFRAME)
*/
virtual DcmFGTypes::E_FGSharedType getSharedType() const {return DcmFGTypes::EFGS_ONLYPERFRAME;}
/** Clear all data
*/
virtual void clearData();
/** Check whether the current content of this group is consistent and complete
* @return EC_Normal, if no errors are found, error otherwise
*/
virtual OFCondition check() const;
/** Read Frame Content Sequence from given item
* @param item The item to read from
* @return EC_Normal if reading was successful, error otherwise
*/
virtual OFCondition read(DcmItem& item);
/** Writes the content of this class into Frame Content Sequence
* (newly cerated) into given item
* @param item The item to write to
* @return EC_Normal if writing was successful, error otherwise
*/
virtual OFCondition write(DcmItem& item);
/** Comparison operator that compares the normalized value of this object
* with a given object of the same type, i.e.\ the elements within both
* functional groups (this and rhs parameter) are compared by value!
* Both objects (this and rhs) need to have the same type (i.e.\ both
* FGUnknown) to be comparable. This function is used in order
* to decide whether a functional group already exists, or is new. This
* is used in particular to find out whether a given functional group
* can be shared (i.e.\ the same information already exists as shared
* functional group) or is different from the same shared group. In that
* case the shared functional group must be distributed into per-frame
* functional groups, instead. The exact implementation for implementing
* the comparison is not relevant. However, it must be a comparison
* by value.
* @param rhs the right hand side of the comparison
* @return 0 if the object values are equal.
* -1 if either the value of the first component that does not match
* is lower in the this object, or all compared components match
* but this component is shorter. Also returned if this type and
* rhs type (DcmFGTypes::E_FGType) do not match.
* 1 if either the value of the first component that does not match
* is greater in this object, or all compared components match
* but this component is longer.
*/
virtual int compare(const FGBase& rhs) const;
// --- get() functionality ---
/** Get Frame Acquisition Number
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameAcquisitionNumber(Uint16& value,
const signed long pos = 0);
/** Get Frame Reference Date Time
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameReferenceDateTime(OFString& value,
const signed long pos = 0);
/** Get Frame Acquisition Date Time
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameAcquisitionDateTime(OFString& value,
const signed long pos = 0);
/** Get Frame Acquisition Duration
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameAcquisitionDuration(Float64& value,
const unsigned long pos = 0);
/** Get Cardiac Cycle Position
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getCardiacCyclePosition(OFString& value,
const signed long pos = 0);
/** Get Respiratory Cycle Position
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getRespiratoryCyclePosition(OFString& value,
const signed long pos = 0);
/** Get Dimension Index Value
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getDimensionIndexValues(Uint32& value,
const signed long pos = 0);
/** Get Temporal Position Index
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getTemporalPositionIndex(Uint32& value,
const signed long pos = 0);
/** Get Stack ID
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getStackID(OFString& value,
const signed long pos = 0);
/** Get In-Stack Position Number
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getInStackPositionNumber(Uint32& value,
const signed long pos = 0);
/** Get Frame Comments
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameComments(OFString& value,
const signed long pos = 0);
/** Get Frame Label
* @param value Reference to variable that should hold the result
* @param pos Position of the value inside the DICOM element. If 0, the first
* value is returned. If the no value at the given position exists,
* an error is returned.
* @return EC_Normal, if value could be returned, error otherwise
*/
virtual OFCondition getFrameLabel(OFString& value,
const signed long pos = 0);
// --- set() functionality ---
/** Set Frame Acquisition Number
* @param value Value that should be set
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameAcquisitionNumber(const Uint16& value,
const OFBool checkValue = OFTrue);
/** Set Frame Frame Reference Date Time
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameReferenceDateTime(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set Frame Acquisition Date Time
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameAcquisitionDateTime(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set Frame Acquisition Duration
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameAcquisitionDuration(const Float64& value,
const OFBool checkValue = OFTrue);
/** Set Cardiac Cycle Position
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setCardiacCyclePosition(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set Respiratory Cycle Position
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setRespiratoryCyclePosition(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set one of the Dimension Index Values
* @param value Value that should be set (lowest index starts with 1)
* @param dim The position of the value that should be set (lowest index
* starts with 0), i.e.\ select the 1st, 2nd, ..nth dimension
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setDimensionIndexValues(const Uint32& value,
const unsigned int dim,
const OFBool checkValue = OFTrue);
/** Set Temporal Position Index
* @param value Value that should be set
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setTemporalPositionIndex(const Uint32& value,
const OFBool checkValue = OFTrue);
/** Set Stack ID
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setStackID(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set In-Stack Position Number
* @param value Value that should be set
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setInStackPositionNumber(const Uint32& value,
const OFBool checkValue = OFTrue);
/** Set Frame Comments
* @param value Value that should be set
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameComments(const OFString& value,
const OFBool checkValue = OFTrue);
/** Set Frame Label
* @param value Value that should be set
* @param checkValue If OFTrue, basic checks are performed whether the value is
* valid for this attribute
* @return EC_Normal, if value was set, error otherwise
*/
virtual OFCondition setFrameLabel(const OFString& value,
const OFBool checkValue = OFTrue);
private:
/* Content of Frame Content Macro */
/// Frame Acquisition Number (US, VM 1, Required type 3)
DcmUnsignedShort m_FrameAcquisitonNumber;
/// Frame Reference DateTime (DT, 1, 1C)
DcmDateTime m_FrameReferenceDateTime;
/// Frame Acquisition DateTime (DT, 1, 1C)
DcmDateTime m_FrameAcquisitionDateTime;
/// Frame Acquisition Duration (FD, 1, 1C)
DcmFloatingPointDouble m_FrameAcquisitionDuration;
/// Cardiac Cycle Position (CS, 1, 3)
DcmCodeString m_CardiacCyclePosition;
/// Respiratory Cycle Position (CS, 1, 3)
DcmCodeString m_RespiratoryCyclePosition;
/// Dimension Index Values (UL, 1-n, 1C)
DcmUnsignedLong m_DimensionIndexValues;
/// Temporal Position Index (UL, 1, 1C)
DcmUnsignedLong m_TemporalPositionIndex;
/// Stack ID (SH, 1, 1C)
DcmShortString m_StackID;
/// In-Stack Position Number (UL, 1, 1C)
DcmUnsignedLong m_InStackPositionNumber;
/// Frame Comments (LT, 1, 3)
DcmLongText m_FrameComments;
/// Frame Label (LO, 1, 3)
DcmLongString m_FrameLabel;
};
#endif // FGFRACON_H
|