Program: gdcm
Module: $RCSfile: gdcmSerieHelper.h,v $
Language: C++
- Date: $Date: 2005/09/06 16:22:18 $
- Version: $Revision: 1.20 $
+ Date: $Date: 2005/12/16 13:48:46 $
+ Version: $Revision: 1.34 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#ifndef GDCMSERIEHELPER_H
#define GDCMSERIEHELPER_H
-#include "gdcmCommon.h"
+#include "gdcmRefCounter.h"
+#include "gdcmTagKey.h"
#include "gdcmDebug.h" // for LEGACY
#include <vector>
namespace gdcm
{
class File;
-typedef std::vector<File* > FileList;
-typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
+ typedef std::vector<File* > 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<std::string, FileList *> 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 RefCounter
{
+ gdcmTypeMacro(SerieHelper);
+
public:
- typedef std::map<std::string, FileList *> 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<std::string, FileList *> SingleSerieUIDFileSetmap;
+
typedef std::vector<File* > 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 ?
void AddGdcmFile(File *header);
void SetDirectory(std::string const &dir, bool recursive=false);
- bool IsCoherent(FileList *coherentFileList);
- 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);
-
+ /// \todo : find a trick to allow user to say the retrictetons are ored
+ /// (not only anded)
+ /// ex : keep the images whose SerieNumber is 101 or 102 or 103.
+ void AddRestriction(TagKey const &key, std::string const &value, int op);
+ void AddRestriction(uint16_t group, uint16_t elem, 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; }
+
+ void AddSeriesDetail(uint16_t group, uint16_t elem);
+
+ // \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.
* LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
/// to allow user to give is own comparison function
void SetUserLessThanFunction( BOOL_FUNCTION_PFILE_PFILE_POINTER userFunc )
- { UserLessThanFunction = 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 UserOrdering(FileList *coherentFileList);
- 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 FileNameGreaterThan(File *file1, File *file2);
//Attributes:
- CoherentFileListmap CoherentFileListHT;
- CoherentFileListmap::iterator ItListHt;
-
+
+ SingleSerieUIDFileSetmap SingleSerieUIDFileSetHT;
+ SingleSerieUIDFileSetmap::iterator ItFileSetHt;
+
typedef std::pair<TagKey, std::string> Rule;
typedef std::vector<Rule> SerieRestrictions;
SerieRestrictions Restrictions;
- // New style for (extented) Rules (Moreover old one doesn't compile)
+ // New style for (extented) Rules
typedef struct {
uint16_t group;
uint16_t elem;
} ExRule;
typedef std::vector<ExRule> SerieExRestrictions;
SerieExRestrictions ExRestrictions;
-
+
+ typedef struct {
+ uint16_t group;
+ uint16_t elem;
+ } ExDetail;
+ typedef std::vector<ExDetail> SeriesExDetails;
+ SeriesExDetails ExDetails;
+
+ 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
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff