Doxygenation

[gdcm.git] / src / gdcmSerieHelper.h

diff --git a/src/gdcmSerieHelper.h b/src/gdcmSerieHelper.h
index 9376c17ec9f2d9b031b7d1597bd71bf860dd340f..b4e15a3033bfdf4714ab27862312fe1acbd9e683 100644 (file)
--- a/src/gdcmSerieHelper.h
+++ b/src/gdcmSerieHelper.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/02/06 14:43:28 $
-  Version:   $Revision: 1.6 $
+  Date:      $Date: 2005/07/17 04:26:57 $
+  Version:   $Revision: 1.12 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,7 +28,7 @@
 namespace gdcm 
 {
 class File;
-typedef std::vector<File* > GdcmFileList;
+typedef std::vector<File* > FileList;
 
 //-----------------------------------------------------------------------------
 /**
@@ -36,13 +36,13 @@ typedef std::vector<File* > GdcmFileList;
  * - 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 postion
+ *   It allows to sort any of the Coherent File list on the image position
  */
 class GDCM_EXPORT SerieHelper 
 {
 public:
-   typedef std::map<std::string, GdcmFileList *> CoherentFileListmap;
-   typedef std::vector<File* > GdcmFileVector;
+   typedef std::map<std::string, FileList *> CoherentFileListmap;
+   typedef std::vector<File* > FileVector;
 
    SerieHelper();
    ~SerieHelper();
@@ -51,28 +51,54 @@ public:
    /// \todo should return bool or throw error ?
    void AddFileName(std::string const &filename);
    void SetDirectory(std::string const &dir, bool recursive=false);
-   void OrderGdcmFileList(GdcmFileList *CoherentGdcmFileList);
+   void OrderFileList(FileList *coherentFileList);
    
    /// \brief Gets the FIRST *coherent* File List.
    ///        Deprecated; kept not to break the API
-   /// \note Caller must call OrderGdcmFileList first
+   /// \note Caller must call OrderFileList first
    /// @return the (first) *coherent* File List
-   const GdcmFileList &GetGdcmFileList() { return
-                       *CoherentGdcmFileListHT.begin()->second; }
+   const FileList &GetFileList() { return *CoherentFileListHT.begin()->second; }
   
-   GdcmFileList *GetFirstCoherentFileList();
-   GdcmFileList *GetNextCoherentFileList();
-   GdcmFileList *GetCoherentFileList(std::string SerieUID);
+   FileList *GetFirstCoherentFileList();
+   FileList *GetNextCoherentFileList();
+   FileList *GetCoherentFileList(std::string serieUID);
+
+   /// All the following allow user to restrict DICOM file to be part
+   /// of a particular serie
+   void AddRestriction(TagKey const &key, std::string const &value);
+  
+/**
+ * \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
+ *        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; }
 
 private:
-   bool ImagePositionPatientOrdering(GdcmFileList *CoherentGdcmFileList);
-   bool ImageNumberOrdering(GdcmFileList *CoherentGdcmFileList);
-   bool FileNameOrdering(GdcmFileList *CoherentGdcmFileList);
+   bool ImagePositionPatientOrdering(FileList *coherentFileList);
+   bool ImageNumberOrdering(FileList *coherentFileList);
+   bool FileNameOrdering(FileList *coherentFileList);
    
    static bool ImageNumberLessThan(File *file1, File *file2);
    static bool FileNameLessThan(File *file1, File *file2);
-   CoherentFileListmap CoherentGdcmFileListHT;
+
+//Attributes:
+   CoherentFileListmap CoherentFileListHT;
    CoherentFileListmap::iterator ItListHt;
+
+   typedef std::pair<TagKey, std::string> Rule;
+   typedef std::vector<Rule> SerieRestrictions;
+   SerieRestrictions Restrictions;
+
+   /// \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;
 };
 
 } // end namespace gdcm