1 /*=========================================================================
4 Module: $RCSfile: gdcmSerieHelper.h,v $
6 Date: $Date: 2005/07/17 04:26:57 $
7 Version: $Revision: 1.12 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #ifndef GDCMSERIEHELPER_H
20 #define GDCMSERIEHELPER_H
22 #include "gdcmCommon.h"
31 typedef std::vector<File* > FileList;
33 //-----------------------------------------------------------------------------
36 * - This class should be used for a stack of 2D dicom images.
37 * It allows to explore (recursively or not) a directory and
38 * makes a set of 'Coherent Files' list (coherent : same Serie UID)
39 * It allows to sort any of the Coherent File list on the image position
41 class GDCM_EXPORT SerieHelper
44 typedef std::map<std::string, FileList *> CoherentFileListmap;
45 typedef std::vector<File* > FileVector;
49 void Print(std::ostream &os = std::cout, std::string const &indent = "" );
51 /// \todo should return bool or throw error ?
52 void AddFileName(std::string const &filename);
53 void SetDirectory(std::string const &dir, bool recursive=false);
54 void OrderFileList(FileList *coherentFileList);
56 /// \brief Gets the FIRST *coherent* File List.
57 /// Deprecated; kept not to break the API
58 /// \note Caller must call OrderFileList first
59 /// @return the (first) *coherent* File List
60 const FileList &GetFileList() { return *CoherentFileListHT.begin()->second; }
62 FileList *GetFirstCoherentFileList();
63 FileList *GetNextCoherentFileList();
64 FileList *GetCoherentFileList(std::string serieUID);
66 /// All the following allow user to restrict DICOM file to be part
67 /// of a particular serie
68 void AddRestriction(TagKey const &key, std::string const &value);
71 * \brief Sets the LoadMode as a boolean string.
72 * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
73 ... (nothing more, right now)
74 * WARNING : before using NO_SHADOW, be sure *all* your files
75 * contain accurate values in the 0x0000 element (if any)
76 * of *each* Shadow Group. The parser will fail if the size is wrong !
77 * @param mode Load mode to be used
79 void SetLoadMode (int mode) { LoadMode = mode; }
82 bool ImagePositionPatientOrdering(FileList *coherentFileList);
83 bool ImageNumberOrdering(FileList *coherentFileList);
84 bool FileNameOrdering(FileList *coherentFileList);
86 static bool ImageNumberLessThan(File *file1, File *file2);
87 static bool FileNameLessThan(File *file1, File *file2);
90 CoherentFileListmap CoherentFileListHT;
91 CoherentFileListmap::iterator ItListHt;
93 typedef std::pair<TagKey, std::string> Rule;
94 typedef std::vector<Rule> SerieRestrictions;
95 SerieRestrictions Restrictions;
97 /// \brief Bit string integer (each one considered as a boolean)
98 /// Bit 0 : Skip Sequences, if possible
99 /// Bit 1 : Skip Shadow Groups if possible
100 /// Probabely, some more to add
104 } // end namespace gdcm
106 //-----------------------------------------------------------------------------