gdcmSerieHelper.h

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmSerieHelper.h,v $
  Language:  C++
  Date:      $Date: 2007/08/22 16:14:04 $
  Version:   $Revision: 1.44 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
                                                                                
=========================================================================*/

#ifndef _GDCMSERIEHELPER_H_
#define _GDCMSERIEHELPER_H_

#include "gdcmRefCounter.h"
#include "gdcmTagKey.h" 
#include "gdcmDebug.h"  // for LEGACY

#include "gdcmDicomDirSerie.h"
 
#include <vector>
#include <iostream>
#include <map>

namespace GDCM_NAME_SPACE 
{
class File;

   typedef std::vector<File* > FileList;
#ifndef GDCM_LEGACY_REMOVE
typedef std::vector<File* > GdcmFileList;
#endif

   typedef std::map<std::string, FileList *> XCoherentFileSetmap;

   typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);

//-----------------------------------------------------------------------------
class GDCM_EXPORT SerieHelper  : public RefCounter
{
   gdcmTypeMacro(SerieHelper);
   
public:
   typedef std::map<std::string, FileList *> SingleSerieUIDFileSetmap;

   typedef std::vector<File* > FileVector;

    static SerieHelper *New() {return new SerieHelper();}
     
   virtual ~SerieHelper();
   void Print(std::ostream &os = std::cout, std::string const &indent = "" );

   void AddFileName(std::string const &filename);
   bool AddFile(File *header);
 //  GDCM_LEGACY(bool AddGdcmFile(File* header))

   void SetDirectory(std::string const &dir, bool recursive=false);
   void SetDicomDirSerie(DicomDirSerie *se);
      
   bool IsCoherent(FileList *fileSet);
   void OrderFileList(FileList *fileSet);
   void Clear() { ClearAll(); }

   const FileList &GetFileList()
                           { return *SingleSerieUIDFileSetHT.begin()->second; }
  
 //  GDCM_LEGACY(   FileList *GetFirstCoherentFileList()  )
 //  GDCM_LEGACY(   FileList *GetNextCoherentFileList()   )
 //  GDCM_LEGACY(   FileList *GetCoherentFileList(std::string serieUID)  )

   FileList *GetFirstSingleSerieUIDFileSet();
   FileList *GetNextSingleSerieUIDFileSet();
   FileList *GetSingleSerieUIDFileSet(std::string serieUID);
   std::string GetCurrentSerieUIDFileSetUID()
                             { return  (*ItFileSetHt).first; }
     
   double GetZSpacing() { return ZSpacing; }
   
   void AddRestriction(TagKey const &key);
   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);

   void SetUseSeriesDetails( bool useSeriesDetails )
     {
     m_UseSeriesDetails = useSeriesDetails;
     }
   bool GetUseSeriesDetails()
     {
     return m_UseSeriesDetails;
     }
   void CreateDefaultUniqueSeriesIdentifier();

   void AddSeriesDetail(uint16_t group, uint16_t elem, bool convert);

   std::string CreateUserDefinedFileIdentifier( File * inFile );

   //         uses the SeriesUID.   If UseSeriesDetails(true) has been called,
   //         then additional identifying information is used.
   std::string CreateUniqueSeriesIdentifier( File * inFile );
 
   void SetLoadMode (int mode) { LoadMode = mode; }
   
   void SetDropDuplicatePositions (bool drop) { DropDuplicatePositions = drop; }   

   void SetSortOrderToDirect()  { DirectOrder = true;  }

   void SetSortOrderToReverse() { DirectOrder = false; }

   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 element);
protected :
   SerieHelper();
   
private:
   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:
   
   SingleSerieUIDFileSetmap SingleSerieUIDFileSetHT;
   SingleSerieUIDFileSetmap::iterator ItFileSetHt;

#ifndef GDCM_LEGACY_REMOVE
   typedef std::pair<TagKey, std::string> Rule;
   typedef std::vector<Rule> SerieRestrictions;
   SerieRestrictions Restrictions;
#endif

   // New style for (extented) Rules
   typedef struct {
      uint16_t group;
      uint16_t elem;
      std::string value;
      int op;
   } ExRule;
   typedef std::vector<ExRule> SerieExRestrictions;
   SerieExRestrictions ExRestrictions;
   SerieExRestrictions ExRefine;

   typedef struct {
      uint16_t group;
      uint16_t elem;
      bool convert;
   } ExDetail;
   typedef std::vector<ExDetail> SeriesExDetails; 
   SeriesExDetails ExDetails;
    
   
   int LoadMode;

   bool DirectOrder;

   BOOL_FUNCTION_PFILE_PFILE_POINTER UserLessThanFunction;

   bool DropDuplicatePositions;

   void Sort(FileList *fileList, bool (*pt2Func)( File *file1, File *file2) );

   bool m_UseSeriesDetails;
   double ZSpacing; 
};

} // end namespace gdcm

//-----------------------------------------------------------------------------
#endif

---