/usr/include/dcmtk/dcmpstat/dvpsril.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 258 259 260 261 262 263 264 265 | /*
*
* 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: DVPSReferencedImage_PList
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:36 $
* CVS/RCS Revision: $Revision: 1.14 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DVPSRIL_H
#define DVPSRIL_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dcitem.h"
#include "dcmtk/dcmpstat/dvpstyp.h" /* for enum types */
class DVPSReferencedImage;
class DVPSReferencedSeries_PList;
/** the list of referenced images contained in a presentation state (internal use only).
* This class manages the data structures comprising one complete
* Reference Image Sequence which is contained in one item
* of the Referenced Series Sequence in a Presentation State object.
*/
class DVPSReferencedImage_PList
{
public:
/// default constructor
DVPSReferencedImage_PList();
/// copy constructor
DVPSReferencedImage_PList(const DVPSReferencedImage_PList& copy);
/** clone method.
* @return a pointer to a new DVPSReferencedImage_PList object containing
* a deep copy of this object.
*/
DVPSReferencedImage_PList *clone() { return new DVPSReferencedImage_PList(*this); }
/// destructor
virtual ~DVPSReferencedImage_PList();
/** reads a list of image references (ReferencedImageSequence) from a DICOM dataset.
* The DICOM elements of the image references item are copied from the dataset to this object.
* The completeness of all items (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 DICOM dataset from which the sequence is to be read
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition read(DcmItem &dset);
/** writes the list of image references 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 DICOM dataset to which the ReferencedImageSequence is written
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition write(DcmItem &dset);
/** reset the object to initial state.
* After this call, the object is in the same state as after
* creation with the default constructor.
*/
void clear();
/** checks if images are referenced within this ReferencedImageSequence
* and whether all images share the same SOP class UID.
* @param sopclassuid should be an empty string when called.
* Returns the SOP class UID of the images in the list.
* @return OFTrue if the sequence is valid (correct), OFFalse otherwise.
*/
OFBool isValid(OFString& sopclassuid);
/** checks if an image reference with the given SOP instance UID exists
* in this ReferencedImageSequence.
* @param sopinstanceuid the SOP instance UID of the searched image reference
* @return a pointer to the matching DVPSReferencedImage if found, NULL otherwise.
*/
DVPSReferencedImage *findImageReference(const char *sopinstanceuid);
/** update the reference to the given image such that
* the given frame is not referenced any more.
* @param sopinstanceuid the SOP instance UID of the image reference
* @param frame the frame reference
* @param numberOfFrames the number of frames of the image reference
*/
void removeFrameReference(const char *sopinstanceuid, unsigned long frame, unsigned long numberOfFrames);
/** checks if an image reference with the given SOP instance UID exists
* in this ReferencedImageSequence and deletes it.
* @param sopinstanceuid the SOP instance UID of the image reference to be removed.
*/
void removeImageReference(const char *sopinstanceuid);
/** 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 frames a list of frame numbers in DICOM IS format
* (integer numbers separated by '\' characters). Default: frame numbers absent.
* The frame numbers are required if the referenced image is a multiframe image.
*/
OFCondition addImageReference(
const char *sopclassUID,
const char *instanceUID,
const char *frames=NULL);
/** 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 DVPSB_currentImage)
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition addImageReference(
const char *sopclassUID,
const char *instanceUID,
unsigned long frame,
DVPSObjectApplicability applicability);
/** removes a reference to an image or frame. If the current reference is empty ("global"), an
* explicit list of references is constructed from the list of series/instance references.
* The image or frame reference is removed from the total list of references in this object.
* If the only reference contained in this object is removed, the reference list becomes empty
* which means that the current reference becomes "global". This case must be handled by the caller.
* @param allReferences list of series/instance references registered for the presentation state.
* @param instanceUID SOP instance UID of the current image
* @param frame number of the current frame
* @param numberOfFrames the number of frames of the current image
* @param applicability the applicability of the image reference to be removed
* (DVPSB_currentFrame or DVPSB_currentImage)
*/
void removeImageReference(
DVPSReferencedSeries_PList& allReferences,
const char *instanceUID,
unsigned long frame,
unsigned long numberOfFrames,
DVPSObjectApplicability applicability);
/** gets the number of image references in this list.
* @return the number of image references.
*/
size_t size() const { return list_.size(); }
/** gets an image reference with the given index.
* @param idx index, must be < size().
* @param sopclassUID the SOP Class UID is returned in this string
* @param instanceUID the SOP Instance UID is returned in this string
* @param frames the list of frames is returned in this string
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition getImageReference(
size_t idx,
OFString& sopclassUID,
OFString& instanceUID,
OFString& frames);
/** checks if the object containing this list of image references
* is applicable to the given image and frame.
* @param instanceUID SOP instance UID of the current image
* @param frame number of the current frame
* @return OFTrue if applicable.
*/
OFBool isApplicable(const char *instanceUID, unsigned long frame);
/** checks if the object containing this list of image references
* matches exactly the applicability
* defined by the instanceUID, frame and applicability parameters.
* @param instanceUID SOP instance UID of the current image
* @param frame number of the current frame
* @return OFTrue if matching.
*/
OFBool matchesApplicability(const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability);
private:
/// private undefined assignment operator
DVPSReferencedImage_PList& operator=(const DVPSReferencedImage_PList&);
/** the list maintained by this object
*/
OFList<DVPSReferencedImage *> list_;
};
#endif
/*
* $Log: dvpsril.h,v $
* Revision 1.14 2010-10-14 13:16:36 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.13 2010-10-07 14:31:36 joergr
* Removed leading underscore characters from preprocessor symbols (reserved).
*
* Revision 1.12 2009-11-24 14:12:57 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.11 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.10 2005-12-08 16:04:00 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.9 2003/06/04 10:18:06 meichel
* Replaced private inheritance from template with aggregation
*
* Revision 1.8 2001/09/26 15:36:15 meichel
* Adapted dcmpstat to class OFCondition
*
* Revision 1.7 2001/06/01 15:50:20 meichel
* Updated copyright header
*
* Revision 1.6 2000/06/02 16:00:50 meichel
* Adapted all dcmpstat classes to use OFConsole for log and error output
*
* Revision 1.5 2000/03/08 16:28:55 meichel
* Updated copyright header.
*
* Revision 1.4 1999/07/22 16:39:10 meichel
* Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
*
* Revision 1.3 1999/01/15 17:33:03 meichel
* added methods to DVPresentationState allowing to access the image
* references in the presentation state. Also added methods allowing to
* get the width and height of the attached image.
*
* Revision 1.2 1998/12/14 16:10:33 meichel
* Implemented Presentation State interface for graphic layers,
* text and graphic annotations, presentation LUTs.
*
* Revision 1.1 1998/11/27 14:50:32 meichel
* Initial Release.
*
*
*/
|