Program: gdcm
Module: $RCSfile: gdcmSerieHelper.h,v $
Language: C++
- Date: $Date: 2005/10/19 13:17:05 $
- Version: $Revision: 1.24 $
+ Date: $Date: 2005/11/28 16:31:23 $
+ Version: $Revision: 1.32 $
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
namespace gdcm
{
class File;
-typedef std::vector<File* > FileList;
- /// 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 std::vector<File* > FileList;
-typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
+ /// \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' lists (coherent : same SerieUID)
- * It allows :
- * - to sort any of the Coherent File list on the image position.
- * - to split any of the Single SerieUID Filesets (better use this name than
- * 'Coherent File List' : it's NOT a std::list, files are NOT coherent ...)
+ * 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:
- // SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
- // ( List were actually std::vectors, and wher no coherent at all :
- // They were only Single SeriesInstanceUID File sets)
+ /// 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 ?
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.
XCoherentFileSetmap SplitOnOrientation(FileList *fileSet);
XCoherentFileSetmap SplitOnPosition(FileList *fileSet);
XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
- uint16_t group, uint16_t element);
+ uint16_t group, uint16_t elem);
+protected :
+ SerieHelper();
+
private:
void ClearAll();
bool UserOrdering(FileList *fileSet);
} ExRule;
typedef std::vector<ExRule> 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
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff