X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmSerieHelper.h;h=519255c8b0592efb312d6f0ec30c81dba36ef54f;hb=46afb30d2d016a9b1581c7ee4ca96d614a35203c;hp=ef9036b8f63d9464a32b2d8a1b0cde4aeb13449f;hpb=eeb624df6a1661e969566c200505f3dac84f4cd6;p=gdcm.git diff --git a/src/gdcmSerieHelper.h b/src/gdcmSerieHelper.h index ef9036b8..519255c8 100644 --- a/src/gdcmSerieHelper.h +++ b/src/gdcmSerieHelper.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmSerieHelper.h,v $ Language: C++ - Date: $Date: 2005/07/21 05:00:30 $ - Version: $Revision: 1.14 $ + Date: $Date: 2005/11/28 15:20:34 $ + Version: $Revision: 1.31 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -20,7 +20,9 @@ #define GDCMSERIEHELPER_H #include "gdcmCommon.h" +#include "gdcmTagKey.h" #include "gdcmDebug.h" // for LEGACY +#include "gdcmCommandManager.h" #include #include @@ -29,24 +31,47 @@ namespace gdcm { class File; -typedef std::vector FileList; + + typedef std::vector FileList; + + /// \brief XCoherent stands for 'Extra Coherent', + /// (The name 'Coherent' would be enough but it was used before; + /// I don't want to put a bomb in the code) + /// Any 'better name' is welcome ! + typedef std::map XCoherentFileSetmap; + + typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *); //----------------------------------------------------------------------------- /** * \brief - * - This class should be used for a stack of 2D dicom images. - * It allows to explore (recursively or not) a directory and - * makes a set of 'Coherent Files' list (coherent : same Serie UID) - * It allows to sort any of the Coherent File list on the image position + * This class should be used for a stack of 2D dicom images. + * + * - It allows to explore (recursively or not) a directory and + * makes a set of 'Single SerieUID Filesets' + * - It allows : + * - - to sort any of the 'Single SerieUID Fileset' on the image position. + * - - to split any of the Single SerieUID Filesets (better use this name than + * 'CoherentFileList' : it's NOT a std::list, files are NOT coherent ...) + * into several XCoherent Filesets + * XCoherent stands for 'Extra Coherent' (same orientation, or same position) */ -class GDCM_EXPORT SerieHelper +class GDCM_EXPORT SerieHelper : public CommandManager { + gdcmTypeMacro(SerieHelper); + public: - typedef std::map CoherentFileListmap; + /// SingleSerieUIDFileSetmap replaces the former CoherentFileListmap + /// ( List were actually std::vectors, and wher no coherent at all : + /// They were only Single SeriesInstanceUID File sets) + typedef std::map SingleSerieUIDFileSetmap; + typedef std::vector FileVector; - SerieHelper(); - ~SerieHelper(); +/// \brief Constructs a SerieHelper with a RefCounter + static SerieHelper *New() {return new SerieHelper();} + + virtual ~SerieHelper(); void Print(std::ostream &os = std::cout, std::string const &indent = "" ); /// \todo should return bool or throw error ? @@ -54,47 +79,88 @@ public: void AddGdcmFile(File *header); void SetDirectory(std::string const &dir, bool recursive=false); - void OrderFileList(FileList *coherentFileList); + bool IsCoherent(FileList *fileSet); + void OrderFileList(FileList *fileSet); - /// \brief Gets the FIRST *coherent* File List. + /// \brief Gets the FIRST Single SerieUID Fileset. /// Deprecated; kept not to break the API /// \note Caller must call OrderFileList first - /// @return the (first) *coherent* File List - const FileList &GetFileList() { return *CoherentFileListHT.begin()->second; } + /// @return the (first) Single SerieUID Fileset + const FileList &GetFileList() + { return *SingleSerieUIDFileSetHT.begin()->second; } - FileList *GetFirstCoherentFileList(); - FileList *GetNextCoherentFileList(); - FileList *GetCoherentFileList(std::string serieUID); + GDCM_LEGACY( FileList *GetFirstCoherentFileList() ); + GDCM_LEGACY( FileList *GetNextCoherentFileList() ); + GDCM_LEGACY( FileList *GetCoherentFileList(std::string serieUID) ); + FileList *GetFirstSingleSerieUIDFileSet(); + FileList *GetNextSingleSerieUIDFileSet(); + FileList *GetSingleSerieUIDFileSet(std::string serieUID); + /// brief returns the 'Series Instance UID' Single SerieUID FileSet + std::string GetCurrentSerieUIDFileSetUID() + { return (*ItFileSetHt).first; } /// All the following allow user to restrict DICOM file to be part /// of a particular serie - GDCM_LEGACY( void AddRestriction(TagKey const &key, std::string const &value) ); - void AddRestriction(uint16_t group, uint16_t elem, - std::string const &value, int op); - + void AddRestriction(TagKey const &key, std::string const &value, int op); + + /// \brief Use additional series information such as ProtocolName + /// and SeriesName to identify when a single SeriesUID contains + /// multiple 3D volumes - as can occur with perfusion and DTI imaging + void SetUseSeriesDetails( bool useSeriesDetails ) + { m_UseSeriesDetails = useSeriesDetails;} + bool GetUseSeriesDetails( ){ return m_UseSeriesDetails; } + + // \brief Create a string that uniquely identifies a series. By default + // uses the SeriesUID. If UseSeriesDetails(true) has been called, + // then additional identifying information is used. + std::string CreateUniqueSeriesIdentifier( File * inFile ); + + /** * \brief Sets the LoadMode as a boolean string. - * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ - ... (nothing more, right now) - * WARNING : before using NO_SHADOW, be sure *all* your files + * LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ + * ... (nothing more, right now) + * WARNING : before using LD_NOSHADOW, be sure *all* your files * contain accurate values in the 0x0000 element (if any) * of *each* Shadow Group. The parser will fail if the size is wrong ! * @param mode Load mode to be used */ void SetLoadMode (int mode) { LoadMode = mode; } +/// Brief User wants the files to be sorted Direct Order (default value) + void SetSortOrderToDirect() { DirectOrder = true; } + +/// Brief User wants the files to be sorted Reverse Order + void SetSortOrderToReverse() { DirectOrder = false; } + + /// to allow user to give is own comparison function + void SetUserLessThanFunction( BOOL_FUNCTION_PFILE_PFILE_POINTER userFunc ) + { UserLessThanFunction = userFunc; } + + XCoherentFileSetmap SplitOnOrientation(FileList *fileSet); + XCoherentFileSetmap SplitOnPosition(FileList *fileSet); + XCoherentFileSetmap SplitOnTagValue(FileList *fileSet, + uint16_t group, uint16_t elem); +protected : + SerieHelper(); + private: - bool ImagePositionPatientOrdering(FileList *coherentFileList); - bool ImageNumberOrdering(FileList *coherentFileList); - bool FileNameOrdering(FileList *coherentFileList); + void ClearAll(); + bool UserOrdering(FileList *fileSet); + bool ImagePositionPatientOrdering(FileList *fileSet); + bool ImageNumberOrdering(FileList *fileSet); + bool FileNameOrdering(FileList *fileSet); static bool ImageNumberLessThan(File *file1, File *file2); + static bool ImageNumberGreaterThan(File *file1, File *file2); static bool FileNameLessThan(File *file1, File *file2); + static bool FileNameGreaterThan(File *file1, File *file2); //Attributes: - CoherentFileListmap CoherentFileListHT; - CoherentFileListmap::iterator ItListHt; - + + SingleSerieUIDFileSetmap SingleSerieUIDFileSetHT; + SingleSerieUIDFileSetmap::iterator ItFileSetHt; + typedef std::pair Rule; typedef std::vector SerieRestrictions; SerieRestrictions Restrictions; @@ -108,12 +174,22 @@ private: } ExRule; typedef std::vector SerieExRestrictions; SerieExRestrictions ExRestrictions; - + bool m_UseSeriesDetails; + /// \brief Bit string integer (each one considered as a boolean) /// Bit 0 : Skip Sequences, if possible /// Bit 1 : Skip Shadow Groups if possible /// Probabely, some more to add int LoadMode; + + /// \brief whether we want to sort in direct order or not (reverse order). + /// To be used by aware user only + bool DirectOrder; + + /// \brief If user knows more about his images than gdcm does, + /// he may supply his own comparison function. + BOOL_FUNCTION_PFILE_PFILE_POINTER UserLessThanFunction; + }; } // end namespace gdcm