X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=7a698763d2ea978b29def667c903e04d767582ea;hb=f7276083b636d98a16f347fde5916a3fca6855db;hp=7f3fb538fd985c26a8adf572c511b2b3dd710845;hpb=1a11accd11061d63d3c09db7b1445637207e81e4;p=gdcm.git diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index 7f3fb538..7a698763 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -1,103 +1,133 @@ -// gdcmDicomDir.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDicomDir.h,v $ + Language: C++ + Date: $Date: 2005/10/25 14:52:33 $ + Version: $Revision: 1.69 $ + + 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 GDCMDICOMDIR_H #define GDCMDICOMDIR_H -#include "gdcmHeader.h" -#include "gdcmCommon.h" -#include "gdcmDicomDirPatient.h" -#include "gdcmDicomDirMeta.h" -#include "gdcmDicomDirElement.h" +#include "gdcmDocument.h" +#include "gdcmDebug.h" #include #include +namespace gdcm +{ //----------------------------------------------------------------------------- -typedef std::list ListDicomDirPatient; -typedef std::vector ListHeader; +class DicomDirPatient; +class DicomDirMeta; +class DicomDirElement; +class DicomDirStudy; +class DicomDirSerie; +class DicomDirVisit; +class DicomDirImage; +class SQItem; + +typedef std::list ListDicomDirPatient; +typedef std::vector VectDocument; -typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL); //----------------------------------------------------------------------------- -/* - * \defgroup gdcmDicomDir - * \brief gdcmDicomDir defines an object representing a DICOMDIR in memory. - * +/** + * \brief DicomDir defines an object representing a DICOMDIR in memory + * as a tree-like structure DicomDirPatient + * -> DicomDirStudy + * -> DicomDirSerie + * -> DicomDirImage */ -class GDCM_EXPORT gdcmDicomDir: public gdcmParser +class GDCM_EXPORT DicomDir: public Document { + gdcmTypeMacro(DicomDir); + public: -// gdcmDicomDir(ListTag *l, -// bool exception_on_error = false); - gdcmDicomDir(const char *FileName, - bool parseDir = false, - bool exception_on_error = false); - gdcmDicomDir(bool exception_on_error = false); - - ~gdcmDicomDir(void); - - /** - * \ingroup gdcmParser - * \brief Sets the print level for the Dicom Header - * \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy - */ - void SetPrintLevel(int level) - { printLevel = level; }; - /** - * \ingroup gdcmParser - * \brief canonical Printer - * \sa SetPrintLevel - */ - virtual void Print(std::ostream &os = std::cout); - -// Informations contained in the parser - virtual bool IsReadable(void); -/** - * \ingroup gdcmDicomDir - * \brief returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. - */ - inline gdcmDicomDirMeta *GetDicomDirMeta() - {return metaElems;}; -/** - * \ingroup gdcmDicomDir - * \brief returns the PATIENT chained List for this DICOMDIR. - */ - inline ListDicomDirPatient &GetDicomDirPatients() - {return patients;}; - -// Parsing - void ParseDirectory(void); - void CheckBoundaries(void); + static DicomDir *New() {return new DicomDir();} + + typedef void Method(void*); + + GDCM_LEGACY( bool Load(std::string const &filename) ); + bool Load( ); + void Print(std::ostream &os = std::cout, std::string const &indent = "" ); - void SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL); - void SetStartMethodArgDelete(gdcmMethod *); - void SetProgressMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL); - void SetProgressMethodArgDelete(gdcmMethod *); - void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL); - void SetEndMethodArgDelete(gdcmMethod *); -/** - * \ingroup gdcmDicomDir - * \brief GetProgress. - */ - inline float GetProgress(void) - {return(progress);}; -/** - * \ingroup gdcmDicomDir - * \brief AbortProgress. - */ inline void AbortProgress(void) - {abort=true; }; -/** - * \ingroup gdcmDicomDir - * \brief IsAborted. - */ inline bool IsAborted(void) - {return(abort); }; + /// Sets the root Directory name to parse, recursively + void SetDirectoryName(std::string const &dirName) + { ParseDir = true; if (Filename != dirName) + Filename = dirName, IsDocumentModified = true; } + /// Accessor to \ref Filename + virtual void SetFileName(std::string const &fileName) + { ParseDir = false; if (Filename != fileName) + Filename = fileName, IsDocumentModified = true;} + + /// DEPRECATED : use SetDirectoryName + GDCM_LEGACY( void SetParseDir(bool parseDir) ); -// Adding - gdcmDicomDirPatient * NewPatient(void); + // Informations contained in the parser + virtual bool IsReadable(); + + // Meta + DicomDirMeta *NewMeta(); + /// Returns a pointer to the DicomDirMeta for this DICOMDIR. + DicomDirMeta *GetMeta() { return MetaElems; } -// Write - bool Write(std::string fileName); + // Patients + DicomDirPatient *NewPatient(); + void ClearPatient(); -// Types + DicomDirPatient *GetFirstPatient(); + DicomDirPatient *GetNextPatient(); + + // Parsing + void ParseDirectory(); + + // Note: the DicomDir:: namespace prefix is needed by Swig in the + // following method declarations. Refer to gdcmPython/gdcm.i + // for the reasons of this unnecessary notation at C++ level. + void SetStartMethod( DicomDir::Method *method, + void *arg = NULL ); + void SetProgressMethod( DicomDir::Method *method, + void *arg = NULL ); + void SetEndMethod( DicomDir::Method *method, + void *arg = NULL ); + // Note: replace DicomDir::Method *method to void(*method)(void *) to + // avoid wrapping problems with the typemap conversions + void SetStartMethod( void(*method)(void *), // DicomDir::Method *method + void *arg, + void(*argDelete)(void *)); + void SetProgressMethod( void(*method)(void *), // DicomDir::Method *method + void *arg, + void(*argDelete)(void *)); + void SetEndMethod( void(*method)(void *), // DicomDir::Method *method + void *arg, + void(*argDelete)(void *)); + void SetStartMethodArgDelete ( DicomDir::Method *method ); + void SetProgressMethodArgDelete( DicomDir::Method *method ); + void SetEndMethodArgDelete ( DicomDir::Method *method ); + + /// GetProgress GetProgress + float GetProgress() { return Progress; } + /// AbortProgress AbortProgress + void AbortProgress() { Abort = true; } + /// IsAborted IsAborted + bool IsAborted() { return Abort; } + + // Write + bool Write(std::string const &fileName); + + bool Anonymize(); + + /// Types of the DicomDirObject within the DicomDir typedef enum { GDCM_DICOMDIR_NONE, @@ -105,67 +135,69 @@ public: GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE, - GDCM_DICOMDIR_IMAGE, - } gdcmDicomDirType; + GDCM_DICOMDIR_VISIT, + GDCM_DICOMDIR_IMAGE + } DicomDirType; protected: - void CreateDicomDirChainedList(std::string path); + DicomDir(); + ~DicomDir(); - void CallStartMethod(void); - void CallProgressMethod(void); - void CallEndMethod(void); + void CreateDicomDirChainedList(std::string const &path); + void CallStartMethod(); + void CallProgressMethod(); + void CallEndMethod(); private: - void CreateDicomDir(void); - void AddObjectToEnd(gdcmDicomDirType type, - ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirMetaToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirPatientToEnd(ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirStudyToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirSerieToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirImageToEnd (ListTag::iterator begin,ListTag::iterator end); - - void SetElements(std::string &path,ListHeader &list); - void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header); - - void UpdateDirectoryRecordSequenceLength(void); + void Initialize(); + void CreateDicomDir(); + bool DoTheLoadingJob(); + bool AddPatientToEnd(DicomDirPatient *dd); + bool AddStudyToEnd (DicomDirStudy *dd); + bool AddSerieToEnd (DicomDirSerie *dd); + bool AddVisitToEnd (DicomDirVisit *dd); + bool AddImageToEnd (DicomDirImage *dd); - static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2); - void WriteDicomDirEntries(FILE *_fp); + void SetElements(std::string const &path, VectDocument const &list); + void SetElement (std::string const &path, DicomDirType type, + Document *header); + void MoveSQItem(DocEntrySet *dst, DocEntrySet *src); + + static bool HeaderLessThan(Document *header1, Document *header2); // Variables -/** -* \brief pointer on *the* gdcmObject 'DicomDirMeta Elements' -*/ - gdcmDicomDirMeta *metaElems; -/** -* \brief chained list of DicomDirPatient (to be exploited recursively) -*/ - ListDicomDirPatient patients; - -/// pointer to the initialisation method for any progress bar - gdcmMethod *startMethod; -/// pointer to the incrementation method for any progress bar - gdcmMethod *progressMethod; -/// pointer to the tremination method for any progress bar - gdcmMethod *endMethod; -/// pointer to the ??? method for any progress bar - gdcmMethod *startMethodArgDelete; -/// pointer to the ??? method for any progress bar - gdcmMethod *progressMethodArgDelete; -/// pointer to the ??? method for any progress bar - gdcmMethod *endMethodArgDelete; -/// pointer to the ??? for any progress bar - void *startArg; -/// pointer to the ??? for any progress bar - void *progressArg; -/// pointer to the ??? for any progress bar - void *endArg; -/// value of the ??? for any progress bar - float progress; -/// value of the ??? for any progress bar - bool abort; -}; + /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements' + DicomDirMeta *MetaElems; + + /// Chained list of DicomDirPatient (to be exploited hierarchicaly) + ListDicomDirPatient Patients; + ListDicomDirPatient::iterator ItPatient; + + /// pointer to the initialisation method for any progress bar + Method *StartMethod; + /// pointer to the incrementation method for any progress bar + Method *ProgressMethod; + /// pointer to the termination method for any progress bar + Method *EndMethod; + /// pointer to the ??? method for any progress bar + Method *StartMethodArgDelete; + /// pointer to the ??? method for any progress bar + Method* ProgressMethodArgDelete; + /// pointer to the ??? method for any progress bar + Method *EndMethodArgDelete; + /// pointer to the ??? for any progress bar + void *StartArg; + /// pointer to the ??? for any progress bar + void *ProgressArg; + /// pointer to the ??? for any progress bar + void *EndArg; + /// value of the ??? for any progress bar + float Progress; + /// value of the ??? for any progress bar + bool Abort; + bool ParseDir; +}; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif