X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.cxx;h=bcdc5ad1d3ab78710ea694881b1d810ba088f923;hb=34e322ceb4e12797e6d4cb1e691a36425015d2e0;hp=27b840f24c2b20d3bcabb7935ba0f3812827fafb;hpb=7ab309d561964c2ab5f9cd5d51d2fb212cd5dfcb;p=gdcm.git diff --git a/src/gdcmDicomDir.cxx b/src/gdcmDicomDir.cxx index 27b840f2..bcdc5ad1 100644 --- a/src/gdcmDicomDir.cxx +++ b/src/gdcmDicomDir.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDir.cxx,v $ Language: C++ - Date: $Date: 2005/04/14 14:26:19 $ - Version: $Revision: 1.137 $ + Date: $Date: 2005/07/23 01:59:21 $ + Version: $Revision: 1.152 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -21,8 +21,10 @@ // PS 3.3-2003, pages 731-750 //----------------------------------------------------------------------------- #include "gdcmDicomDir.h" +#include "gdcmDicomDirObject.h" #include "gdcmDicomDirStudy.h" #include "gdcmDicomDirSerie.h" +#include "gdcmDicomDirVisit.h" #include "gdcmDicomDirImage.h" #include "gdcmDicomDirPatient.h" #include "gdcmDicomDirMeta.h" @@ -60,17 +62,18 @@ // Directory Record Type Directory Record Types which may be included // in the next lower-level directory Entity // -// (Root directory Entity) PATIENT +// (Root directory Entity) PATIENT, TOPIC, PRIVATE // -// PATIENT STUDY +// PATIENT STUDY, PRIVATE // -// STUDY SERIES, VISIT, RESULTS, STUDY COMPONENT +// STUDY SERIES, VISIT, RESULTS, STUDY COMPONENT, PRIVATE // // SERIES IMAGE, OVERLAYS, MODALITY LUT, VOI LUT, // CURVE, STORED PRINT, RT DOSE, RT STRUCTURE SET // RT PLAN, RT TREAT RECORD, PRESENTATION, WAVEFORM, // SR DOCUMENT, KEY OBJECT DOC, SPECTROSCOPY, -// RAW DATA, REGISTRATION, FIDUCIAL +// RAW DATA, REGISTRATION, FIDUCIAL, PRIVATE, +// ENCAP DOC // IMAGE // OVERLAY // MODALITY LUT @@ -89,6 +92,8 @@ // RAW DATA // REGISTRATION // FIDUCIAL +// PRIVATE +// ENCAP DOC // // ---------------------- // The current gdcm version only deals with : @@ -114,9 +119,11 @@ DicomDir::DicomDir() :Document( ) { Initialize(); // sets all private fields to NULL + ParseDir = false; NewMeta(); } +#ifndef GDCM_LEGACY_REMOVE /** * \brief Constructor Parses recursively the directory and creates the DicomDir * or uses an already built DICOMDIR, depending on 'parseDir' value. @@ -128,19 +135,23 @@ DicomDir::DicomDir() * and wants to explore recursively the directories * - false if user passed an already built DICOMDIR file * and wants to use it + * @deprecated use : new DicomDir() + [ SetLoadMode(lm) + ] SetDirectoryName(name) + * or : new DicomDir() + SetFileName(name) */ DicomDir::DicomDir(std::string const &fileName, bool parseDir ): Document( ) { // At this step, Document constructor is already executed, - // whatever user passed (a root directory or a DICOMDIR) + // whatever user passed (either a root directory or a DICOMDIR) // and whatever the value of parseDir was. // (nothing is cheked in Document constructor, to avoid overhead) ParseDir = parseDir; SetLoadMode (0x00000000); // concerns only dicom files - Load( fileName ); + SetFileName( fileName ); + Load( ); } +#endif /** * \brief Canonical destructor @@ -161,11 +172,62 @@ DicomDir::~DicomDir() //----------------------------------------------------------------------------- // Public -void DicomDir::Load(std::string const &fileName ) +/** + * \brief Loader. use SetFileName(fn) + * or SetLoadMode(lm) + SetDirectoryName(dn) before ! + * @return false if file cannot be open or no swap info was found, + * or no tag was found. + */ +bool DicomDir::Load( ) { - Filename = fileName; // We should clean out anything that already exists. + Initialize(); // sets all private fields to NULL + + if (!ParseDir) + { + if ( ! this->Document::Load( ) ) + return false; + } + return DoTheLoadingJob( ); +} + #ifndef GDCM_LEGACY_REMOVE +/** + * \brief Loader. (DEPRECATED : kept not to break the API) + * @param fileName file to be open for parsing + * @return false if file cannot be open or no swap info was found, + * or no tag was found. + * @deprecated use SetFileName(n) + Load() instead + */ +bool DicomDir::Load(std::string const &fileName ) +{ + // We should clean out anything that already exists. + Initialize(); // sets all private fields to NULL + + SetFileName( fileName ); + if (!ParseDir) + { + if ( ! this->Document::Load( ) ) + return false; + } + return DoTheLoadingJob( ); +} + +/// DEPRECATED : use SetDirectoryName(dname) instead +void DicomDir::SetParseDir(bool parseDir) +{ + ParseDir = parseDir; +} +#endif + +/** + * \brief Does the Loading Job (internal use only) + * @return false if file cannot be open or no swap info was found, + * or no tag was found. + */ +bool DicomDir::DoTheLoadingJob( ) +{ + // We should clean out anything that already exists. Initialize(); // sets all private fields to NULL if (!ParseDir) @@ -175,20 +237,25 @@ void DicomDir::Load(std::string const &fileName ) Fp = 0; if ( !OpenFile() ) { - return; + return false; } - Document::Load(fileName); + if (!Document::Load() ) + { + return false; + } + if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse { - gdcmWarningMacro( "Entry HT empty for file: "<< fileName); - return; + gdcmWarningMacro( "Entry HT empty for file: "<< GetFileName()); + return false; } // Directory record sequence DocEntry *e = GetDocEntry(0x0004, 0x1220); if ( !e ) { gdcmWarningMacro( "NO 'Directory record sequence' (0x0004,0x1220)" - << " in file " << fileName); + << " in file " << GetFileName()); + return false; } else CreateDicomDir(); @@ -197,7 +264,7 @@ void DicomDir::Load(std::string const &fileName ) { // Only if user passed a root directory // ------------------------------------ - if ( fileName == "." ) + if ( GetFileName() == "." ) { // user passed '.' as Name // we get current directory name @@ -206,9 +273,11 @@ void DicomDir::Load(std::string const &fileName ) SetFileName( dummy ); // will be converted into a string } NewMeta(); - gdcmWarningMacro( "Parse directory and create the DicomDir : " << Filename ); + gdcmWarningMacro( "Parse directory and create the DicomDir : " + << GetFileName() ); ParseDirectory(); } + return true; } /** @@ -221,17 +290,17 @@ void DicomDir::Load(std::string const &fileName ) */ bool DicomDir::IsReadable() { - if( Filetype == Unknown) + if ( Filetype == Unknown ) { gdcmWarningMacro( "Wrong filetype"); return false; } - if( !MetaElems ) + if ( !MetaElems ) { gdcmWarningMacro( "Meta Elements missing in DicomDir"); return false; } - if( Patients.size() <= 0 ) + if ( Patients.size() <= 0 ) { gdcmWarningMacro( "NO Patient in DicomDir"); return false; @@ -245,18 +314,18 @@ bool DicomDir::IsReadable() */ DicomDirMeta *DicomDir::NewMeta() { - if( MetaElems ) + if ( MetaElems ) delete MetaElems; DocEntry *entry = GetFirstEntry(); - if( entry ) + if ( entry ) { - MetaElems = new DicomDirMeta(true); + MetaElems = new DicomDirMeta(true); // true = empty entry = GetFirstEntry(); while( entry ) { - if( dynamic_cast(entry) ) + if ( dynamic_cast(entry) ) break; RemoveEntryNoDestroy(entry); @@ -267,7 +336,7 @@ DicomDirMeta *DicomDir::NewMeta() } else // after root directory parsing { - MetaElems = new DicomDirMeta(false); + MetaElems = new DicomDirMeta(false); // false = not empty } MetaElems->SetSQItemNumber(0); // To avoid further missprinting return MetaElems; @@ -345,7 +414,7 @@ void DicomDir::ParseDirectory() void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg, DicomDir::Method *argDelete ) { - if( StartArg && StartMethodArgDelete ) + if ( StartArg && StartMethodArgDelete ) { StartMethodArgDelete( StartArg ); } @@ -367,7 +436,7 @@ void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg, void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg, DicomDir::Method *argDelete ) { - if( ProgressArg && ProgressMethodArgDelete ) + if ( ProgressArg && ProgressMethodArgDelete ) { ProgressMethodArgDelete( ProgressArg ); } @@ -387,7 +456,7 @@ void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg, void DicomDir::SetEndMethod( DicomDir::Method *method, void *arg, DicomDir::Method *argDelete ) { - if( EndArg && EndMethodArgDelete ) + if ( EndArg && EndMethodArgDelete ) { EndMethodArgDelete( EndArg ); } @@ -446,7 +515,7 @@ bool DicomDir::WriteDicomDir(std::string const &fileName) std::ofstream *fp = new std::ofstream(fileName.c_str(), std::ios::out | std::ios::binary); - if( !fp ) + if ( !fp ) { gdcmWarningMacro("Failed to open(write) File: " << fileName.c_str()); return false; @@ -524,14 +593,6 @@ bool DicomDir::AnonymizeDicomDir() return true; } - - - - - - - - //----------------------------------------------------------------------------- // Protected /** @@ -554,22 +615,24 @@ void DicomDir::CreateDicomDirChainedList(std::string const &path) { Progress = (float)(count+1)/(float)fileList.size(); CallProgressMethod(); - if( Abort ) + if ( Abort ) { break; } f = new File( ); - f->SetLoadMode(LoadMode); // we allow user not to load Sequences... - f->Load( it->c_str() ); + f->SetLoadMode(LoadMode); // we allow user not to load Sequences, or Shadow + // groups, or ...... + f->SetFileName( it->c_str() ); + /*int res = */f->Load( ); -// if( !f ) +// if ( !f ) // { // gdcmWarningMacro( "Failure in new gdcm::File " << it->c_str() ); // continue; // } - if( f->IsReadable() ) + if ( f->IsReadable() ) { // Add the file to the chained list: list.push_back(f); @@ -604,7 +667,7 @@ void DicomDir::CallStartMethod() { Progress = 0.0f; Abort = false; - if( StartMethod ) + if ( StartMethod ) { StartMethod( StartArg ); } @@ -615,7 +678,7 @@ void DicomDir::CallStartMethod() */ void DicomDir::CallProgressMethod() { - if( ProgressMethod ) + if ( ProgressMethod ) { ProgressMethod( ProgressArg ); } @@ -627,7 +690,7 @@ void DicomDir::CallProgressMethod() void DicomDir::CallEndMethod() { Progress = 1.0f; - if( EndMethod ) + if ( EndMethod ) { EndMethod( EndArg ); } @@ -704,54 +767,76 @@ void DicomDir::CreateDicomDir() continue; } - if( v == "PATIENT " ) + // A decent DICOMDIR has much more images than series, + // more series than studies, and so on. + // This is the right order to preform the tests + + if ( v == "IMAGE " ) { - si = new DicomDirPatient(true); - if( !AddPatientToEnd( static_cast(si)) ) + si = new DicomDirImage(true); + if ( !AddImageToEnd( static_cast(si)) ) { delete si; si = NULL; - gdcmErrorMacro( "Add PatientToEnd failed"); + gdcmErrorMacro( "Add AddImageToEnd failed"); } } - else if( v == "STUDY " ) + else if ( v == "SERIES" ) { - si = new DicomDirStudy(true); - if( !AddStudyToEnd( static_cast(si)) ) + si = new DicomDirSerie(true); + if ( !AddSerieToEnd( static_cast(si)) ) { delete si; si = NULL; - gdcmErrorMacro( "Add AddStudyToEnd failed"); + gdcmErrorMacro( "Add AddSerieToEnd failed"); } } - else if( v == "SERIES" ) + else if ( v == "VISIT " ) { - si = new DicomDirSerie(true); - if( !AddSerieToEnd( static_cast(si)) ) + si = new DicomDirVisit(true); + if ( !AddVisitToEnd( static_cast(si)) ) { delete si; si = NULL; - gdcmErrorMacro( "Add AddSerieToEnd failed"); + gdcmErrorMacro( "Add AddVisitToEnd failed"); } } - else if( v == "IMAGE " ) + else if ( v == "STUDY " ) { - si = new DicomDirImage(true); - if( !AddImageToEnd( static_cast(si)) ) + si = new DicomDirStudy(true); + if ( !AddStudyToEnd( static_cast(si)) ) { delete si; si = NULL; - gdcmErrorMacro( "Add AddImageToEnd failed"); + gdcmErrorMacro( "Add AddStudyToEnd failed"); + } + } + else if ( v == "PATIENT " ) + { + si = new DicomDirPatient(true); + if ( !AddPatientToEnd( static_cast(si)) ) + { + delete si; + si = NULL; + gdcmErrorMacro( "Add PatientToEnd failed"); } } else { - // It was not a 'PATIENT', nor a 'STUDY', nor a 'SERIE', - // neither an 'IMAGE' SQItem. Skip to next item. - continue; + // It was neither a 'PATIENT', nor a 'STUDY', nor a 'SERIE', + // nor an 'IMAGE' SQItem. Skip to next item. + gdcmWarningMacro( " -------------------------------------------" + << "a non PATIENT/STUDY/SERIE/IMAGE SQItem was found : " + << v); + + // FIXME : deal with other item types ! + tmpSI=s->GetNextSQItem(); // To avoid infinite loop + continue; } - if( si ) - MoveSQItem(si,tmpSI); + if ( si ) + //MoveSQItem(si,tmpSI); // Old code : Copies each Entry + // -and then removes the source- + si->MoveObject(tmpSI); // New code : Copies the List tmpSI=s->GetNextSQItem(); } @@ -774,7 +859,7 @@ bool DicomDir::AddPatientToEnd(DicomDirPatient *dd) */ bool DicomDir::AddStudyToEnd(DicomDirStudy *dd) { - if( Patients.size() > 0 ) + if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; @@ -790,13 +875,13 @@ bool DicomDir::AddStudyToEnd(DicomDirStudy *dd) */ bool DicomDir::AddSerieToEnd(DicomDirSerie *dd) { - if( Patients.size() > 0 ) + if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; DicomDirStudy *study = (*itp)->GetLastStudy(); - if( study ) + if ( study ) { study->AddSerie(dd); return true; @@ -805,22 +890,42 @@ bool DicomDir::AddSerieToEnd(DicomDirSerie *dd) return false; } +/** + * \brief AddVisitToEnd + * @param dd SQ Item to enqueue to the DicomDirVisit chained List + */ +bool DicomDir::AddVisitToEnd(DicomDirVisit *dd) +{ + if ( Patients.size() > 0 ) + { + ListDicomDirPatient::iterator itp = Patients.end(); + itp--; + + DicomDirStudy *study = (*itp)->GetLastStudy(); + if ( study ) + { + study->AddVisit(dd); + return true; + } + } + return false; +} /** * \brief AddImageToEnd * @param dd SQ Item to enqueue to the DicomDirImage chained List */ bool DicomDir::AddImageToEnd(DicomDirImage *dd) { - if( Patients.size() > 0 ) + if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; DicomDirStudy *study = (*itp)->GetLastStudy(); - if( study ) + if ( study ) { DicomDirSerie *serie = study->GetLastSerie(); - if( serie ) + if ( serie ) { serie->AddImage(dd); return true; @@ -862,22 +967,22 @@ void DicomDir::SetElements(std::string const &path, VectDocument const &list) serCurInstanceUID = (*it)->GetEntryValue(0x0020,0x000e); serCurID = (*it)->GetEntryValue(0x0020,0x0011); - if( patCurName != patPrevName || patCurID != patPrevID || first ) + if ( patCurName != patPrevName || patCurID != patPrevID || first ) { SetElement(path, GDCM_DICOMDIR_PATIENT, *it); first = true; } - // if new Study Deal with 'STUDY' Elements - if( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID + // if new Study, deal with 'STUDY' Elements + if ( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID || first ) { SetElement(path, GDCM_DICOMDIR_STUDY, *it); first = true; } - // if new Serie Deal with 'SERIE' Elements - if( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID + // if new Serie, deal with 'SERIE' Elements + if ( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID || first ) { SetElement(path, GDCM_DICOMDIR_SERIE, *it); @@ -920,7 +1025,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, case GDCM_DICOMDIR_IMAGE: elemList = Global::GetDicomDirElements()->GetDicomDirImageElements(); si = new DicomDirImage(true); - if( !AddImageToEnd(static_cast(si)) ) + if ( !AddImageToEnd(static_cast(si)) ) { delete si; gdcmErrorMacro( "Add ImageToEnd failed"); @@ -929,7 +1034,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, case GDCM_DICOMDIR_SERIE: elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements(); si = new DicomDirSerie(true); - if( !AddSerieToEnd(static_cast(si)) ) + if ( !AddSerieToEnd(static_cast(si)) ) { delete si; gdcmErrorMacro( "Add SerieToEnd failed"); @@ -938,7 +1043,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, case GDCM_DICOMDIR_STUDY: elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements(); si = new DicomDirStudy(true); - if( !AddStudyToEnd(static_cast(si)) ) + if ( !AddStudyToEnd(static_cast(si)) ) { delete si; gdcmErrorMacro( "Add StudyToEnd failed"); @@ -947,7 +1052,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, case GDCM_DICOMDIR_PATIENT: elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements(); si = new DicomDirPatient(true); - if( !AddPatientToEnd(static_cast(si)) ) + if ( !AddPatientToEnd(static_cast(si)) ) { delete si; gdcmErrorMacro( "Add PatientToEnd failed"); @@ -956,7 +1061,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, case GDCM_DICOMDIR_META: elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements(); si = new DicomDirMeta(true); - if( MetaElems ) + if ( MetaElems ) { delete MetaElems; gdcmErrorMacro( "MetaElements already exist, they will be destroyed"); @@ -987,7 +1092,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, entry->SetOffset(0); // just to avoid further missprinting - if( header ) + if ( header ) { // NULL when we Build Up (ex nihilo) a DICOMDIR // or when we add the META elems @@ -998,16 +1103,16 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, val = GDCM_UNFOUND; } - if( val == GDCM_UNFOUND) + if ( val == GDCM_UNFOUND) { - if( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID + if ( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID { // force to the *end* File Name val = Util::GetName( path ); } - else if( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image + else if ( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image { - if( header->GetFileName().substr(0, path.length()) != path ) + if ( header->GetFileName().substr(0, path.length()) != path ) { gdcmWarningMacro( "The base path of file name is incorrect"); val = header->GetFileName(); @@ -1045,7 +1150,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, * @param src source SQItem */ void DicomDir::MoveSQItem(DocEntrySet *dst,DocEntrySet *src) -{ +{ DocEntry *entry; entry = src->GetFirstEntry(); @@ -1075,7 +1180,7 @@ bool DicomDir::HeaderLessThan(Document *header1, Document *header2) */ void DicomDir::Print(std::ostream &os, std::string const & ) { - if( MetaElems ) + if ( MetaElems ) { MetaElems->SetPrintLevel(PrintLevel); MetaElems->Print(os);