/usr/include/dcmtk/dcmqrdb/dcmqridx.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 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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | /*
*
* Copyright (C) 1993-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: dcmqrdb
*
* Author: Marco Eichelberg / Didier Lemoine / Gilles Mevel
*
* Purpose: enums and structures used for the database index file
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:41 $
* CVS/RCS Revision: $Revision: 1.6 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DATAPRIV_H
#define DATAPRIV_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmnet/dicom.h"
#include "dcmtk/dcmdata/dcdatset.h"
#include "dcmtk/dcmdata/dcuid.h"
#include "dcmtk/dcmdata/dcdeftag.h"
#include "dcmtk/dcmqrdb/dcmqrdbi.h"
BEGIN_EXTERN_C
#ifdef HAVE_IO_H
#define access my_access // Workaround to make Visual C++ Compiler happy!
#include <io.h>
#undef access
#endif
END_EXTERN_C
/** types of query keys
*/
enum DB_KEY_TYPE
{
/// unique key
UNIQUE_KEY,
/// required key
REQUIRED_KEY,
/// optional key
OPTIONAL_KEY
};
/** query models
*/
enum DB_QUERY_CLASS
{
/// patient root Q/R model
PATIENT_ROOT,
/// study root Q/R model
STUDY_ROOT,
/// patient/study only Q/R model
PATIENT_STUDY
};
/** types of database keys
*/
enum DB_KEY_CLASS
{
/// a date entry
DATE_CLASS,
/// a time entry
TIME_CLASS,
/// a UID entry
UID_CLASS,
/// a string entry
STRING_CLASS,
/// an entry not belonging to any other class
OTHER_CLASS
};
/** Level Strings
*/
#define PATIENT_LEVEL_STRING "PATIENT"
#define STUDY_LEVEL_STRING "STUDY"
#define SERIE_LEVEL_STRING "SERIES"
#define IMAGE_LEVEL_STRING "IMAGE"
/*
** Maximum size of things to put in db records.
** Some values will have vm>1 thus these maximums are
** intended to leave enough space for most common uses.
*/
#define AE_MAX_LENGTH 128 /* Application Entity */
#define AS_MAX_LENGTH 32 /* Age String */
#define AT_MAX_LENGTH 32 /* Attribute Tag */
#define CS_MAX_LENGTH 128 /* Code String */
#define DA_MAX_LENGTH 80 /* Date */
#define DS_MAX_LENGTH 128 /* Decimal String */
#define DT_MAX_LENGTH 208 /* Date Time */
#define FL_MAX_LENGTH 32 /* FLoating point single */
#define FD_MAX_LENGTH 64 /* Floating point Double */
#define IS_MAX_LENGTH 96 /* Integer String */
#define LO_MAX_LENGTH 64 /* Long String */
#define LT_MAX_LENGTH 10240 /* Long Text */
#define PN_MAX_LENGTH 64 /* Person Name */
#define SH_MAX_LENGTH 16 /* Short String */
#define SL_MAX_LENGTH 32 /* Signed Long */
#define SS_MAX_LENGTH 16 /* Signed Short */
#define ST_MAX_LENGTH 1024 /* Short Text */
#define TM_MAX_LENGTH 128 /* Time */
#define UI_MAX_LENGTH 64 /* Unique Identifier */
#define UL_MAX_LENGTH 32 /* Unsigned Long */
#define US_MAX_LENGTH 16 /* Unsigned Short */
#define CS_LABEL_MAX_LENGTH 16 /* Code String - Presentation Label */
#define DESCRIPTION_MAX_LENGTH 128 /* Not related to any particular DICOM attribute */
#define DBC_MAXSTRING 256
#define MAX_MAX_STUDIES DB_UpperMaxStudies
#define MAX_NUMBER_OF_IMAGES 10000
#define SIZEOF_IDXRECORD (sizeof (IdxRecord))
#define SIZEOF_STUDYDESC (sizeof (StudyDescRecord) * MAX_MAX_STUDIES)
/** this class provides a primitive interface for handling a flat DICOM element,
* similar to DcmElement, but only for use within the database module
*/
struct DB_SmallDcmElmt
{
public:
/// default constructor
DB_SmallDcmElmt();
/// pointer to the value field
char* PValueField ;
/// value length in bytes
Uint32 ValueLength ;
/// attribute tag
DcmTagKey XTag ;
private:
/// private undefined copy constructor
DB_SmallDcmElmt(const DB_SmallDcmElmt& copy);
/// private undefined copy assignment operator
DB_SmallDcmElmt& operator=(const DB_SmallDcmElmt& copy);
};
/** this class provides a primitive interface for handling a list of flat DICOM elements,
* similar to DcmItem, but only for use within the database module
*/
struct DB_ElementList
{
/// default constructor
DB_ElementList(): elem(), next(NULL) {}
/// current list element
DB_SmallDcmElmt elem ;
/// pointer to next in list
struct DB_ElementList *next ;
private:
/// private undefined copy constructor
DB_ElementList(const DB_ElementList& copy);
/// private undefined copy assignment operator
DB_ElementList& operator=(const DB_ElementList& copy);
};
struct DB_UidList
{
char *patient ;
char *study ;
char *serie ;
char *image ;
struct DB_UidList *next ;
};
struct DB_CounterList
{
int idxCounter ;
struct DB_CounterList *next ;
};
struct DB_FindAttr
{
DcmTagKey tag ;
DB_LEVEL level ;
DB_KEY_TYPE keyAttr ;
DB_KEY_CLASS keyClass ;
/* to passify some C++ compilers */
DB_FindAttr(const DcmTagKey& t, DB_LEVEL l, DB_KEY_TYPE kt, DB_KEY_CLASS kc)
: tag(t), level(l), keyAttr(kt), keyClass(kc) { }
};
struct DB_Private_Handle
{
int pidx ;
DB_ElementList *findRequestList ;
DB_ElementList *findResponseList ;
DB_LEVEL queryLevel ;
char indexFilename[DBC_MAXSTRING+1] ;
char storageArea[DBC_MAXSTRING+1] ;
long maxBytesPerStudy ;
long maxStudiesAllowed ;
int idxCounter ;
DB_CounterList *moveCounterList ;
int NumberRemainOperations ;
DB_QUERY_CLASS rootLevel ;
DB_UidList *uidList ;
DB_Private_Handle()
: pidx(0)
, findRequestList(NULL)
, findResponseList(NULL)
, queryLevel(STUDY_LEVEL)
// , indexFilename()
// , storageArea()
, maxBytesPerStudy(0)
, maxStudiesAllowed(0)
, idxCounter(0)
, moveCounterList(NULL)
, NumberRemainOperations(0)
, rootLevel(STUDY_ROOT)
, uidList(NULL)
{
}
};
/** this struct defines the structure of each "Study Record" in the index.dat
* file maintained by this module. A Study Record is a direct binary copy
* of an instance of this struct.
*/
struct StudyDescRecord
{
/// Study Instance UID of the study described by this record
char StudyInstanceUID [UI_MAX_LENGTH] ;
/// combined size (in bytes) of all images of this study in the database
long StudySize ;
/// timestamp for last update of this study. Format: output of time(2) converted to double.
double LastRecordedDate ;
/// number of images of this study in the database
int NumberofRegistratedImages ;
};
struct ImagesofStudyArray
{
int idxCounter ;
double RecordedDate ;
long ImageSize ;
};
/* the following constants define which array element
* of the param[] array in the IdxRecord structure
* is linked to which value field in the IdxRecord.
* numbers must be continuous, starting with 0.
*
* The constant NBPARAMETERS must contain the number
* of array elements to be referenced in param[]
* (= highest index +1)
*/
#define RECORDIDX_PatientBirthDate 0
#define RECORDIDX_PatientSex 1
#define RECORDIDX_PatientName 2
#define RECORDIDX_PatientID 3
#define RECORDIDX_PatientBirthTime 4
#define RECORDIDX_OtherPatientIDs 5
#define RECORDIDX_OtherPatientNames 6
#define RECORDIDX_EthnicGroup 7
#define RECORDIDX_NumberofPatientRelatedStudies 8
#define RECORDIDX_NumberofPatientRelatedSeries 9
#define RECORDIDX_NumberofPatientRelatedInstances 10
#define RECORDIDX_StudyDate 11
#define RECORDIDX_StudyTime 12
#define RECORDIDX_StudyID 13
#define RECORDIDX_StudyDescription 14
#define RECORDIDX_NameOfPhysiciansReadingStudy 15
#define RECORDIDX_AccessionNumber 16
#define RECORDIDX_ReferringPhysicianName 17
#define RECORDIDX_ProcedureDescription 18
#define RECORDIDX_AttendingPhysiciansName 19
#define RECORDIDX_StudyInstanceUID 20
#define RECORDIDX_OtherStudyNumbers 21
#define RECORDIDX_AdmittingDiagnosesDescription 22
#define RECORDIDX_PatientAge 23
#define RECORDIDX_PatientSize 24
#define RECORDIDX_PatientWeight 25
#define RECORDIDX_Occupation 26
#define RECORDIDX_NumberofStudyRelatedSeries 27
#define RECORDIDX_NumberofStudyRelatedInstances 28
#define RECORDIDX_SeriesNumber 29
#define RECORDIDX_SeriesInstanceUID 30
#define RECORDIDX_Modality 31
#define RECORDIDX_ImageNumber 32
#define RECORDIDX_SOPInstanceUID 33
#define RECORDIDX_SeriesDate 34
#define RECORDIDX_SeriesTime 35
#define RECORDIDX_SeriesDescription 36
#define RECORDIDX_ProtocolName 37
#define RECORDIDX_OperatorsName 38
#define RECORDIDX_PerformingPhysicianName 39
#define RECORDIDX_PresentationLabel 40
#define NBPARAMETERS 41
/** this class manages an instance entry of the index file.
* Each instance/image record within the index.dat file is
* a direct (binary) copy of this structure.
*/
struct IdxRecord
{
/// default constructor
IdxRecord();
char filename [DBC_MAXSTRING+1] ;
char SOPClassUID [UI_MAX_LENGTH+1] ;
double RecordedDate ;
int ImageSize ;
DB_SmallDcmElmt param [NBPARAMETERS] ;
char PatientBirthDate [DA_MAX_LENGTH+1] ;
char PatientSex [CS_MAX_LENGTH+1] ;
char PatientName [PN_MAX_LENGTH+1] ;
char PatientID [LO_MAX_LENGTH+1] ;
char PatientBirthTime [TM_MAX_LENGTH+1] ;
char OtherPatientIDs [LO_MAX_LENGTH+1] ;
char OtherPatientNames [PN_MAX_LENGTH+1] ;
char EthnicGroup [SH_MAX_LENGTH+1] ;
char NumberofPatientRelatedStudies [IS_MAX_LENGTH+1] ;
char NumberofPatientRelatedSeries [IS_MAX_LENGTH+1] ;
char NumberofPatientRelatedInstances [IS_MAX_LENGTH+1] ;
char StudyDate [DA_MAX_LENGTH+1] ;
char StudyTime [TM_MAX_LENGTH+1] ;
char StudyID [CS_MAX_LENGTH+1] ;
char StudyDescription [LO_MAX_LENGTH+1] ;
char NameOfPhysiciansReadingStudy [PN_MAX_LENGTH+1] ;
char AccessionNumber [CS_MAX_LENGTH+1] ;
char ReferringPhysicianName [PN_MAX_LENGTH+1] ;
char ProcedureDescription [LO_MAX_LENGTH+1] ;
char AttendingPhysiciansName [PN_MAX_LENGTH+1] ;
char StudyInstanceUID [UI_MAX_LENGTH+1] ;
char OtherStudyNumbers [IS_MAX_LENGTH+1] ;
char AdmittingDiagnosesDescription [LO_MAX_LENGTH+1] ;
char PatientAge [AS_MAX_LENGTH+1] ;
char PatientSize [DS_MAX_LENGTH+1] ;
char PatientWeight [DS_MAX_LENGTH+1] ;
char Occupation [SH_MAX_LENGTH+1] ;
char NumberofStudyRelatedSeries [IS_MAX_LENGTH+1] ;
char NumberofStudyRelatedInstances [IS_MAX_LENGTH+1] ;
char SeriesNumber [IS_MAX_LENGTH+1] ;
char SeriesInstanceUID [UI_MAX_LENGTH+1] ;
char Modality [CS_MAX_LENGTH+1] ;
char ImageNumber [IS_MAX_LENGTH+1] ;
char SOPInstanceUID [UI_MAX_LENGTH+1] ;
char SeriesDate [DA_MAX_LENGTH+1] ;
char SeriesTime [TM_MAX_LENGTH+1] ;
char SeriesDescription [LO_MAX_LENGTH+1] ;
char ProtocolName [LO_MAX_LENGTH+1] ;
char OperatorsName [PN_MAX_LENGTH+1] ;
char PerformingPhysicianName [PN_MAX_LENGTH+1] ;
char PresentationLabel [CS_LABEL_MAX_LENGTH+1] ;
DVIFhierarchyStatus hstat;
// Not related to any particular DICOM attribute !
char InstanceDescription [DESCRIPTION_MAX_LENGTH+1] ;
private:
/* undefined */ IdxRecord(const IdxRecord& copy);
/* undefined */ IdxRecord& operator=(const IdxRecord& copy);
};
#endif
/*
* CVS Log
* $Log: dcmqridx.h,v $
* Revision 1.6 2010-10-14 13:16:41 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.5 2010-08-09 13:23:00 joergr
* Updated data dictionary to 2009 edition of the DICOM standard. From now on,
* the official "keyword" is used for the attribute name which results in a
* number of minor changes (e.g. "PatientsName" is now called "PatientName").
*
* Revision 1.4 2009-01-30 14:45:02 joergr
* Uncommented initialization of array variables in order to avoid compiler
* warnings reported by VisualStudio 2005.
*
* Revision 1.3 2008-04-15 15:43:37 meichel
* Fixed endless recursion bug in the index file handling code when
* the index file does not exist
*
* Revision 1.2 2005/12/08 16:04:24 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.1 2005/03/30 13:34:50 meichel
* Initial release of module dcmqrdb that will replace module imagectn.
* It provides a clear interface between the Q/R DICOM front-end and the
* database back-end. The imagectn code has been re-factored into a minimal
* class structure.
*
*
*/
|