1 /*=========================================================================
4 Module: $RCSfile: gdcmSerieHelper.h,v $
6 Date: $Date: 2005/11/21 09:46:27 $
7 Version: $Revision: 1.29 $
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"
23 #include "gdcmTagKey.h"
24 #include "gdcmDebug.h" // for LEGACY
25 #include "gdcmRefCounter.h"
35 typedef std::vector<File* > FileList;
37 /// \brief XCoherent stands for 'Extra Coherent',
38 /// (The name 'Coherent' would be enough but it was used before;
39 /// I don't want to put a bomb in the code)
40 /// Any 'better name' is welcome !
41 typedef std::map<std::string, FileList *> XCoherentFileSetmap;
43 typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
45 //-----------------------------------------------------------------------------
48 * This class should be used for a stack of 2D dicom images.
50 * - It allows to explore (recursively or not) a directory and
51 * makes a set of 'Single SerieUID Filesets'
53 * - - to sort any of the 'Single SerieUID Fileset' on the image position.
54 * - - to split any of the Single SerieUID Filesets (better use this name than
55 * 'CoherentFileList' : it's NOT a std::list, files are NOT coherent ...)
56 * into several XCoherent Filesets
57 * XCoherent stands for 'Extra Coherent' (same orientation, or same position)
59 class GDCM_EXPORT SerieHelper : public RefCounter
61 gdcmTypeMacro(SerieHelper);
64 /// SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
65 /// ( List were actually std::vectors, and wher no coherent at all :
66 /// They were only Single SeriesInstanceUID File sets)
67 typedef std::map<std::string, FileList *> SingleSerieUIDFileSetmap;
69 typedef std::vector<File* > FileVector;
71 /// \brief Constructs a SerieHelper with a RefCounter
72 static SerieHelper *New() {return new SerieHelper();}
74 virtual ~SerieHelper();
75 void Print(std::ostream &os = std::cout, std::string const &indent = "" );
77 /// \todo should return bool or throw error ?
78 void AddFileName(std::string const &filename);
79 void AddGdcmFile(File *header);
81 void SetDirectory(std::string const &dir, bool recursive=false);
82 bool IsCoherent(FileList *fileSet);
83 void OrderFileList(FileList *fileSet);
85 /// \brief Gets the FIRST Single SerieUID Fileset.
86 /// Deprecated; kept not to break the API
87 /// \note Caller must call OrderFileList first
88 /// @return the (first) Single SerieUID Fileset
89 const FileList &GetFileList()
90 { return *SingleSerieUIDFileSetHT.begin()->second; }
92 GDCM_LEGACY( FileList *GetFirstCoherentFileList() );
93 GDCM_LEGACY( FileList *GetNextCoherentFileList() );
94 GDCM_LEGACY( FileList *GetCoherentFileList(std::string serieUID) );
96 FileList *GetFirstSingleSerieUIDFileSet();
97 FileList *GetNextSingleSerieUIDFileSet();
98 FileList *GetSingleSerieUIDFileSet(std::string serieUID);
99 /// brief returns the 'Series Instance UID' Single SerieUID FileSet
100 std::string GetCurrentSerieUIDFileSetUID()
101 { return (*ItFileSetHt).first; }
102 /// All the following allow user to restrict DICOM file to be part
103 /// of a particular serie
104 void AddRestriction(TagKey const &key, std::string const &value, int op);
107 * \brief Sets the LoadMode as a boolean string.
108 * LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
109 * ... (nothing more, right now)
110 * WARNING : before using LD_NOSHADOW, be sure *all* your files
111 * contain accurate values in the 0x0000 element (if any)
112 * of *each* Shadow Group. The parser will fail if the size is wrong !
113 * @param mode Load mode to be used
115 void SetLoadMode (int mode) { LoadMode = mode; }
117 /// Brief User wants the files to be sorted Direct Order (default value)
118 void SetSortOrderToDirect() { DirectOrder = true; }
120 /// Brief User wants the files to be sorted Reverse Order
121 void SetSortOrderToReverse() { DirectOrder = false; }
123 /// to allow user to give is own comparison function
124 void SetUserLessThanFunction( BOOL_FUNCTION_PFILE_PFILE_POINTER userFunc )
125 { UserLessThanFunction = userFunc; }
127 XCoherentFileSetmap SplitOnOrientation(FileList *fileSet);
128 XCoherentFileSetmap SplitOnPosition(FileList *fileSet);
129 XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
130 uint16_t group, uint16_t elem);
136 bool UserOrdering(FileList *fileSet);
137 bool ImagePositionPatientOrdering(FileList *fileSet);
138 bool ImageNumberOrdering(FileList *fileSet);
139 bool FileNameOrdering(FileList *fileSet);
141 static bool ImageNumberLessThan(File *file1, File *file2);
142 static bool ImageNumberGreaterThan(File *file1, File *file2);
143 static bool FileNameLessThan(File *file1, File *file2);
144 static bool FileNameGreaterThan(File *file1, File *file2);
148 SingleSerieUIDFileSetmap SingleSerieUIDFileSetHT;
149 SingleSerieUIDFileSetmap::iterator ItFileSetHt;
151 typedef std::pair<TagKey, std::string> Rule;
152 typedef std::vector<Rule> SerieRestrictions;
153 SerieRestrictions Restrictions;
155 // New style for (extented) Rules (Moreover old one doesn't compile)
162 typedef std::vector<ExRule> SerieExRestrictions;
163 SerieExRestrictions ExRestrictions;
165 /// \brief Bit string integer (each one considered as a boolean)
166 /// Bit 0 : Skip Sequences, if possible
167 /// Bit 1 : Skip Shadow Groups if possible
168 /// Probabely, some more to add
171 /// \brief whether we want to sort in direct order or not (reverse order).
172 /// To be used by aware user only
175 /// \brief If user knows more about his images than gdcm does,
176 /// he may supply his own comparison function.
177 BOOL_FUNCTION_PFILE_PFILE_POINTER UserLessThanFunction;
181 } // end namespace gdcm
183 //-----------------------------------------------------------------------------