1 /*=========================================================================
4 Module: $RCSfile: gdcmSerieHelper.h,v $
6 Date: $Date: 2005/11/08 16:31:21 $
7 Version: $Revision: 1.27 $
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
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.
49 * It allows to explore (recursively or not) a directory and
50 * makes a set of 'Single SerieUID Filesets'
52 * - to sort any of the 'Single SerieUID Fileset' on the image position.
53 * - to split any of the Single SerieUID Filesets (better use this name than
54 * 'Coherent File List' : it's NOT a std::list, files are NOT coherent ...)
55 * into several XCoherent Filesets
56 * XCoherent stands for 'Extra Coherent' (same orientation, or same position)
58 class GDCM_EXPORT SerieHelper
61 /// SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
62 /// ( List were actually std::vectors, and wher no coherent at all :
63 /// They were only Single SeriesInstanceUID File sets)
64 typedef std::map<std::string, FileList *> SingleSerieUIDFileSetmap;
66 typedef std::vector<File* > FileVector;
71 void Print(std::ostream &os = std::cout, std::string const &indent = "" );
73 /// \todo should return bool or throw error ?
74 void AddFileName(std::string const &filename);
75 void AddGdcmFile(File *header);
77 void SetDirectory(std::string const &dir, bool recursive=false);
78 bool IsCoherent(FileList *fileSet);
79 void OrderFileList(FileList *fileSet);
81 /// \brief Gets the FIRST Single SerieUID Fileset.
82 /// Deprecated; kept not to break the API
83 /// \note Caller must call OrderFileList first
84 /// @return the (first) Single SerieUID Fileset
85 const FileList &GetFileList()
86 { return *SingleSerieUIDFileSetHT.begin()->second; }
88 GDCM_LEGACY( FileList *GetFirstCoherentFileList() );
89 GDCM_LEGACY( FileList *GetNextCoherentFileList() );
90 GDCM_LEGACY( FileList *GetCoherentFileList(std::string serieUID) );
92 FileList *GetFirstSingleSerieUIDFileSet();
93 FileList *GetNextSingleSerieUIDFileSet();
94 FileList *GetSingleSerieUIDFileSet(std::string serieUID);
95 /// brief returns the 'Series Instance UID' Single SerieUID FileSet
96 std::string GetCurrentSerieUIDFileSetUID()
97 { return (*ItFileSetHt).first; }
98 /// All the following allow user to restrict DICOM file to be part
99 /// of a particular serie
100 GDCM_LEGACY( void AddRestriction(TagKey const &key, std::string const &value) );
101 void AddRestriction(TagKey const &key, std::string const &value, int op);
104 * \brief Sets the LoadMode as a boolean string.
105 * LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
106 * ... (nothing more, right now)
107 * WARNING : before using LD_NOSHADOW, be sure *all* your files
108 * contain accurate values in the 0x0000 element (if any)
109 * of *each* Shadow Group. The parser will fail if the size is wrong !
110 * @param mode Load mode to be used
112 void SetLoadMode (int mode) { LoadMode = mode; }
114 /// Brief User wants the files to be sorted Direct Order (default value)
115 void SetSortOrderToDirect() { DirectOrder = true; }
117 /// Brief User wants the files to be sorted Reverse Order
118 void SetSortOrderToReverse() { DirectOrder = false; }
120 /// to allow user to give is own comparison function
121 void SetUserLessThanFunction( BOOL_FUNCTION_PFILE_PFILE_POINTER userFunc )
122 { UserLessThanFunction = userFunc; }
124 XCoherentFileSetmap SplitOnOrientation(FileList *fileSet);
125 XCoherentFileSetmap SplitOnPosition(FileList *fileSet);
126 XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
127 uint16_t group, uint16_t elem);
130 bool UserOrdering(FileList *fileSet);
131 bool ImagePositionPatientOrdering(FileList *fileSet);
132 bool ImageNumberOrdering(FileList *fileSet);
133 bool FileNameOrdering(FileList *fileSet);
135 static bool ImageNumberLessThan(File *file1, File *file2);
136 static bool ImageNumberGreaterThan(File *file1, File *file2);
137 static bool FileNameLessThan(File *file1, File *file2);
138 static bool FileNameGreaterThan(File *file1, File *file2);
142 SingleSerieUIDFileSetmap SingleSerieUIDFileSetHT;
143 SingleSerieUIDFileSetmap::iterator ItFileSetHt;
145 typedef std::pair<TagKey, std::string> Rule;
146 typedef std::vector<Rule> SerieRestrictions;
147 SerieRestrictions Restrictions;
149 // New style for (extented) Rules (Moreover old one doesn't compile)
156 typedef std::vector<ExRule> SerieExRestrictions;
157 SerieExRestrictions ExRestrictions;
159 /// \brief Bit string integer (each one considered as a boolean)
160 /// Bit 0 : Skip Sequences, if possible
161 /// Bit 1 : Skip Shadow Groups if possible
162 /// Probabely, some more to add
165 /// \brief whether we want to sort in direct order or not (reverse order).
166 /// To be used by aware user only
169 /// \brief If user knows more about his images than gdcm does,
170 /// he may supply his own comparison function.
171 BOOL_FUNCTION_PFILE_PFILE_POINTER UserLessThanFunction;
175 } // end namespace gdcm
177 //-----------------------------------------------------------------------------