Program: gdcm
Module: $RCSfile: gdcmDicomDir.cxx,v $
Language: C++
- Date: $Date: 2005/02/11 16:55:39 $
- Version: $Revision: 1.132 $
+ Date: $Date: 2005/07/07 16:37:40 $
+ Version: $Revision: 1.144 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
// ----------------------------------------------------------------------------
//
// Dicom PS 3.3 describes the relationship between Directory Records, as follow
+// (see also PS 4.3, 2004, page 50 for Entity-Relationship model)
//
// 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
// RAW DATA
// REGISTRATION
// FIDUCIAL
+// PRIVATE
+// ENCAP DOC
//
// ----------------------
// The current gdcm version only deals with :
* and wants to use it
*/
DicomDir::DicomDir(std::string const &fileName, bool parseDir ):
- Document( fileName )
+ 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 );
+}
+
+/**
+ * \brief Canonical destructor
+ */
+DicomDir::~DicomDir()
+{
+ SetStartMethod(NULL);
+ SetProgressMethod(NULL);
+ SetEndMethod(NULL);
+
+ ClearPatient();
+ if ( MetaElems )
+ {
+ delete MetaElems;
+ }
+}
+
+//-----------------------------------------------------------------------------
+// Public
+
+/**
+ * \brief Loader. use SetLoadMode(), SetFileName() before !
+ * @return false if file cannot be open or no swap info was found,
+ * or no tag was found.
+ */
+bool DicomDir::Load( )
+{
+ // We should clean out anything that already exists.
Initialize(); // sets all private fields to NULL
- // if user passed a root directory, sure we didn't get anything
+ if (!ParseDir)
+ {
+ if ( ! this->Document::Load( ) )
+ return false;
+ }
+ return DoTheLoadingJob( );
+}
+
+/**
+ * \brief Loader. (DEPRECATED : 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.
+ */
+bool DicomDir::Load(std::string const &fileName )
+{
+ // We should clean out anything that already exists.
+ Initialize(); // sets all private fields to NULL
- if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse
+ SetFileName( fileName );
+ if (!ParseDir)
{
- if (!parseDir)
- gdcmWarningMacro( "Entry HT empty for file: "<<fileName);
+ if ( ! this->Document::Load( ) )
+ return false;
+ }
+ return DoTheLoadingJob( );
+}
- // Only if user passed a root directory
- // ------------------------------------
- if ( fileName == "." )
+/**
+ * \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)
+ {
+ // Only if user passed a DICOMDIR
+ // ------------------------------
+ Fp = 0;
+ if ( !OpenFile() )
{
- // user passed '.' as Name
- // we get current directory name
- char dummy[1000];
- getcwd(dummy, (size_t)1000);
- SetFileName( dummy ); // will be converted into a string
+ return false;
}
-
- if ( parseDir ) // user asked for a recursive parsing of a root directory
+ if (!Document::Load() )
{
- NewMeta();
-
- gdcmWarningMacro( "Parse directory and create the DicomDir");
- ParseDirectory();
+ return false;
}
- else
+
+ if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse
{
- // user may just call ParseDirectory() *after* constructor
+ gdcmWarningMacro( "Entry HT empty for file: "<< GetFileName());
+ return false;
}
- }
- // Only if user passed a DICOMDIR
- // ------------------------------
- else
- {
// 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();
}
-}
-
-/**
- * \brief Canonical destructor
- */
-DicomDir::~DicomDir()
-{
- SetStartMethod(NULL);
- SetProgressMethod(NULL);
- SetEndMethod(NULL);
-
- ClearPatient();
- if ( MetaElems )
+ else
{
- delete MetaElems;
+ // Only if user passed a root directory
+ // ------------------------------------
+ if ( GetFileName() == "." )
+ {
+ // user passed '.' as Name
+ // we get current directory name
+ char dummy[1000];
+ getcwd(dummy, (size_t)1000);
+ SetFileName( dummy ); // will be converted into a string
+ }
+ NewMeta();
+ gdcmWarningMacro( "Parse directory and create the DicomDir : "
+ << GetFileName() );
+ ParseDirectory();
}
+ return true;
}
-//-----------------------------------------------------------------------------
-// Public
/**
* \brief This predicate, based on hopefully reasonable heuristics,
* decides whether or not the current document was properly parsed
*/
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;
*/
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<SeqEntry *>(entry) )
+ if ( dynamic_cast<SeqEntry *>(entry) )
break;
RemoveEntryNoDestroy(entry);
}
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;
void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg,
DicomDir::Method *argDelete )
{
- if( StartArg && StartMethodArgDelete )
+ if ( StartArg && StartMethodArgDelete )
{
StartMethodArgDelete( StartArg );
}
StartMethodArgDelete = argDelete;
}
+
/**
* \brief Set the progress method to call when the parsing of the
* directory progress
void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg,
DicomDir::Method *argDelete )
{
- if( ProgressArg && ProgressMethodArgDelete )
+ if ( ProgressArg && ProgressMethodArgDelete )
{
ProgressMethodArgDelete( ProgressArg );
}
void DicomDir::SetEndMethod( DicomDir::Method *method, void *arg,
DicomDir::Method *argDelete )
{
- if( EndArg && EndMethodArgDelete )
+ if ( EndArg && EndMethodArgDelete )
{
EndMethodArgDelete( EndArg );
}
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;
return true;
}
+/**
+ * \brief Anonymize a DICOMDIR
+ * @return true
+ */
+
+bool DicomDir::AnonymizeDicomDir()
+{
+ ValEntry *v;
+ // Something clever to be found to forge the Patient names
+ std::ostringstream s;
+ int i = 1;
+ for(ListDicomDirPatient::iterator cc = Patients.begin();
+ cc!= Patients.end();
+ ++cc)
+ {
+ s << i;
+ v = (*cc)->GetValEntry(0x0010, 0x0010) ; // Patient's Name
+ if (v)
+ {
+ v->SetValue(s.str());
+ }
+
+ v = (*cc)->GetValEntry(0x0010, 0x0020) ; // Patient ID
+ if (v)
+ {
+ v->SetValue(" ");
+ }
+
+ v = (*cc)->GetValEntry(0x0010, 0x0030) ; // Patient's BirthDate
+ if (v)
+ {
+ v->SetValue(" ");
+ }
+ s << "";
+ i++;
+ }
+ return true;
+}
+
//-----------------------------------------------------------------------------
// Protected
/**
DirList dirList(path,1); // gets recursively the file list
unsigned int count = 0;
VectDocument list;
- File *header;
+ File *f;
DirListType fileList = dirList.GetFilenames();
{
Progress = (float)(count+1)/(float)fileList.size();
CallProgressMethod();
- if( Abort )
+ if ( Abort )
{
break;
}
- header = new File( it->c_str() );
- if( !header )
- {
- gdcmWarningMacro( "Failure in new gdcm::File " << it->c_str() );
- continue;
- }
+ f = new File( );
+ f->SetLoadMode(LoadMode); // we allow user not to load Sequences...
+ f->Load( it->c_str() );
+
+// if ( !f )
+// {
+// gdcmWarningMacro( "Failure in new gdcm::File " << it->c_str() );
+// continue;
+// }
- if( header->IsReadable() )
+ if ( f->IsReadable() )
{
// Add the file to the chained list:
- list.push_back(header);
+ list.push_back(f);
gdcmWarningMacro( "Readable " << it->c_str() );
}
else
{
- delete header;
+ delete f;
}
count++;
}
{
Progress = 0.0f;
Abort = false;
- if( StartMethod )
+ if ( StartMethod )
{
StartMethod( StartArg );
}
*/
void DicomDir::CallProgressMethod()
{
- if( ProgressMethod )
+ if ( ProgressMethod )
{
ProgressMethod( ProgressArg );
}
void DicomDir::CallEndMethod()
{
Progress = 1.0f;
- if( EndMethod )
+ if ( EndMethod )
{
EndMethod( EndArg );
}
}
/**
- * \brief create a 'DicomDir' from a DICOMDIR Header
+ * \brief create a 'gdcm::DicomDir' from a DICOMDIR Header
*/
void DicomDir::CreateDicomDir()
{
}
else
{
- gdcmWarningMacro( "Not a ValEntry.");
+ gdcmWarningMacro( "(0004,1430) not a ValEntry ?!?");
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<DicomDirPatient *>(si)) )
+ si = new DicomDirImage(true);
+ if ( !AddImageToEnd( static_cast<DicomDirImage *>(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<DicomDirStudy *>(si)) )
+ si = new DicomDirSerie(true);
+ if ( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
{
delete si;
si = NULL;
- gdcmErrorMacro( "Add AddStudyToEnd failed");
+ gdcmErrorMacro( "Add AddSerieToEnd failed");
}
}
- else if( v == "SERIES" )
+ else if ( v == "STUDY " )
{
- si = new DicomDirSerie(true);
- if( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
+ si = new DicomDirStudy(true);
+ if ( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) )
{
delete si;
si = NULL;
- gdcmErrorMacro( "Add AddSerieToEnd failed");
+ gdcmErrorMacro( "Add AddStudyToEnd failed");
}
}
- else if( v == "IMAGE " )
+ else if ( v == "PATIENT " )
{
- si = new DicomDirImage(true);
- if( !AddImageToEnd( static_cast<DicomDirImage *>(si)) )
+ si = new DicomDirPatient(true);
+ if ( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) )
{
delete si;
si = NULL;
- gdcmErrorMacro( "Add AddImageToEnd failed");
+ 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 )
+ if ( si )
MoveSQItem(si,tmpSI);
tmpSI=s->GetNextSQItem();
*/
bool DicomDir::AddStudyToEnd(DicomDirStudy *dd)
{
- if( Patients.size() > 0 )
+ if ( Patients.size() > 0 )
{
ListDicomDirPatient::iterator itp = Patients.end();
itp--;
*/
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;
*/
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;
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);
- first = true;
}
// Always Deal with 'IMAGE' Elements
case GDCM_DICOMDIR_IMAGE:
elemList = Global::GetDicomDirElements()->GetDicomDirImageElements();
si = new DicomDirImage(true);
- if( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
+ if ( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
{
delete si;
gdcmErrorMacro( "Add ImageToEnd failed");
case GDCM_DICOMDIR_SERIE:
elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements();
si = new DicomDirSerie(true);
- if( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
+ if ( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
{
delete si;
gdcmErrorMacro( "Add SerieToEnd failed");
case GDCM_DICOMDIR_STUDY:
elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements();
si = new DicomDirStudy(true);
- if( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
+ if ( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
{
delete si;
gdcmErrorMacro( "Add StudyToEnd failed");
case GDCM_DICOMDIR_PATIENT:
elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements();
si = new DicomDirPatient(true);
- if( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
+ if ( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
{
delete si;
gdcmErrorMacro( "Add PatientToEnd failed");
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");
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
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();
*/
void DicomDir::Print(std::ostream &os, std::string const & )
{
- if( MetaElems )
+ if ( MetaElems )
{
MetaElems->SetPrintLevel(PrintLevel);
MetaElems->Print(os);
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff