gdcm::DicomDir Class Reference

DicomDir defines an object representing a DICOMDIR in memory as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie -> DicomDirImage. More...

#include <gdcmDicomDir.h>

Inheritance diagram for gdcm::DicomDir:

[legend]Collaboration diagram for gdcm::DicomDir:

[legend]List of all members.

Public Types
typedef void	Method (void *)
enum	DicomDirType {   GDCM_DICOMDIR_NONE, GDCM_DICOMDIR_META, GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY,   GDCM_DICOMDIR_SERIE, GDCM_DICOMDIR_VISIT, GDCM_DICOMDIR_IMAGE }
	Types of the DicomDirObject within the DicomDir. More...
typedef std::list< DicomElement >	ListElements
Public Member Functions
	GDCM_LEGACY (bool Load(std::string const &filename))
bool	Load ()
	Loader. use SetFileName(fn) or SetLoadMode(lm) + SetDirectoryName(dn) before !
void	Print (std::ostream &os=std::cout, std::string const &indent="")
	Canonical Printer.
void	SetDirectoryName (std::string const &dirName)
	Sets the root Directory name to parse, recursively.
virtual void	SetFileName (std::string const &fileName)
	Accessor to Filename.
	GDCM_LEGACY (void SetParseDir(bool parseDir))
	DEPRECATED : use SetDirectoryName.
virtual bool	IsReadable ()
	This predicate, based on hopefully reasonable heuristics, decides whether or not the current document was properly parsed and contains the mandatory information for being considered as a well formed and usable DicomDir.
DicomDirMeta *	NewMeta ()
	adds *the* Meta to a partially created DICOMDIR
DicomDirMeta *	GetMeta ()
	Returns a pointer to the DicomDirMeta for this DICOMDIR.
DicomDirPatient *	NewPatient ()
	adds a new Patient (with the basic elements) to a partially created DICOMDIR
void	ClearPatient ()
	Remove all Patients.
DicomDirPatient *	GetFirstPatient ()
	Get the first entry while visiting the DicomDirPatients.
DicomDirPatient *	GetNextPatient ()
	Get the next entry while visiting the DicomDirPatients.
void	ParseDirectory ()
	fills the whole structure, starting from a root Directory
void	SetStartMethod (DicomDir::Method *method, void *arg=NULL)
void	SetProgressMethod (DicomDir::Method *method, void *arg=NULL)
void	SetEndMethod (DicomDir::Method *method, void *arg=NULL)
void	SetStartMethod (void(*method)(void *), void *arg, void(*argDelete)(void *))
void	SetProgressMethod (void(*method)(void *), void *arg, void(*argDelete)(void *))
void	SetEndMethod (void(*method)(void *), void *arg, void(*argDelete)(void *))
void	SetStartMethodArgDelete (DicomDir::Method *method)
	Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed.
void	SetProgressMethodArgDelete (DicomDir::Method *method)
	Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed.
void	SetEndMethodArgDelete (DicomDir::Method *method)
	Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed.
float	GetProgress ()
	GetProgress GetProgress.
void	AbortProgress ()
	AbortProgress AbortProgress.
bool	IsAborted ()
	IsAborted IsAborted.
bool	Write (std::string const &fileName)
	writes on disc a DICOMDIR \ warning does NOT add the missing elements in the header : it's up to the user doing it !
bool	Anonymize ()
	Anonymize a DICOMDIR.
virtual bool	Load (std::string const &filename)
	Loader. (DEPRECATED : not to break the API).
Dict *	GetPubDict ()
	Get the public dictionary used.
Dict *	GetShaDict ()
	Get the shadow dictionary used.
bool	SetShaDict (Dict *dict)
	Set the shadow dictionary used.
bool	SetShaDict (DictKey const &dictName)
	Set the shadow dictionary used.
bool	IsParsable ()
	This predicate tells us whether or not the current Document was properly parsed and contains at least *one* Dicom Element (and nothing more, sorry).
bool	IsDicomV3 ()
	Predicate for dicom version 3 file.
bool	IsPapyrus ()
	Predicate for Papyrus file Dedicated to whomsoever it may concern.
FileType	GetFileType ()
	returns the File Type (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
std::string	GetTransferSyntax ()
	Accessor to the Transfer Syntax (when present) of the current document (it internally handles reading the value from disk when only parsing occured).
std::string	GetTransferSyntaxName ()
	Accesses the info from 0002,0010 : Transfer Syntax and TS.
int	GetSwapCode ()
	'Swap code' accessor (see SwapCode )
const std::string &	GetFileName () const
	Accessor to Filename.
std::ifstream *	OpenFile ()
	Tries to open the file Document::Filename and checks the preamble when existing.
bool	CloseFile ()
	closes the file
void	WriteContent (std::ofstream *fp, FileType type)
	Writes in a file all the Entries (Dicom Elements).
virtual void	LoadEntryBinArea (uint16_t group, uint16_t elem)
	Loads (from disk) the element content when a string is not suitable.
virtual void	LoadEntryBinArea (DataEntry *entry)
	Loads (from disk) the element content when a string is not suitable.
void	LoadDocEntrySafe (DocEntry *entry)
	Loads the element while preserving the current underlying file position indicator as opposed to LoadDocEntry that modifies it.
void	AddForceLoadElement (uint16_t group, uint16_t elem)
	Adds a new element we want to load anyway.
bool	operator< (Document &document)
	Compares two documents, according to DicomDir rules.
void	SetLoadMode (int mode)
	Sets the LoadMode as a boolean string. LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ ... (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 !
bool	AddEntry (DocEntry *Entry)
	add a new Dicom Element pointer to the H Table
bool	RemoveEntry (DocEntry *EntryToRemove)
	Clear the hash table from given entry AND delete the entry.
void	ClearEntry ()
	delete all entries in the ElementSet
DocEntry *	GetFirstEntry ()
	Get the first entry while visiting *the* 'zero level' DocEntrySet (DocEntries out of any Sequence).
DocEntry *	GetNextEntry ()
	Get the next entry while visiting *the* 'zero level' DocEntrySet (DocEntries out of any Sequence).
DocEntry *	GetDocEntry (uint16_t group, uint16_t elem)
	retrieves a Dicom Element using (group, element)
bool	IsEmpty ()
	Tells us if the ElementSet contains no entry.
virtual std::string	GetEntryString (uint16_t group, uint16_t elem)
	Get the "std::string representable" value of the Dicom entry.
virtual void *	GetEntryBinArea (uint16_t group, uint16_t elem)
	Gets (from Header) a 'non string' element value.
virtual int	GetEntryLength (uint16_t group, uint16_t elem)
	Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the value length of a given tag..
virtual std::string	GetEntryForcedAsciiValue (uint16_t group, uint16_t elem)
	Return the value of the DataEntry if it's "std::string representable".
DataEntry *	GetDataEntry (uint16_t group, uint16_t elem)
	Same as Document::GetDocEntry except it only returns a result when the corresponding entry is of type DataEntry.
SeqEntry *	GetSeqEntry (uint16_t group, uint16_t elem)
	Same as Document::GetDocEntry except it only returns a result when the corresponding entry is of type SeqEntry.
bool	SetEntryString (std::string const &content, uint16_t group, uint16_t elem)
	Accesses an existing DocEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value.
bool	SetEntryString (std::string const &content, DataEntry *entry)
	Accesses an existing DocEntry (i.e. a Dicom Element) and modifies it's content with the given value.
bool	SetEntryBinArea (uint8_t *content, int lgth, uint16_t group, uint16_t elem)
	Accesses an existing DocEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value.
bool	SetEntryBinArea (uint8_t *content, int lgth, DataEntry *entry)
	Accesses an existing DataEntry (i.e. a Dicom Element) and modifies it's content with the given value.
DataEntry *	InsertEntryString (std::string const &value, uint16_t group, uint16_t elem, VRKey const &vr=GDCM_VRUNKNOWN)
	Modifies the value of a given Doc Entry (Dicom Element) when it exists. Create it with the given value when unexistant.
DataEntry *	InsertEntryBinArea (uint8_t *binArea, int lgth, uint16_t group, uint16_t elem, VRKey const &vr=GDCM_VRUNKNOWN)
	Modifies the value of a given Header Entry (Dicom Element) when it exists. Create it with the given value when unexistant. A copy of the binArea is made to be kept in the Document.
SeqEntry *	InsertSeqEntry (uint16_t group, uint16_t elem)
	Modifies the value of a given Doc Entry (Dicom Element) when it exists. Creates it when unexistant.
virtual bool	CheckIfEntryExist (uint16_t group, uint16_t elem)
	Checks if a given Dicom Element exists within the H table.
DataEntry *	NewDataEntry (uint16_t group, uint16_t elem, VRKey const &vr=GDCM_VRUNKNOWN)
	Build a new Val Entry from all the low level arguments. Check for existence of dictionary entry, and build a default one when absent.
SeqEntry *	NewSeqEntry (uint16_t group, uint16_t elem)
	Build a new Seq Entry from all the low level arguments. Check for existence of dictionary entry, and build a default one when absent.
void	Delete ()
	Delete the object.
void	Register ()
	Register the object.
void	Unregister ()
	Unregister the object.
const unsigned long &	GetRefCount () const
	Get the reference counting.
void	SetPrintLevel (int level)
	Sets the print level for the Dicom Header Elements.
int	GetPrintLevel ()
	Gets the print level for the Dicom Entries.
Static Public Member Functions
static DicomDir *	New ()
Protected Member Functions
	DicomDir ()
	Constructor : creates an empty DicomDir.
	~DicomDir ()
	Canonical destructor.
void	CreateDicomDirChainedList (std::string const &path)
	create a Document-like chained list from a root Directory
void	CallStartMethod ()
	CallStartMethod.
void	CallProgressMethod ()
	CallProgressMethod.
void	CallEndMethod ()
	CallEndMethod.
uint16_t	ReadInt16 () throw ( FormatError )
	Reads a supposed to be 16 Bits integer (swaps it depending on processor endianness).
uint32_t	ReadInt32 () throw ( FormatError )
	Reads a supposed to be 32 Bits integer (swaps it depending on processor endianness).
void	SkipBytes (uint32_t)
	skips bytes inside the source file
int	ComputeGroup0002Length ()
	Re-computes the length of the Dicom group 0002.
bool	MayIWrite (uint16_t)
	Some group are illegal withing some Dicom Documents Only the Document knows it.
DictEntry *	GetDictEntry (uint16_t group, uint16_t elem)
	Searches [both] the public [and the shadow dictionary (when they exist)] for the presence of the DictEntry with given group and element. The public dictionary has precedence on the shadow one(s), if any.
DictEntry *	GetDictEntry (uint16_t group, uint16_t elem, VRKey const &vr)
	Searches [both] the public [and the shadow dictionary (when they exist)] for the presence of the DictEntry with given group and element, and create a new virtual DictEntry if necessary.
Protected Attributes
std::string	Filename
	Refering underlying filename.
int	SwapCode
	Swap code gives an information on the byte order of a supposed to be an int32, as it's read on disc (depending on the image Transfer Syntax *and* on the processor endianess) as opposed as it should in memory to be dealt as an int32. For instance : a 'Little Endian' image, read with a little endian processor will have a SwapCode= 1234 (the order is OK; nothing to do) a 'Little Endian' image, read with a big endian procesor will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be swapped) note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and the well known 'Bad Big Endian' and 'Bad Little Endian' codes.
bool	Group0002Parsed
	whether we already parsed group 0002 (Meta Elements)
bool	HasDCMPreamble
	whether file has a DCM Preamble
std::ifstream *	Fp
	File Pointer, opened during Document parsing.
FileType	Filetype
	ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown.
ListElements	UserAnonymizeList
	User supplied list of elements to Anonymize.
ListElements	UserForceLoadList
	User supplied list of elements to force Load.
int	LoadMode
	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.
bool	IsDocumentAlreadyLoaded
	Whether the gdcm::Document is already parsed/loaded : False from the creation of the gdcm::Document untill gdcm::Document:Load().
bool	IsDocumentModified
	Whether the gdcm::Document was modified since the last Load().
DocEntry *	PreviousDocEntry
	To be able to backtrack (Private Sequence, Implicit VR related pb).
int	PrintLevel
	Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.
Static Protected Attributes
static const unsigned int	HEADER_LENGTH_TO_READ
	After opening the file, we read HEADER_LENGTH_TO_READ bytes.
static const unsigned int	MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff
	Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE are NOT loaded.
Private Member Functions
	gdcmTypeMacro (DicomDir)
void	Initialize ()
	Sets all fields to NULL.
void	CreateDicomDir ()
	create a 'gdcmDicomDir' from a DICOMDIR Header
bool	DoTheLoadingJob ()
	Does the Loading Job (internal use only).
bool	AddPatientToEnd (DicomDirPatient *dd)
	AddPatientToEnd.
bool	AddStudyToEnd (DicomDirStudy *dd)
	AddStudyToEnd.
bool	AddSerieToEnd (DicomDirSerie *dd)
	AddSerieToEnd.
bool	AddVisitToEnd (DicomDirVisit *dd)
	AddVisitToEnd.
bool	AddImageToEnd (DicomDirImage *dd)
	AddImageToEnd.
void	SetElements (std::string const &path, VectDocument const &list)
	for each Header of the chained list, add/update the Patient/Study/Serie/Image info
void	SetElement (std::string const &path, DicomDirType type, Document *header)
	adds to the HTable the Entries (Dicom Elements) corresponding to the given type
void	MoveSQItem (DocEntrySet *dst, DocEntrySet *src)
	Move the content of the source SQItem to the destination SQItem Only DocEntry's are moved.
Static Private Member Functions
static bool	HeaderLessThan (Document *header1, Document *header2)
	compares two files
Private Attributes
DicomDirMeta *	MetaElems
	Pointer on *the* DicomDirObject 'DicomDirMeta Elements'.
ListDicomDirPatient	Patients
	Chained list of DicomDirPatient (to be exploited hierarchicaly).
ListDicomDirPatient::iterator	ItPatient
Method *	StartMethod
	pointer to the initialisation method for any progress bar
Method *	ProgressMethod
	pointer to the incrementation method for any progress bar
Method *	EndMethod
	pointer to the termination 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 ??? method for any progress bar
void *	StartArg
	pointer to the ??? for any progress bar
void *	ProgressArg
	pointer to the ??? for any progress bar
void *	EndArg
	pointer to the ??? for any progress bar
float	Progress
	value of the ??? for any progress bar
bool	Abort
	value of the ??? for any progress bar
bool	ParseDir

---

Detailed Description

DicomDir defines an object representing a DICOMDIR in memory as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie -> DicomDirImage.

Definition at line 51 of file gdcmDicomDir.h.

---

Member Typedef Documentation

typedef std::list<DicomElement> gdcm::Document::ListElements [inherited]

Definition at line 45 of file gdcmDocument.h.

typedef void gdcm::DicomDir::Method(void *)

Definition at line 58 of file gdcmDicomDir.h.

---

Member Enumeration Documentation

enum gdcm::DicomDir::DicomDirType

Types of the DicomDirObject within the DicomDir. Enumerator: GDCM_DICOMDIR_NONE  GDCM_DICOMDIR_META  GDCM_DICOMDIR_PATIENT  GDCM_DICOMDIR_STUDY  GDCM_DICOMDIR_SERIE  GDCM_DICOMDIR_VISIT  GDCM_DICOMDIR_IMAGE  Definition at line 131 of file gdcmDicomDir.h. { GDCM_DICOMDIR_NONE, GDCM_DICOMDIR_META, GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE, GDCM_DICOMDIR_VISIT, GDCM_DICOMDIR_IMAGE } DicomDirType;

---

Constructor & Destructor Documentation

gdcm::DicomDir::DicomDir (   )  [protected]

Constructor : creates an empty DicomDir. Definition at line 119 of file gdcmDicomDir.cxx. References Initialize(), NewMeta(), and ParseDir. :Document( ) { Initialize(); // sets all private fields to NULL ParseDir = false; NewMeta(); }

gdcm::DicomDir::~DicomDir (   )  [protected]

Canonical destructor. Definition at line 130 of file gdcmDicomDir.cxx. References ClearPatient(), gdcm::RefCounter::Delete(), MetaElems, SetEndMethod(), SetProgressMethod(), and SetStartMethod(). { SetStartMethod(NULL,NULL,NULL); SetProgressMethod(NULL,NULL,NULL); SetEndMethod(NULL,NULL,NULL); ClearPatient(); if ( MetaElems ) { MetaElems->Delete(); } }

---

Member Function Documentation

void gdcm::DicomDir::AbortProgress (   )  [inline]

AbortProgress AbortProgress. Definition at line 121 of file gdcmDicomDir.h. { Abort = true; }

bool gdcm::ElementSet::AddEntry (  DocEntry *  newEntry  )  [virtual, inherited]

add a new Dicom Element pointer to the H Table Parameters: newEntry  entry to add Implements gdcm::DocEntrySet. Definition at line 78 of file gdcmElementSet.cxx. References gdcmWarningMacro, gdcm::DocEntry::GetKey(), gdcm::RefCounter::Register(), and gdcm::ElementSet::TagHT. Referenced by gdcm::File::DoTheLoadingJob(), gdcm::DocEntryArchive::Push(), and gdcm::DocEntryArchive::Restore(). { const TagKey &key = newEntry->GetKey(); if ( TagHT.count(key) == 1 ) { gdcmWarningMacro( "Key already present: " << key ); return false; } else { TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry)); newEntry->Register(); return true; } }

void gdcm::Document::AddForceLoadElement (  uint16_t  group, uint16_t  elem )  [inherited]

Adds a new element we want to load anyway. Parameters: group  Group number of the target tag. elem  Element number of the target tag. Definition at line 290 of file gdcmDocument.cxx. References gdcm::DicomElement::Elem, gdcm::DicomElement::Group, and gdcm::Document::UserForceLoadList. { DicomElement el; el.Group = group; el.Elem = elem; UserForceLoadList.push_back(el); }

bool gdcm::DicomDir::AddImageToEnd (  DicomDirImage *  dd  )  [private]

AddImageToEnd. Parameters: dd  SQ Item to enqueue to the DicomDirImage chained List Definition at line 893 of file gdcmDicomDir.cxx. References gdcm::DicomDirSerie::AddImage(), gdcm::DicomDirStudy::GetLastSerie(), and Patients. Referenced by CreateDicomDir(), and SetElement(). { if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; DicomDirStudy *study = (*itp)->GetLastStudy(); if ( study ) { DicomDirSerie *serie = study->GetLastSerie(); if ( serie ) { serie->AddImage(dd); return true; } } } return false; }

bool gdcm::DicomDir::AddPatientToEnd (  DicomDirPatient *  dd  )  [private]

AddPatientToEnd. Parameters: dd  SQ Item to enqueue to the DicomPatient chained List Definition at line 826 of file gdcmDicomDir.cxx. References Patients. Referenced by CreateDicomDir(), NewPatient(), and SetElement(). { Patients.push_back(dd); return true; }

bool gdcm::DicomDir::AddSerieToEnd (  DicomDirSerie *  dd  )  [private]

AddSerieToEnd. Parameters: dd  SQ Item to enqueue to the DicomDirSerie chained List Definition at line 852 of file gdcmDicomDir.cxx. References gdcm::DicomDirStudy::AddSerie(), and Patients. Referenced by CreateDicomDir(), and SetElement(). { if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; DicomDirStudy *study = (*itp)->GetLastStudy(); if ( study ) { study->AddSerie(dd); return true; } } return false; }

bool gdcm::DicomDir::AddStudyToEnd (  DicomDirStudy *  dd  )  [private]

AddStudyToEnd. Parameters: dd  SQ Item to enqueue to the DicomDirStudy chained List Definition at line 836 of file gdcmDicomDir.cxx. References Patients. Referenced by CreateDicomDir(), and SetElement(). { if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; (*itp)->AddStudy(dd); return true; } return false; }

bool gdcm::DicomDir::AddVisitToEnd (  DicomDirVisit *  dd  )  [private]

AddVisitToEnd. Parameters: dd  SQ Item to enqueue to the DicomDirVisit chained List Definition at line 873 of file gdcmDicomDir.cxx. References gdcm::DicomDirStudy::AddVisit(), and Patients. Referenced by CreateDicomDir(). { if ( Patients.size() > 0 ) { ListDicomDirPatient::iterator itp = Patients.end(); itp--; DicomDirStudy *study = (*itp)->GetLastStudy(); if ( study ) { study->AddVisit(dd); return true; } } return false; }

bool gdcm::DicomDir::Anonymize (   )

Anonymize a DICOMDIR. Returns: true Definition at line 545 of file gdcmDicomDir.cxx. References Patients, and gdcm::DataEntry::SetString(). { DataEntry *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)->GetDataEntry(0x0010, 0x0010) ; // Patient's Name if (v) { v->SetString(s.str()); } v = (*cc)->GetDataEntry(0x0010, 0x0020) ; // Patient ID if (v) { v->SetString(" "); } v = (*cc)->GetDataEntry(0x0010, 0x0030) ; // Patient's BirthDate if (v) { v->SetString(" "); } s << ""; i++; } return true; }

void gdcm::DicomDir::CallEndMethod (   )  [protected]

CallEndMethod. Definition at line 667 of file gdcmDicomDir.cxx. References EndArg, EndMethod, and Progress. Referenced by CreateDicomDirChainedList(). { Progress = 1.0f; if ( EndMethod ) { EndMethod( EndArg ); } }

void gdcm::DicomDir::CallProgressMethod (   )  [protected]

CallProgressMethod. Definition at line 656 of file gdcmDicomDir.cxx. References ProgressArg, and ProgressMethod. Referenced by CreateDicomDirChainedList(). { if ( ProgressMethod ) { ProgressMethod( ProgressArg ); } }

void gdcm::DicomDir::CallStartMethod (   )  [protected]

CallStartMethod. Definition at line 643 of file gdcmDicomDir.cxx. References Abort, Progress, StartArg, and StartMethod. Referenced by CreateDicomDirChainedList(). { Progress = 0.0f; Abort = false; if ( StartMethod ) { StartMethod( StartArg ); } }

bool gdcm::DocEntrySet::CheckIfEntryExist (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Checks if a given Dicom Element exists within the H table. Parameters: group  Group number of the searched Dicom Element elem  Element number of the searched Dicom Element Returns: true is found Definition at line 430 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::GetDocEntry(). { return GetDocEntry(group,elem)!=NULL; }

void gdcm::ElementSet::ClearEntry (   )  [virtual, inherited]

delete all entries in the ElementSet Implements gdcm::DocEntrySet. Definition at line 116 of file gdcmElementSet.cxx. References gdcm::ElementSet::TagHT. Referenced by CreateDicomDir(), gdcm::Document::DoTheLoadingDocumentJob(), SetElements(), and gdcm::ElementSet::~ElementSet(). { for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc) { if ( cc->second ) { cc->second->Unregister(); } } TagHT.clear(); }

void gdcm::DicomDir::ClearPatient (   )

Remove all Patients. Definition at line 327 of file gdcmDicomDir.cxx. References Patients. Referenced by SetElements(), and ~DicomDir(). { for(ListDicomDirPatient::iterator cc = Patients.begin(); cc!= Patients.end(); ++cc) { (*cc)->Unregister(); } Patients.clear(); }

bool gdcm::Document::CloseFile (   )  [inherited]

closes the file Returns: TRUE if the close was successfull Definition at line 658 of file gdcmDocument.cxx. References gdcm::Document::Fp. Referenced by gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::DoTheLoadingJob(), gdcm::FileHelper::GetRaw(), gdcm::Document::LoadEntryBinArea(), gdcm::Document::OpenFile(), and gdcm::Document::~Document(). { if ( Fp ) { Fp->close(); delete Fp; Fp = 0; } return true; }

int gdcm::Document::ComputeGroup0002Length (   )  [protected, inherited]

Re-computes the length of the Dicom group 0002. Definition at line 956 of file gdcmDocument.cxx. References gdcm::DocEntry::GetElement(), gdcm::ElementSet::GetFirstEntry(), gdcm::DocEntry::GetGroup(), gdcm::DocEntry::GetLength(), gdcm::ElementSet::GetNextEntry(), and gdcm::DocEntry::GetVR(). Referenced by gdcm::File::Write(). { uint16_t gr; VRKey vr; int groupLength = 0; bool found0002 = false; // for each zero-level Tag in the DCM Header DocEntry *entry = GetFirstEntry(); while( entry ) { gr = entry->GetGroup(); if ( gr == 0x0002 ) { found0002 = true; if ( entry->GetElement() != 0x0000 ) { vr = entry->GetVR(); //if ( (vr == "OB")||(vr == "OW")||(vr == "UT")||(vr == "SQ")) // (no SQ, OW, UT in group 0x0002;) if ( vr == "OB" ) { // explicit VR AND (OB, OW, SQ, UT) : 4 more bytes groupLength += 4; } groupLength += 2 + 2 + 4 + entry->GetLength(); } } else if (found0002 ) break; entry = GetNextEntry(); } return groupLength; }

void gdcm::DicomDir::CreateDicomDir (   )  [private]

create a 'gdcmDicomDir' from a DICOMDIR Header Definition at line 702 of file gdcmDicomDir.cxx. References AddImageToEnd(), AddPatientToEnd(), AddSerieToEnd(), AddStudyToEnd(), AddVisitToEnd(), gdcm::ElementSet::ClearEntry(), gdcmDebugMacro, gdcmErrorMacro, gdcmWarningMacro, gdcm::SQItem::GetDocEntry(), gdcm::ElementSet::GetDocEntry(), gdcm::SeqEntry::GetFirstSQItem(), gdcm::SeqEntry::GetNextSQItem(), gdcm::SQItem::MoveObject(), gdcm::DicomDirPatient::New(), gdcm::DicomDirStudy::New(), gdcm::DicomDirVisit::New(), gdcm::DicomDirSerie::New(), gdcm::DicomDirImage::New(), and NewMeta(). Referenced by DoTheLoadingJob(), and ParseDirectory(). { // The SeqEntries of "Directory Record Sequence" are parsed. // When a DicomDir tag ("PATIENT", "STUDY", "SERIE", "IMAGE") is found : // 1 - we save the beginning iterator // 2 - we continue to parse // 3 - we find an other tag // + we create the object for the precedent tag // + loop to 1 - gdcmDebugMacro("Create DicomDir"); // Directory record sequence DocEntry *e = GetDocEntry(0x0004, 0x1220); if ( !e ) { gdcmWarningMacro( "No Directory Record Sequence (0004,1220) found"); return; } SeqEntry *s = dynamic_cast<SeqEntry *>(e); if ( !s ) { gdcmWarningMacro( "Element (0004,1220) is not a Sequence ?!?"); return; } NewMeta(); DocEntry *d; std::string v; SQItem *si; SQItem *tmpSI=s->GetFirstSQItem(); while(tmpSI) { d = tmpSI->GetDocEntry(0x0004, 0x1430); // Directory Record Type if ( DataEntry *dataEntry = dynamic_cast<DataEntry *>(d) ) { v = dataEntry->GetString(); } else { gdcmWarningMacro( "(0004,1430) not a DataEntry ?!?"); continue; } // 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 = DicomDirImage::New(true); if ( !AddImageToEnd( static_cast<DicomDirImage *>(si)) ) { si->Delete(); si = NULL; gdcmErrorMacro( "Add AddImageToEnd failed"); } } else if ( v == "SERIES" ) { si = DicomDirSerie::New(true); if ( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) ) { si->Delete(); si = NULL; gdcmErrorMacro( "Add AddSerieToEnd failed"); } } else if ( v == "VISIT " ) { si = DicomDirVisit::New(true); if ( !AddVisitToEnd( static_cast<DicomDirVisit *>(si)) ) { si->Delete(); si = NULL; gdcmErrorMacro( "Add AddVisitToEnd failed"); } } else if ( v == "STUDY " ) { si = DicomDirStudy::New(true); if ( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) ) { si->Delete(); si = NULL; gdcmErrorMacro( "Add AddStudyToEnd failed"); } } else if ( v == "PATIENT " ) { si = DicomDirPatient::New(true); if ( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) ) { si->Delete(); si = NULL; gdcmErrorMacro( "Add PatientToEnd failed"); } } else { // It was neither a 'PATIENT', nor a 'STUDY', nor a 'SERIE', // nor an 'IMAGE' SQItem. Skip to next item. gdcmDebugMacro( " -------------------------------------------" << "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 ) si->MoveObject(tmpSI); // New code : Copies the List tmpSI=s->GetNextSQItem(); } ClearEntry(); }

void gdcm::DicomDir::CreateDicomDirChainedList (  std::string const &  path  )  [protected]

create a Document-like chained list from a root Directory Parameters: path  entry point of the tree-like structure Definition at line 585 of file gdcmDicomDir.cxx. References Abort, CallEndMethod(), CallProgressMethod(), CallStartMethod(), gdcm::RefCounter::Delete(), gdcmDebugMacro, gdcm::DirList::GetDirName(), gdcm::DirList::GetFilenames(), HeaderLessThan(), gdcm::File::IsReadable(), gdcm::File::Load(), gdcm::Document::LoadMode, gdcm::File::New(), Progress, SetElements(), gdcm::Document::SetFileName(), and gdcm::Document::SetLoadMode(). Referenced by ParseDirectory(). { CallStartMethod(); DirList dirList(path,1); // gets recursively the file list unsigned int count = 0; VectDocument list; File *f; DirListType fileList = dirList.GetFilenames(); for( DirListType::iterator it = fileList.begin(); it != fileList.end(); ++it ) { Progress = (float)(count+1)/(float)fileList.size(); CallProgressMethod(); if ( Abort ) { break; } f = File::New( ); f->SetLoadMode(LoadMode); // we allow user not to load Sequences, // or Shadow groups, or ...... f->SetFileName( it->c_str() ); f->Load( ); if ( f->IsReadable() ) { // Add the file to the chained list: list.push_back(f); gdcmDebugMacro( "Readable " << it->c_str() ); } else { f->Delete(); } count++; } // sorts Patient/Study/Serie/ std::sort(list.begin(), list.end(), DicomDir::HeaderLessThan ); std::string tmp = dirList.GetDirName(); //for each File of the chained list, add/update the Patient/Study/Serie/Image info SetElements(tmp, list); CallEndMethod(); for(VectDocument::iterator itDoc=list.begin(); itDoc!=list.end(); ++itDoc) { dynamic_cast<File *>(*itDoc)->Delete(); } }

void gdcm::RefCounter::Delete (   )  [inline, inherited]

Delete the object. Remarks: The object is deleted only if its reference counting is to zero Definition at line 40 of file gdcmRefCounter.h. Referenced by gdcm::SerieHelper::AddFileName(), gdcm::Document::Backtrack(), gdcm::FileHelper::CheckMandatoryElements(), gdcm::FileHelper::CheckMandatoryEntry(), gdcm::FileHelper::CopyMandatoryEntry(), CreateDicomDirChainedList(), gdcm::File::DoTheLoadingJob(), gdcm::Dict::DoTheLoadingJob(), gdcm::DicomDirObject::FillObject(), gdcm::DocEntrySet::InsertEntryBinArea(), gdcm::DocEntrySet::InsertEntryString(), gdcm::DocEntrySet::InsertSeqEntry(), NewMeta(), gdcm::DicomDirStudy::NewVisit(), gdcm::Document::ParseDES(), gdcm::Document::ParseSQ(), gdcm::Document::ReadNextDocEntry(), SetElement(), gdcm::FileHelper::SetMandatoryEntry(), gdcm::FileHelper::SetWriteFileTypeToExplicitVR(), gdcm::FileHelper::SetWriteFileTypeToImplicitVR(), gdcm::FileHelper::SetWriteFileTypeToJPEG(), gdcm::FileHelper::SetWriteToLibido(), gdcm::FileHelper::SetWriteToNoLibido(), gdcm::FileHelper::SetWriteToRaw(), gdcm::FileHelper::SetWriteToRGB(), ~DicomDir(), and gdcm::Global::~Global(). { Unregister(); }

bool gdcm::DicomDir::DoTheLoadingJob (   )  [private]

Does the Loading Job (internal use only). Returns: false if file cannot be open or no swap info was found, or no tag was found. Definition at line 193 of file gdcmDicomDir.cxx. References Abort, CreateDicomDir(), gdcm::Document::Fp, gdcmDebugMacro, gdcmErrorMacro, gdcmWarningMacro, gdcm::ElementSet::GetDocEntry(), gdcm::Document::GetFileName(), gdcm::ElementSet::GetFirstEntry(), gdcm::Document::Load(), NewMeta(), ParseDir, ParseDirectory(), Progress, and SetFileName(). Referenced by Load(). { Progress = 0.0f; Abort = false; if (!ParseDir) { // Only if user passed a DICOMDIR // ------------------------------ Fp = 0; if (!Document::Load() ) { return false; } if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse { 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 " << GetFileName()); return false; } else CreateDicomDir(); } else { // Only if user passed a root directory // ------------------------------------ if ( GetFileName() == "." ) { // user passed '.' as Name // we get current directory name char buf[2048]; const char *cwd = getcwd(buf, 2048); if( cwd ) { SetFileName( buf ); // will be converted into a string } else { gdcmErrorMacro( "Path was too long to fit on 2048 bytes" ); } } NewMeta(); gdcmDebugMacro( "Parse directory and create the DicomDir : " << GetFileName() ); ParseDirectory(); } return true; }

gdcm::DicomDir::GDCM_LEGACY (  void   SetParseDir(bool parseDir)  )

DEPRECATED : use SetDirectoryName.

gdcm::DicomDir::GDCM_LEGACY (  bool   Load(std::string const &filename)  )

gdcm::DicomDir::gdcmTypeMacro (  DicomDir   )  [private]

DataEntry * gdcm::DocEntrySet::GetDataEntry (  uint16_t  group, uint16_t  elem )  [inherited]

Same as Document::GetDocEntry except it only returns a result when the corresponding entry is of type DataEntry. Parameters: group  Group number of the searched Dicom Element elem  Element number of the searched Dicom Element Returns: When present, the corresponding DataEntry. Definition at line 136 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::GetDocEntry(). Referenced by gdcm::FileHelper::CheckMandatoryElements(), gdcm::FileHelper::CheckMandatoryEntry(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::GetBitsAllocated(), gdcm::File::GetBitsStored(), gdcm::DocEntrySet::GetEntryBinArea(), gdcm::File::GetHighBitPosition(), gdcm::File::GetPlanarConfiguration(), gdcm::File::GetRescaleIntercept(), gdcm::File::GetRescaleSlope(), gdcm::File::GetSamplesPerPixel(), gdcm::File::GetXOrigin(), gdcm::File::GetXSize(), gdcm::File::GetXSpacing(), gdcm::File::GetYOrigin(), gdcm::File::GetYSize(), gdcm::File::GetYSpacing(), gdcm::File::GetZOrigin(), gdcm::File::GetZSize(), gdcm::File::GetZSpacing(), gdcm::File::IsSignedPixelData(), gdcm::ElementSet::Print(), gdcm::DocEntrySet::SetEntryBinArea(), gdcm::DocEntrySet::SetEntryString(), gdcm::FileHelper::SetWriteToLibido(), gdcm::FileHelper::SetWriteToNoLibido(), gdcm::FileHelper::Write(), gdcm::File::Write(), and gdcm::DicomDirMeta::WriteContent(). { DocEntry *currentEntry = GetDocEntry(group, elem); if ( !currentEntry ) return NULL; return dynamic_cast<DataEntry*>(currentEntry); }

DictEntry * gdcm::DocEntrySet::GetDictEntry (  uint16_t  group, uint16_t  elem, VRKey const &  vr )  [protected, inherited]

Searches [both] the public [and the shadow dictionary (when they exist)] for the presence of the DictEntry with given group and element, and create a new virtual DictEntry if necessary. Parameters: group  group number of the searched DictEntry elem  element number of the searched DictEntry vr  V(alue) R(epresentation) to use, if necessary Returns: Corresponding DictEntry when it exists, NULL otherwise. Remarks: The returned DictEntry is registered Definition at line 520 of file gdcmDocEntrySet.cxx. References gdcm::GDCM_VRUNKNOWN, gdcm::DocEntrySet::GetDictEntry(), gdcm::DicomEntry::GetVR(), gdcm::DictEntry::New(), gdcm::RefCounter::Register(), and gdcm::RefCounter::Unregister(). { DictEntry *dictEntry = GetDictEntry(group,elem); DictEntry *goodEntry = dictEntry; VRKey goodVR = vr; if (elem == 0x0000) goodVR="UL"; if ( goodEntry ) { if ( goodVR != goodEntry->GetVR() && goodVR != GDCM_VRUNKNOWN ) { goodEntry = NULL; } dictEntry->Unregister(); } // Create a new virtual DictEntry if necessary if (!goodEntry) { if (dictEntry) { goodEntry = DictEntry::New(group, elem, goodVR, "FIXME", dictEntry->GetName() ); } else { goodEntry = DictEntry::New(group, elem, goodVR); } } else { goodEntry->Register(); } return goodEntry; }

DictEntry * gdcm::DocEntrySet::GetDictEntry (  uint16_t  group, uint16_t  elem )  [protected, inherited]

Searches [both] the public [and the shadow dictionary (when they exist)] for the presence of the DictEntry with given group and element. The public dictionary has precedence on the shadow one(s), if any. Parameters: group  Group number of the searched DictEntry elem  Element number of the searched DictEntry Returns: Corresponding DictEntry when it exists, NULL otherwise. Remarks: The returned DictEntry is registered when existing Definition at line 493 of file gdcmDocEntrySet.cxx. References gdcmWarningMacro, gdcm::DictSet::GetDefaultPubDict(), gdcm::Global::GetDicts(), gdcm::Dict::GetEntry(), and gdcm::RefCounter::Register(). Referenced by gdcm::DocEntrySet::GetDictEntry(), gdcm::DocEntrySet::NewDataEntry(), gdcm::DocEntrySet::NewSeqEntry(), and gdcm::Document::ReadNextDocEntry(). { DictEntry *found = 0; Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); if (!pubDict) { gdcmWarningMacro( "We SHOULD have a default dictionary"); } else { found = pubDict->GetEntry(group, elem); if( found ) found->Register(); } return found; }

DocEntry * gdcm::ElementSet::GetDocEntry (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

retrieves a Dicom Element using (group, element) Parameters: group  Group number of the searched Dicom Element elem  Element number of the searched Dicom Element Returns: Implements gdcm::DocEntrySet. Definition at line 163 of file gdcmElementSet.cxx. References gdcm::ElementSet::TagHT, and gdcm::DicomEntry::TranslateToKey(). Referenced by gdcm::File::AnonymizeFile(), gdcm::File::AnonymizeNoLoad(), gdcm::FileHelper::CopyDataEntry(), CreateDicomDir(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::DoTheLoadingJob(), DoTheLoadingJob(), gdcm::File::GetPixelAreaLength(), gdcm::File::GetPixelOffset(), gdcm::Document::GetTransferSyntax(), gdcm::File::HasLUT(), gdcm::Document::IsDicomV3(), gdcm::Document::IsPapyrus(), gdcm::File::IsReadable(), gdcm::Document::LoadEntryBinArea(), gdcm::DocEntryArchive::Push(), and gdcm::DocEntryArchive::Restore(). { TagKey key = DictEntry::TranslateToKey(group, elem); TagDocEntryHT::iterator it = TagHT.find(key); if ( it!=TagHT.end() ) return it->second; return NULL; }

void * gdcm::DocEntrySet::GetEntryBinArea (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Gets (from Header) a 'non string' element value. Parameters: group  group number of the Entry elem  element number of the Entry Returns: Pointer to the 'non string' area Definition at line 69 of file gdcmDocEntrySet.cxx. References gdcm::DataEntry::GetBinArea(), and gdcm::DocEntrySet::GetDataEntry(). Referenced by gdcm::PixelReadConvert::GrabInformationsFromFile(). { DataEntry *entry = GetDataEntry(group, elem); if ( entry ) return entry->GetBinArea(); return 0; }

std::string gdcm::DocEntrySet::GetEntryForcedAsciiValue (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Return the value of the DataEntry if it's "std::string representable". Parameters: group  Group number of the searched tag. elem  Element number of the searched tag. Returns: Corresponding element value when it's "std::string representable" and the string GDCM_NOTASCII otherwise. Definition at line 84 of file gdcmDocEntrySet.cxx. References gdcm::Util::CreateCleanString(), gdcm::GDCM_NOTASCII, gdcm::GDCM_NOTLOADED, gdcm::GDCM_UNFOUND, gdcm::GDCM_UNREAD, gdcm::DataEntry::GetBinArea(), gdcm::DocEntrySet::GetDocEntry(), gdcm::DocEntry::GetLength(), gdcm::DataEntry::GetString(), gdcm::DocEntry::GetVR(), gdcm::Global::GetVR(), gdcm::Util::IsCleanArea(), gdcm::DataEntry::IsNotLoaded(), gdcm::DataEntry::IsUnfound(), gdcm::DataEntry::IsUnread(), and gdcm::VR::IsVROfStringRepresentable(). { DocEntry *d = GetDocEntry(group,elem); if ( !d ) return GDCM_UNFOUND; DataEntry *de = dynamic_cast<DataEntry *>(d); if ( de ) { if( de->IsNotLoaded() ) return GDCM_NOTLOADED; if( de->IsUnfound() ) return GDCM_UNFOUND; if( de->IsUnread() ) return GDCM_UNREAD; } if( Global::GetVR()->IsVROfStringRepresentable( de->GetVR() ) ) return de->GetString(); else { uint8_t *a = de->GetBinArea(); if( Util::IsCleanArea(a, de->GetLength()) ) return Util::CreateCleanString(a, de->GetLength()); } return GDCM_NOTASCII; }

int gdcm::DocEntrySet::GetEntryLength (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the value length of a given tag.. Parameters: group  Group number of the searched tag. elem  Element number of the searched tag. Returns: Corresponding element length; -2 if not found Definition at line 120 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::GetDocEntry(), and gdcm::DocEntry::GetLength(). Referenced by SetElement(), and gdcm::File::Write(). { DocEntry *entry = GetDocEntry(group, elem); if ( entry ) return entry->GetLength(); return -1; }

std::string gdcm::DocEntrySet::GetEntryString (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Get the "std::string representable" value of the Dicom entry. Parameters: group  Group number of the searched tag. elem  Element number of the searched tag. Returns: Corresponding element value when it exists, and the string GDCM_UNFOUND otherwise. Definition at line 47 of file gdcmDocEntrySet.cxx. References gdcm::GDCM_NOTLOADED, gdcm::GDCM_UNFOUND, gdcm::GDCM_UNREAD, gdcm::DocEntrySet::GetDocEntry(), gdcm::DataEntry::GetString(), gdcm::DataEntry::IsNotLoaded(), gdcm::DataEntry::IsUnfound(), and gdcm::DataEntry::IsUnread(). Referenced by gdcm::SerieHelper::AddFileName(), gdcm::File::AnonymizeFile(), gdcm::FileHelper::CheckMandatoryElements(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::DoTheLoadingJob(), gdcm::File::GetImageNumber(), gdcm::File::GetImageOrientationPatient(), gdcm::File::GetLUTNbits(), gdcm::File::GetModality(), gdcm::File::GetNumberOfScalarComponents(), gdcm::File::GetNumberOfScalarComponentsRaw(), gdcm::File::GetPixelSize(), gdcm::File::GetPixelType(), gdcm::Document::GetTransferSyntaxName(), gdcm::PixelReadConvert::GrabInformationsFromFile(), gdcm::File::IsMonochrome(), gdcm::File::IsMonochrome1(), gdcm::File::IsPaletteColor(), gdcm::File::IsReadable(), gdcm::File::IsYBRFull(), gdcm::Document::operator<(), and SetElement(). { DataEntry *entry = dynamic_cast<DataEntry *>(GetDocEntry(group,elem)); if ( entry ) { if( entry->IsNotLoaded() ) return GDCM_NOTLOADED; if( entry->IsUnfound() ) return GDCM_UNFOUND; if( entry->IsUnread() ) return GDCM_UNREAD; return entry->GetString(); } return GDCM_UNFOUND; }

const std::string& gdcm::Document::GetFileName (   )  const [inline, inherited]

Accessor to Filename. Definition at line 74 of file gdcmDocument.h. Referenced by DoTheLoadingJob(), gdcm::SerieHelper::FileNameGreaterThan(), gdcm::SerieHelper::FileNameLessThan(), gdcm::Document::IsParsable(), IsReadable(), gdcm::Document::Load(), ParseDirectory(), and SetElement(). { return Filename; }

FileType gdcm::Document::GetFileType (   )  [inherited]

returns the File Type (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown) Returns: the FileType code Definition at line 403 of file gdcmDocument.cxx. References gdcm::Document::Filetype. { return Filetype; }

DocEntry * gdcm::ElementSet::GetFirstEntry (   )  [virtual, inherited]

Get the first entry while visiting *the* 'zero level' DocEntrySet (DocEntries out of any Sequence). Returns: The first DocEntry if found, otherwhise NULL Implements gdcm::DocEntrySet. Definition at line 133 of file gdcmElementSet.cxx. References gdcm::ElementSet::ItTagHT, and gdcm::ElementSet::TagHT. Referenced by gdcm::Document::ComputeGroup0002Length(), DoTheLoadingJob(), NewMeta(), and gdcm::Validator::SetInput(). { ItTagHT = TagHT.begin(); if (ItTagHT != TagHT.end()) return ItTagHT->second; return NULL; }

DicomDirPatient * gdcm::DicomDir::GetFirstPatient (   )

Get the first entry while visiting the DicomDirPatients. Returns: The first DicomDirPatient if found, otherwhise NULL Definition at line 342 of file gdcmDicomDir.cxx. References ItPatient, and Patients. { ItPatient = Patients.begin(); if ( ItPatient != Patients.end() ) return *ItPatient; return NULL; }

DicomDirMeta* gdcm::DicomDir::GetMeta (   )  [inline]

Returns a pointer to the DicomDirMeta for this DICOMDIR. Definition at line 82 of file gdcmDicomDir.h. Referenced by Write(). { return MetaElems; }

DocEntry * gdcm::ElementSet::GetNextEntry (   )  [virtual, inherited]

Get the next entry while visiting *the* 'zero level' DocEntrySet (DocEntries out of any Sequence). Note: : meaningfull only if GetFirstEntry already called Returns: The next DocEntry if found, otherwhise NULL Implements gdcm::DocEntrySet. Definition at line 147 of file gdcmElementSet.cxx. References gdcmAssertMacro, gdcm::ElementSet::ItTagHT, and gdcm::ElementSet::TagHT. Referenced by gdcm::Document::ComputeGroup0002Length(), and gdcm::Validator::SetInput(). { gdcmAssertMacro (ItTagHT != TagHT.end()); ++ItTagHT; if (ItTagHT != TagHT.end()) return ItTagHT->second; return NULL; }

DicomDirPatient * gdcm::DicomDir::GetNextPatient (   )

Get the next entry while visiting the DicomDirPatients. Note: : meaningfull only if GetFirstEntry already called Returns: The next DicomDirPatient if found, otherwhise NULL Definition at line 355 of file gdcmDicomDir.cxx. References gdcmAssertMacro, ItPatient, and Patients. { gdcmAssertMacro (ItPatient != Patients.end()); ++ItPatient; if ( ItPatient != Patients.end() ) return *ItPatient; return NULL; }

int gdcm::Base::GetPrintLevel (   )  [inline, inherited]

Gets the print level for the Dicom Entries. Definition at line 50 of file gdcmBase.h. { return PrintLevel; }

float gdcm::DicomDir::GetProgress (   )  [inline]

GetProgress GetProgress. Definition at line 119 of file gdcmDicomDir.h. { return Progress; }

Dict * gdcm::Document::GetPubDict (   )  [inherited]

Get the public dictionary used. Definition at line 300 of file gdcmDocument.cxx. References gdcm::Document::RefPubDict. Referenced by SetElement(). { return RefPubDict; }

const unsigned long& gdcm::RefCounter::GetRefCount (   )  const [inline, inherited]

Get the reference counting. Returns: Reference count Definition at line 57 of file gdcmRefCounter.h. { return RefCount; }

SeqEntry * gdcm::DocEntrySet::GetSeqEntry (  uint16_t  group, uint16_t  elem )  [inherited]

Same as Document::GetDocEntry except it only returns a result when the corresponding entry is of type SeqEntry. Parameters: group  Group number of the searched Dicom Element elem  Element number of the searched Dicom Element Returns: When present, the corresponding SeqEntry. Definition at line 153 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::GetDocEntry(). Referenced by gdcm::Document::DoTheLoadingDocumentJob(). { DocEntry *currentEntry = GetDocEntry(group, elem); if ( !currentEntry ) return NULL; return dynamic_cast<SeqEntry*>(currentEntry); }

Dict * gdcm::Document::GetShaDict (   )  [inherited]

Get the shadow dictionary used. Definition at line 308 of file gdcmDocument.cxx. References gdcm::Document::RefShaDict. { return RefShaDict; }

int gdcm::Document::GetSwapCode (   )  [inline, inherited]

'Swap code' accessor (see SwapCode ) Definition at line 70 of file gdcmDocument.h. Referenced by gdcm::PixelReadConvert::GrabInformationsFromFile(). { return SwapCode; }

std::string gdcm::Document::GetTransferSyntax (   )  [inherited]

Accessor to the Transfer Syntax (when present) of the current document (it internally handles reading the value from disk when only parsing occured). Returns: The encountered Transfer Syntax of the current document, if DICOM. GDCM_UNKNOWN for ACR-NEMA files (or broken headers ...) Definition at line 415 of file gdcmDocument.cxx. References gdcm::GDCM_UNKNOWN, gdcmWarningMacro, gdcm::ElementSet::GetDocEntry(), and gdcm::Document::LoadDocEntrySafe(). Referenced by gdcm::File::ComputeJPEGFragmentInfo(), gdcm::File::ComputeRLEInfo(), gdcm::File::DoTheLoadingJob(), gdcm::PixelReadConvert::GrabInformationsFromFile(), and gdcm::Document::HandleOutOfGroup0002(). { DocEntry *entry = GetDocEntry(0x0002, 0x0010); if ( !entry ) { return GDCM_UNKNOWN; } // The entry might be present but not loaded (parsing and loading // happen at different stages): try loading and proceed with check... LoadDocEntrySafe(entry); if (DataEntry *dataEntry = dynamic_cast<DataEntry *>(entry) ) { std::string transfer = dataEntry->GetString(); // The actual transfer (as read from disk) might be padded. We // first need to remove the potential padding. We can make the // weak assumption that padding was not executed with digits... if ( transfer.length() == 0 ) { // for brain damaged headers gdcmWarningMacro( "Transfer Syntax has length = 0."); return GDCM_UNKNOWN; } while ( !isdigit((unsigned char)transfer[transfer.length()-1]) ) { transfer.erase(transfer.length()-1, 1); if ( transfer.length() == 0 ) { // for brain damaged headers gdcmWarningMacro( "Transfer Syntax contains no valid character."); return GDCM_UNKNOWN; } } return transfer; } return GDCM_UNKNOWN; }

std::string gdcm::Document::GetTransferSyntaxName (   )  [inherited]

Accesses the info from 0002,0010 : Transfer Syntax and TS. Returns: The full Transfer Syntax Name (as opposed to Transfer Syntax UID) Definition at line 457 of file gdcmDocument.cxx. References gdcm::GDCM_NOTLOADED, gdcm::GDCM_UNFOUND, gdcmDebugMacro, gdcmErrorMacro, gdcm::DocEntrySet::GetEntryString(), and gdcm::Global::GetTS(). Referenced by gdcm::Document::HandleOutOfGroup0002(). { // use the TS (TS : Transfer Syntax) std::string transferSyntax = GetEntryString(0x0002,0x0010); if ( (transferSyntax.find(GDCM_NOTLOADED) < transferSyntax.length()) ) { gdcmErrorMacro( "Transfer Syntax not loaded. " << std::endl << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE" ); return "Uncompressed ACR-NEMA"; } if ( transferSyntax == GDCM_UNFOUND ) { gdcmDebugMacro( "Unfound Transfer Syntax (0002,0010)"); return "Uncompressed ACR-NEMA"; } // we do it only when we need it const TSKey &tsName = Global::GetTS()->GetValue( transferSyntax ); // Global::GetTS() is a global static you shall never try to delete it! return tsName; }

bool gdcm::DicomDir::HeaderLessThan (  Document *  header1, Document *  header2 )  [static, private]

compares two files Definition at line 1182 of file gdcmDicomDir.cxx. Referenced by CreateDicomDirChainedList(). { return *header1 < *header2; }

void gdcm::DicomDir::Initialize (   )  [private]

Sets all fields to NULL. Reimplemented from gdcm::Document. Definition at line 681 of file gdcmDicomDir.cxx. References Abort, EndArg, EndMethod, EndMethodArgDelete, MetaElems, Progress, ProgressArg, ProgressMethod, ProgressMethodArgDelete, StartArg, StartMethod, and StartMethodArgDelete. Referenced by DicomDir(). { StartMethod = NULL; ProgressMethod = NULL; EndMethod = NULL; StartMethodArgDelete = NULL; ProgressMethodArgDelete = NULL; EndMethodArgDelete = NULL; StartArg = NULL; ProgressArg = NULL; EndArg = NULL; Progress = 0.0; Abort = false; MetaElems = NULL; }

DataEntry * gdcm::DocEntrySet::InsertEntryBinArea (  uint8_t *  binArea, int  lgth, uint16_t  group, uint16_t  elem, VRKey const &  vr = GDCM_VRUNKNOWN )  [inherited]

Modifies the value of a given Header Entry (Dicom Element) when it exists. Create it with the given value when unexistant. A copy of the binArea is made to be kept in the Document. Parameters: binArea  (binary) value to be set lgth  length of the Bin Area we want to set group  Group number of the Entry elem  Element number of the Entry vr  V(alue) R(epresentation) of the Entry -if private Entry- Returns: pointer to the modified/created Header Entry (NULL when creation failed). Definition at line 308 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::AddEntry(), gdcm::RefCounter::Delete(), gdcmWarningMacro, gdcm::DocEntrySet::GetDocEntry(), gdcm::DocEntry::GetVR(), gdcm::DocEntrySet::NewDataEntry(), gdcm::DocEntrySet::RemoveEntry(), and gdcm::DocEntrySet::SetEntryBinArea(). Referenced by gdcm::FileHelper::InsertEntryBinArea(). { DataEntry *dataEntry = 0; DocEntry *currentEntry = GetDocEntry( group, elem ); // Verify the currentEntry if (currentEntry) { dataEntry = dynamic_cast<DataEntry *>(currentEntry); // Verify the VR if ( dataEntry ) if ( dataEntry->GetVR()!=vr ) dataEntry = NULL; // if currentEntry doesn't correspond to the requested dataEntry if ( !dataEntry) { if ( !RemoveEntry(currentEntry) ) { gdcmWarningMacro( "Removal of previous DocEntry failed."); return NULL; } } } // Create a new dataEntry if necessary if ( !dataEntry) { dataEntry = NewDataEntry(group, elem, vr); if ( !AddEntry(dataEntry) ) { gdcmWarningMacro( "AddEntry failed although this is a creation."); dataEntry->Delete(); return NULL; } dataEntry->Delete(); } // Set the dataEntry value uint8_t *tmpArea; if ( lgth>0 && binArea ) { tmpArea = new uint8_t[lgth]; memcpy(tmpArea,binArea,lgth); } else { tmpArea = 0; } if ( !SetEntryBinArea(tmpArea,lgth,dataEntry) ) { if ( tmpArea ) { delete[] tmpArea; } } return dataEntry; }

DataEntry * gdcm::DocEntrySet::InsertEntryString (  std::string const &  value, uint16_t  group, uint16_t  elem, VRKey const &  vr = GDCM_VRUNKNOWN )  [inherited]

Modifies the value of a given Doc Entry (Dicom Element) when it exists. Create it with the given value when unexistant. Parameters: value  (string) Value to be set group  Group number of the Entry elem  Element number of the Entry vr  V(alue) R(epresentation) of the Entry -if private Entry- Returns: pointer to the modified/created Header Entry (NULL when creation failed). Definition at line 250 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::AddEntry(), gdcm::RefCounter::Delete(), gdcmWarningMacro, gdcm::DocEntrySet::GetDocEntry(), gdcm::DocEntry::GetVR(), gdcm::DocEntrySet::NewDataEntry(), gdcm::DocEntrySet::RemoveEntry(), and gdcm::DocEntrySet::SetEntryString(). Referenced by gdcm::FileHelper::InsertEntryString(), gdcm::FileHelper::Write(), and gdcm::File::Write(). { DataEntry *dataEntry = 0; DocEntry *currentEntry = GetDocEntry( group, elem ); if (currentEntry) { dataEntry = dynamic_cast<DataEntry *>(currentEntry); // Verify the VR if ( dataEntry ) if ( dataEntry->GetVR()!=vr ) dataEntry = NULL; // if currentEntry doesn't correspond to the requested dataEntry if ( !dataEntry) { if ( !RemoveEntry(currentEntry) ) { gdcmWarningMacro( "Removal of previous DocEntry failed."); return NULL; } } } // Create a new dataEntry if necessary if ( !dataEntry ) { dataEntry = NewDataEntry( group, elem, vr ); if ( !AddEntry(dataEntry) ) { gdcmWarningMacro("AddEntry failed although this is a creation."); dataEntry->Delete(); return NULL; } dataEntry->Delete(); } // Set the dataEntry value SetEntryString(value, dataEntry); // The std::string value return dataEntry; }

SeqEntry * gdcm::DocEntrySet::InsertSeqEntry (  uint16_t  group, uint16_t  elem )  [inherited]

Modifies the value of a given Doc Entry (Dicom Element) when it exists. Creates it when unexistant. Parameters: group  Group number of the Entry elem  Element number of the Entry Returns: pointer to the modified/created SeqEntry (NULL when creation failed). Definition at line 380 of file gdcmDocEntrySet.cxx. References gdcm::DocEntrySet::AddEntry(), gdcm::RefCounter::Delete(), gdcmWarningMacro, gdcm::DocEntrySet::GetDocEntry(), gdcm::DocEntrySet::NewSeqEntry(), and gdcm::DocEntrySet::RemoveEntry(). Referenced by gdcm::FileHelper::InsertSeqEntry(). { SeqEntry *seqEntry = 0; DocEntry *currentEntry = GetDocEntry( group, elem ); // Verify the currentEntry if ( currentEntry ) { seqEntry = dynamic_cast<SeqEntry *>(currentEntry); // Verify the VR if ( seqEntry ) seqEntry = NULL; // if currentEntry doesn't correspond to the requested seqEntry if ( !seqEntry ) { if (!RemoveEntry(currentEntry)) { gdcmWarningMacro( "Removal of previous DocEntry failed."); return NULL; } } } // Create a new seqEntry if necessary if ( !seqEntry ) { seqEntry = NewSeqEntry(group, elem); if ( !AddEntry(seqEntry) ) { gdcmWarningMacro( "AddEntry failed although this is a creation."); seqEntry->Delete(); return NULL; } seqEntry->Delete(); } // TODO : Find a trick to insert a SequenceDelimitationItem // in the SeqEntry, at the end. return seqEntry; }

bool gdcm::DicomDir::IsAborted (   )  [inline]

IsAborted IsAborted. Definition at line 123 of file gdcmDicomDir.h. { return Abort; }

bool gdcm::Document::IsDicomV3 (   )  [inherited]

Predicate for dicom version 3 file. Returns: True when the file is a dicom version 3. Definition at line 372 of file gdcmDocument.cxx. References gdcm::ElementSet::GetDocEntry(). Referenced by gdcm::File::GetYSize(), and gdcm::PixelReadConvert::GrabInformationsFromFile(). { // Checking if Transfer Syntax exists is enough // Anyway, it's too late check if the 'Preamble' was found ... // And ... would it be a rich idea to check ? // (some 'no Preamble' DICOM images exist !) return GetDocEntry(0x0002, 0x0010) != NULL; }

bool gdcm::ElementSet::IsEmpty (   )  [inline, virtual, inherited]

Tells us if the ElementSet contains no entry. Implements gdcm::DocEntrySet. Definition at line 60 of file gdcmElementSet.h. Referenced by gdcm::Document::DoTheLoadingDocumentJob(), and gdcm::Document::IsParsable(). { return TagHT.empty(); }

bool gdcm::Document::IsPapyrus (   )  [inherited]

Predicate for Papyrus file Dedicated to whomsoever it may concern. Returns: True when the file is a Papyrus file. Definition at line 386 of file gdcmDocument.cxx. References gdcm::ElementSet::GetDocEntry(). { // check for Papyrus private Sequence DocEntry *e = GetDocEntry(0x0041, 0x1050); if ( !e ) return false; // check if it's actually a Sequence if ( !dynamic_cast<SeqEntry*>(e) ) return false; return true; }

bool gdcm::Document::IsParsable (   )  [inherited]

This predicate tells us whether or not the current Document was properly parsed and contains at least *one* Dicom Element (and nothing more, sorry). Returns: false when we're 150 % sure it's NOT a Dicom/Acr file, true otherwise. Definition at line 340 of file gdcmDocument.cxx. References gdcm::Document::Filetype, gdcmWarningMacro, gdcm::Document::GetFileName(), gdcm::ElementSet::IsEmpty(), and gdcm::Unknown. Referenced by gdcm::Document::IsReadable(). { if ( Filetype == Unknown ) { gdcmWarningMacro( "Wrong filetype for " << GetFileName()); return false; } if ( IsEmpty() ) { gdcmWarningMacro( "No tag in internal hash table."); return false; } return true; }

bool gdcm::DicomDir::IsReadable (   )  [virtual]

This predicate, based on hopefully reasonable heuristics, decides whether or not the current document was properly parsed and contains the mandatory information for being considered as a well formed and usable DicomDir. Returns: true when Document is the one of a reasonable DicomDir, false otherwise. Reimplemented from gdcm::Document. Definition at line 259 of file gdcmDicomDir.cxx. References gdcm::Document::Filetype, gdcmErrorMacro, gdcmWarningMacro, gdcm::Document::GetFileName(), MetaElems, Patients, and gdcm::Unknown. { if ( Filetype == Unknown ) { gdcmErrorMacro( "Wrong filetype for " << GetFileName()); return false; } if ( !MetaElems ) { gdcmWarningMacro( "Meta Elements missing in DicomDir"); return false; } if ( Patients.size() <= 0 ) { gdcmWarningMacro( "NO Patient in DicomDir"); return false; } return true; }

bool gdcm::Document::Load (  std::string const &  fileName  )  [virtual, inherited]

Loader. (DEPRECATED : not to break the API). Parameters: fileName  'Document' (File or DicomDir) to be open for parsing Returns: false if file cannot be open or no swap info was found, or no tag was found. Definition at line 99 of file gdcmDocument.cxx. References gdcm::Document::DoTheLoadingDocumentJob(), and gdcm::Document::Filename. { Filename = fileName; return DoTheLoadingDocumentJob( ); }

bool gdcm::DicomDir::Load (   )  [virtual]

Loader. use SetFileName(fn) or SetLoadMode(lm) + SetDirectoryName(dn) before ! Returns: false if file cannot be open or no swap info was found, or no tag was found. Reimplemented from gdcm::Document. Definition at line 152 of file gdcmDicomDir.cxx. References DoTheLoadingJob(), and ParseDir. { if (!ParseDir) { if ( ! this->Document::Load( ) ) return false; } return DoTheLoadingJob( ); }

void gdcm::Document::LoadDocEntrySafe (  DocEntry *  entry  )  [inherited]

Loads the element while preserving the current underlying file position indicator as opposed to LoadDocEntry that modifies it. Parameters: entry  DocEntry whose value will be loaded. Definition at line 822 of file gdcmDocument.cxx. References gdcm::Document::Fp, and gdcm::Document::LoadDocEntry(). Referenced by gdcm::Document::GetTransferSyntax(). { if ( Fp ) { long PositionOnEntry = Fp->tellg(); LoadDocEntry(entry); Fp->seekg(PositionOnEntry, std::ios::beg); } }

void gdcm::Document::LoadEntryBinArea (  DataEntry *  entry  )  [virtual, inherited]

Loads (from disk) the element content when a string is not suitable. Parameters: entry  Entry whose binArea is going to be loaded Definition at line 741 of file gdcmDocument.cxx. References gdcm::Document::CloseFile(), gdcm::Document::Fp, gdcmWarningMacro, gdcm::VR::GetAtomicElementLength(), gdcm::DataEntry::GetBinArea(), gdcm::DocEntry::GetElement(), gdcm::DocEntry::GetGroup(), gdcm::DocEntry::GetLength(), gdcm::DocEntry::GetOffset(), gdcm::DocEntry::GetVR(), gdcm::Global::GetVR(), gdcm::Document::OpenFile(), gdcm::DataEntry::SetBinArea(), gdcm::DataEntry::SetState(), gdcm::DataEntry::STATE_UNREAD, gdcm::Document::SwapDouble(), gdcm::Document::SwapLong(), and gdcm::Document::SwapShort(). { if( entry->GetBinArea() ) return; bool openFile = !Fp; if ( openFile ) OpenFile(); size_t o =(size_t)entry->GetOffset(); Fp->seekg(o, std::ios::beg); size_t l = entry->GetLength(); uint8_t *data = new uint8_t[l]; if ( !data ) { gdcmWarningMacro( "Cannot allocate DataEntry content for : " << std::hex << entry->GetGroup() << "|" << entry->GetElement() ); return; } // Read the data Fp->read((char*)data, l); if ( Fp->fail() || Fp->eof() ) { delete[] data; entry->SetState(DataEntry::STATE_UNREAD); return; } // Swap the data content if necessary uint32_t i; unsigned short vrLgth = Global::GetVR()->GetAtomicElementLength(entry->GetVR()); // FIXME : trouble expected if we read an ... OW Entry (LUT, etc ..) // if( entry->GetVR() == "OW" ) // vrLgth = 1; switch(vrLgth) { case 1: { break; } case 2: { uint16_t *data16 = (uint16_t *)data; for(i=0;i<l/vrLgth;i++) data16[i] = SwapShort(data16[i]); break; } case 4: { uint32_t *data32 = (uint32_t *)data; for(i=0;i<l/vrLgth;i++) data32[i] = SwapLong(data32[i]); break; } case 8: { double *data64 = (double *)data; for(i=0;i<l/vrLgth;i++) data64[i] = SwapDouble(data64[i]); break; } } entry->SetBinArea(data); if ( openFile ) CloseFile(); }

void gdcm::Document::LoadEntryBinArea (  uint16_t  group, uint16_t  elem )  [virtual, inherited]

Loads (from disk) the element content when a string is not suitable. Parameters: group  group number of the Entry elem  element number of the Entry Definition at line 716 of file gdcmDocument.cxx. References gdcmDebugMacro, gdcmWarningMacro, and gdcm::ElementSet::GetDocEntry(). Referenced by gdcm::Document::DoTheLoadingDocumentJob(), gdcm::PixelReadConvert::GrabInformationsFromFile(), and gdcm::Document::LoadDocEntry(). { // Search the corresponding DocEntry DocEntry *docEntry = GetDocEntry(group, elem); if ( !docEntry ) { gdcmDebugMacro(std::hex << group << "|" << elem << " doesn't exist" ); return; } DataEntry *dataEntry = dynamic_cast<DataEntry *>(docEntry); if ( !dataEntry ) { gdcmWarningMacro(std::hex << group << "|" << elem << " is NOT a DataEntry"); return; } LoadEntryBinArea(dataEntry); }

bool gdcm::ElementSet::MayIWrite (  uint16_t   )  [inline, protected, inherited]

Some group are illegal withing some Dicom Documents Only the Document knows it. Reimplemented in gdcm::File. Definition at line 67 of file gdcmElementSet.h. Referenced by gdcm::ElementSet::WriteContent(). { return true; }

void gdcm::DicomDir::MoveSQItem (  DocEntrySet *  dst, DocEntrySet *  src )  [private]

Move the content of the source SQItem to the destination SQItem Only DocEntry's are moved. Parameters: dst  destination SQItem src  source SQItem Definition at line 1165 of file gdcmDicomDir.cxx. References gdcm::DocEntrySet::AddEntry(), gdcm::DocEntrySet::GetFirstEntry(), and gdcm::DocEntrySet::RemoveEntry(). { DocEntry *entry; entry = src->GetFirstEntry(); while(entry) { src->RemoveEntry(entry); dst->AddEntry(entry); // we destroyed -> the current iterator is not longer valid entry = src->GetFirstEntry(); } }

static DicomDir* gdcm::DicomDir::New (   )  [inline, static]

Definition at line 56 of file gdcmDicomDir.h. {return new DicomDir();}

DataEntry * gdcm::DocEntrySet::NewDataEntry (  uint16_t  group, uint16_t  elem, VRKey const &  vr = GDCM_VRUNKNOWN )  [inherited]

Build a new Val Entry from all the low level arguments. Check for existence of dictionary entry, and build a default one when absent. Parameters: group  Group number of the new Entry elem  Element number of the new Entry vr  V(alue) R(epresentation) of the new Entry Remarks: The user of this method must destroy the DataEntry when unused Definition at line 444 of file gdcmDocEntrySet.cxx. References gdcmWarningMacro, gdcm::DocEntrySet::GetDictEntry(), gdcm::DataEntry::New(), and gdcm::RefCounter::Unregister(). Referenced by gdcm::FileHelper::CopyDataEntry(), gdcm::DocEntrySet::InsertEntryBinArea(), gdcm::DocEntrySet::InsertEntryString(), and gdcm::Document::ReadNextDocEntry(). { DictEntry *dictEntry = GetDictEntry(group, elem, vr); DataEntry *newEntry = DataEntry::New(dictEntry); dictEntry->Unregister(); // GetDictEntry register it if (!newEntry) { gdcmWarningMacro( "Failed to allocate DataEntry"); return 0; } return newEntry; }

DicomDirMeta * gdcm::DicomDir::NewMeta (   )

adds *the* Meta to a partially created DICOMDIR Definition at line 283 of file gdcmDicomDir.cxx. References gdcm::SQItem::AddEntry(), gdcm::RefCounter::Delete(), gdcm::ElementSet::GetFirstEntry(), MetaElems, gdcm::DicomDirMeta::New(), gdcm::ElementSet::RemoveEntry(), and gdcm::SQItem::SetSQItemNumber(). Referenced by CreateDicomDir(), DicomDir(), and DoTheLoadingJob(). { if ( MetaElems ) MetaElems->Delete(); DocEntry *entry = GetFirstEntry(); if ( entry ) { MetaElems = DicomDirMeta::New(true); // true = empty entry = GetFirstEntry(); while( entry ) { if ( dynamic_cast<SeqEntry *>(entry) ) break; MetaElems->AddEntry(entry); RemoveEntry(entry); entry = GetFirstEntry(); } } else // after root directory parsing { MetaElems = DicomDirMeta::New(false); // false = not empty } MetaElems->SetSQItemNumber(0); // To avoid further missprinting return MetaElems; }

DicomDirPatient * gdcm::DicomDir::NewPatient (   )

adds a new Patient (with the basic elements) to a partially created DICOMDIR Definition at line 317 of file gdcmDicomDir.cxx. References AddPatientToEnd(), and gdcm::DicomDirPatient::New(). { DicomDirPatient *dd = DicomDirPatient::New(); AddPatientToEnd( dd ); return dd; }

SeqEntry * gdcm::DocEntrySet::NewSeqEntry (  uint16_t  group, uint16_t  elem )  [inherited]

Build a new Seq Entry from all the low level arguments. Check for existence of dictionary entry, and build a default one when absent. Parameters: group  Group number of the new Entry elem  Element number of the new Entry Remarks: The user of this method must destroy the SeqEntry when unused Definition at line 467 of file gdcmDocEntrySet.cxx. References gdcmWarningMacro, gdcm::DocEntrySet::GetDictEntry(), gdcm::SeqEntry::New(), and gdcm::RefCounter::Unregister(). Referenced by gdcm::Document::Backtrack(), gdcm::DocEntrySet::InsertSeqEntry(), and gdcm::Document::ReadNextDocEntry(). { DictEntry *dictEntry = GetDictEntry(group, elem, "SQ"); SeqEntry *newEntry = SeqEntry::New( dictEntry ); dictEntry->Unregister(); // GetDictEntry register it if (!newEntry) { gdcmWarningMacro( "Failed to allocate SeqEntry"); return 0; } return newEntry; }

std::ifstream * gdcm::Document::OpenFile (   )  [inherited]

Tries to open the file Document::Filename and checks the preamble when existing. Returns: The FILE pointer on success. Definition at line 572 of file gdcmDocument.cxx. References gdcm::Document::CloseFile(), gdcm::Document::Filename, gdcm::Util::Format(), gdcm::Document::Fp, gdcmDebugMacro, gdcmWarningMacro, and gdcm::Document::HasDCMPreamble. Referenced by gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::DoTheLoadingJob(), gdcm::FileHelper::GetRaw(), and gdcm::Document::LoadEntryBinArea(). { HasDCMPreamble = false; if (Filename.length() == 0) { return 0; } if ( Fp ) { gdcmDebugMacro( "File already open: " << Filename.c_str()); CloseFile(); } Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary); if ( ! *Fp ) { // Don't user gdcmErrorMacro : // a spurious message will appear when you use, for instance // gdcm::FileHelper *fh = new gdcm::FileHelper( outputFileName ); // to create outputFileName. // FIXME : if the upper comment is still usefull // --> the constructor is not so good ... gdcmWarningMacro( "Cannot open file: " << Filename.c_str()); delete Fp; Fp = 0; return 0; //exit(1); // No function is allowed to leave the application instead // of warning the caller } uint16_t zero = 0; Fp->read((char*)&zero, (size_t)2); if ( Fp->eof() ) { CloseFile(); return 0; } //-- Broken ACR or DICOM with no Preamble; may start with a Shadow Group -- // FIXME : We cannot be sure the preable is only zeroes.. // (see ACUSON-24-YBR_FULL-RLE.dcm ) if ( zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 || zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 || zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 || zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 ) { std::string msg = Util::Format( "ACR/DICOM starting by 0x(%04x) at the beginning of the file\n", zero); // FIXME : is it a Warning message, or a Debug message? gdcmWarningMacro( msg.c_str() ); return Fp; } //-- DICOM -- Fp->seekg(126L, std::ios::cur); char dicm[4]; // = {' ',' ',' ',' '}; Fp->read(dicm, (size_t)4); if ( Fp->eof() ) { CloseFile(); return 0; } if ( memcmp(dicm, "DICM", 4) == 0 ) { HasDCMPreamble = true; return Fp; } // -- Neither ACR/No Preamble Dicom nor DICOMV3 file CloseFile(); // Don't user Warning nor Error, not to polute the output // while directory recursive parsing ... gdcmDebugMacro( "Neither ACR/No Preamble Dicom nor DICOMV3 file: " << Filename.c_str()); return 0; }

bool gdcm::Document::operator< (  Document &  document  )  [inherited]

Compares two documents, according to DicomDir rules. Warning: Does NOT work with ACR-NEMA files Todo: Find a trick to solve the pb (use RET fields ?) Parameters: document  to compare with current one Returns: true if 'smaller' Definition at line 839 of file gdcmDocument.cxx. References gdcm::DocEntrySet::GetEntryString(). { // Patient Name std::string s1 = GetEntryString(0x0010,0x0010); std::string s2 = document.GetEntryString(0x0010,0x0010); if (s1 < s2) { return true; } else if ( s1 > s2 ) { return false; } else { // Patient ID s1 = GetEntryString(0x0010,0x0020); s2 = document.GetEntryString(0x0010,0x0020); if ( s1 < s2 ) { return true; } else if ( s1 > s2 ) { return false; } else { // Study Instance UID s1 = GetEntryString(0x0020,0x000d); s2 = document.GetEntryString(0x0020,0x000d); if ( s1 < s2 ) { return true; } else if ( s1 > s2 ) { return false; } else { // Serie Instance UID s1 = GetEntryString(0x0020,0x000e); s2 = document.GetEntryString(0x0020,0x000e); if ( s1 < s2 ) { return true; } else if ( s1 > s2 ) { return false; } } } } return false; }

void gdcm::DicomDir::ParseDirectory (   )

fills the whole structure, starting from a root Directory Definition at line 368 of file gdcmDicomDir.cxx. References CreateDicomDir(), CreateDicomDirChainedList(), and gdcm::Document::GetFileName(). Referenced by DoTheLoadingJob(). { CreateDicomDirChainedList( GetFileName() ); CreateDicomDir(); }

void gdcm::DicomDir::Print (  std::ostream &  os = std::cout, std::string const &  indent = "" )  [virtual]

Canonical Printer. Parameters: os  ostream we want to print in indent  Indentation string to be prepended during printing Reimplemented from gdcm::ElementSet. Definition at line 1194 of file gdcmDicomDir.cxx. References MetaElems, Patients, gdcm::DicomDirMeta::Print(), gdcm::Base::PrintLevel, and gdcm::Base::SetPrintLevel(). { if ( MetaElems ) { MetaElems->SetPrintLevel(PrintLevel); MetaElems->Print(os); } for(ListDicomDirPatient::iterator cc = Patients.begin(); cc != Patients.end(); ++cc) { (*cc)->SetPrintLevel(PrintLevel); (*cc)->Print(os); } }

uint16_t gdcm::Document::ReadInt16 (   )  throw ( FormatError ) [protected, inherited]

Reads a supposed to be 16 Bits integer (swaps it depending on processor endianness). Returns: read value Definition at line 904 of file gdcmDocument.cxx. References gdcm::Document::Fp, and gdcm::Document::SwapShort(). Referenced by gdcm::Document::FindDocEntryLengthOBOrOW(), gdcm::Document::ReadNextDocEntry(), and gdcm::File::ReadTag(). { uint16_t g; Fp->read ((char*)&g, (size_t)2); if ( Fp->fail() ) { throw FormatError( "Document::ReadInt16()", " file error." ); } if ( Fp->eof() ) { throw FormatError( "Document::ReadInt16()", "EOF." ); } g = SwapShort(g); return g; }

uint32_t gdcm::Document::ReadInt32 (   )  throw ( FormatError ) [protected, inherited]

Reads a supposed to be 32 Bits integer (swaps it depending on processor endianness). Returns: read value Definition at line 926 of file gdcmDocument.cxx. References gdcm::Document::Fp, and gdcm::Document::SwapLong(). Referenced by gdcm::File::ComputeRLEInfo(), gdcm::Document::FindDocEntryLengthOBOrOW(), and gdcm::File::ReadTagLength(). { uint32_t g; Fp->read ((char*)&g, (size_t)4); if ( Fp->fail() ) { throw FormatError( "Document::ReadInt32()", " file error." ); } if ( Fp->eof() ) { throw FormatError( "Document::ReadInt32()", "EOF." ); } g = SwapLong(g); return g; }

void gdcm::RefCounter::Register (   )  [inline, inherited]

Register the object. Remarks: It increments the reference counting Definition at line 45 of file gdcmRefCounter.h. Referenced by gdcm::SQItem::AddEntry(), gdcm::ElementSet::AddEntry(), gdcm::Dict::AddEntry(), gdcm::SeqEntry::AddSQItem(), gdcm::DocEntry::DocEntry(), gdcm::FileHelper::FileHelper(), gdcm::DocEntrySet::GetDictEntry(), gdcm::DocEntryArchive::Push(), gdcm::Dict::ReplaceEntry(), and gdcm::SeqEntry::SetDelimitationItem(). { RefCount++; }

bool gdcm::ElementSet::RemoveEntry (  DocEntry *  entryToRemove  )  [virtual, inherited]

Clear the hash table from given entry AND delete the entry. Parameters: entryToRemove  Entry to remove AND delete. Implements gdcm::DocEntrySet. Definition at line 99 of file gdcmElementSet.cxx. References gdcmWarningMacro, gdcm::DocEntry::GetKey(), gdcm::ElementSet::TagHT, and gdcm::RefCounter::Unregister(). Referenced by gdcm::Document::Backtrack(), gdcm::File::DoTheLoadingJob(), NewMeta(), gdcm::Document::ParseDES(), gdcm::DocEntryArchive::Push(), and gdcm::DocEntryArchive::Restore(). { const TagKey &key = entryToRemove->GetKey(); if ( TagHT.count(key) == 1 ) { TagHT.erase(key); entryToRemove->Unregister(); return true; } gdcmWarningMacro( "Key not present : " << key); return false ; }

void gdcm::DicomDir::SetDirectoryName (  std::string const &  dirName  )  [inline]

Sets the root Directory name to parse, recursively. Definition at line 65 of file gdcmDicomDir.h. { ParseDir = true; if (Filename != dirName) Filename = dirName, IsDocumentModified = true; }

void gdcm::DicomDir::SetElement (  std::string const &  path, DicomDirType  type, Document *  header )  [private]

adds to the HTable the Entries (Dicom Elements) corresponding to the given type Parameters: path  full path file name (only used when type = GDCM_DICOMDIR_IMAGE type  DicomDirObject type to create (GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE ...) header  Header of the current file Definition at line 988 of file gdcmDicomDir.cxx. References gdcm::SQItem::AddEntry(), AddImageToEnd(), AddPatientToEnd(), AddSerieToEnd(), AddStudyToEnd(), gdcm::RefCounter::Delete(), GDCM_DICOMDIR_IMAGE, GDCM_DICOMDIR_META, GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_SERIE, GDCM_DICOMDIR_STUDY, gdcm::GDCM_UNFOUND, gdcmDebugMacro, gdcmErrorMacro, gdcmWarningMacro, gdcm::Global::GetDicomDirElements(), gdcm::DicomDirElement::GetDicomDirImageElements(), gdcm::DicomDirElement::GetDicomDirMetaElements(), gdcm::DicomDirElement::GetDicomDirPatientElements(), gdcm::DicomDirElement::GetDicomDirSerieElements(), gdcm::DicomDirElement::GetDicomDirStudyElements(), gdcm::Dict::GetEntry(), gdcm::DocEntrySet::GetEntryLength(), gdcm::DocEntrySet::GetEntryString(), gdcm::Document::GetFileName(), gdcm::Util::GetName(), gdcm::Document::GetPubDict(), MetaElems, gdcm::DataEntry::New(), gdcm::DicomDirMeta::New(), gdcm::DicomDirPatient::New(), gdcm::DicomDirStudy::New(), gdcm::DicomDirSerie::New(), gdcm::DicomDirImage::New(), gdcm::DocEntry::SetOffset(), and gdcm::DataEntry::SetString(). Referenced by SetElements(). { ListDicomDirElem elemList; ListDicomDirElem::const_iterator it; uint16_t tmpGr, tmpEl; DictEntry *dictEntry; DataEntry *entry; std::string val; SQItem *si; switch( type ) { case GDCM_DICOMDIR_IMAGE: elemList = Global::GetDicomDirElements()->GetDicomDirImageElements(); si = DicomDirImage::New(true); if ( !AddImageToEnd(static_cast<DicomDirImage *>(si)) ) { si->Delete(); gdcmErrorMacro( "Add ImageToEnd failed"); } break; case GDCM_DICOMDIR_SERIE: elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements(); si = DicomDirSerie::New(true); if ( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) ) { si->Delete(); gdcmErrorMacro( "Add SerieToEnd failed"); } break; case GDCM_DICOMDIR_STUDY: elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements(); si = DicomDirStudy::New(true); if ( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) ) { si->Delete(); gdcmErrorMacro( "Add StudyToEnd failed"); } break; case GDCM_DICOMDIR_PATIENT: elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements(); si = DicomDirPatient::New(true); if ( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) ) { si->Delete(); gdcmErrorMacro( "Add PatientToEnd failed"); } break; case GDCM_DICOMDIR_META: if ( MetaElems ) { MetaElems->Delete(); gdcmErrorMacro( "MetaElements already exist, they will be destroyed"); } elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements(); MetaElems = DicomDirMeta::New(true); si = MetaElems; break; default: return; } // FIXME : troubles found when it's a SeqEntry // removed all the seems-to-be-useless stuff about Referenced Image Sequence // to avoid further troubles // imageElem 0008 1140 "" // Referenced Image Sequence // imageElem fffe e000 "" // 'no length' item : length to be set to 0xffffffff later // imageElem 0008 1150 "" // Referenced SOP Class UID : to be set/forged later // imageElem 0008 1155 "" // Referenced SOP Instance UID : to be set/forged later // imageElem fffe e00d "" // Item delimitation : length to be set to ZERO later std::string referencedVal; // for all the relevant elements found in their own spot of the DicomDir.dic for( it = elemList.begin(); it != elemList.end(); ++it) { tmpGr = it->Group; tmpEl = it->Elem; dictEntry = GetPubDict()->GetEntry(tmpGr, tmpEl); entry = DataEntry::New( dictEntry ); entry->SetOffset(0); // just to avoid further missprinting if ( header ) { // NULL when we Build Up (ex nihilo) a DICOMDIR // or when we add the META elems val = header->GetEntryString(tmpGr, tmpEl); } else { val = GDCM_UNFOUND; } if ( val == GDCM_UNFOUND) { if ( tmpGr == 0x0004 ) // never present in File ! { switch (tmpEl) { case 0x1130: // File-set ID // force to the *end* File Name val = Util::GetName( path ); break; case 0x1500: // Only used for image if ( header->GetFileName().substr(0, path.length()) != path ) { gdcmWarningMacro( "The base path of file name is incorrect"); val = header->GetFileName(); } else { val = &(header->GetFileName().c_str()[path.length()+1]); } break; case 0x1510: // Referenced SOP Class UID in File referencedVal = header->GetEntryString(0x0008, 0x0016); // FIXME : probabely something to check val = referencedVal; break; case 0x1511: // Referenced SOP Instance UID in File referencedVal = header->GetEntryString(0x0008, 0x0018); // FIXME : probabely something to check val = referencedVal; break; case 0x1512: // Referenced Transfer Syntax UID in File referencedVal = header->GetEntryString(0x0002, 0x0010); // FIXME : probabely something to check val = referencedVal; break; default : val = it->Value; } } } else { if ( header->GetEntryLength(tmpGr,tmpEl) == 0 ) val = it->Value; } /* FIX later the pb of creating the 'Implementation Version Name'! if (val == GDCM_UNFOUND) val = ""; if ( tmpGr == 0x0002 && tmpEl == 0x0013) { // 'Implementation Version Name' std::string val = "GDCM "; val += Util::GetVersion(); } */ entry->SetString( val ); // troubles expected when vr=SQ ... if ( type == GDCM_DICOMDIR_META ) // fusible : should never print ! { gdcmDebugMacro("GDCM_DICOMDIR_META ?!? should never print that"); } si->AddEntry(entry); entry->Delete(); } }

void gdcm::DicomDir::SetElements (  std::string const &  path, VectDocument const &  list )  [private]

for each Header of the chained list, add/update the Patient/Study/Serie/Image info Parameters: path  path of the root directory list  chained list of Headers Definition at line 920 of file gdcmDicomDir.cxx. References gdcm::ElementSet::ClearEntry(), ClearPatient(), GDCM_DICOMDIR_IMAGE, GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_SERIE, GDCM_DICOMDIR_STUDY, and SetElement(). Referenced by CreateDicomDirChainedList(). { ClearEntry(); ClearPatient(); std::string patPrevName = "", patPrevID = ""; std::string studPrevInstanceUID = "", studPrevID = ""; std::string serPrevInstanceUID = "", serPrevID = ""; std::string patCurName, patCurID; std::string studCurInstanceUID, studCurID; std::string serCurInstanceUID, serCurID; bool first = true; for( VectDocument::const_iterator it = list.begin(); it != list.end(); ++it ) { // get the current file characteristics patCurName = (*it)->GetEntryString(0x0010,0x0010); patCurID = (*it)->GetEntryString(0x0010,0x0011); studCurInstanceUID = (*it)->GetEntryString(0x0020,0x000d); studCurID = (*it)->GetEntryString(0x0020,0x0010); serCurInstanceUID = (*it)->GetEntryString(0x0020,0x000e); serCurID = (*it)->GetEntryString(0x0020,0x0011); 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 || first ) { SetElement(path, GDCM_DICOMDIR_STUDY, *it); first = true; } // if new Serie, deal with 'SERIE' Elements if ( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID || first ) { SetElement(path, GDCM_DICOMDIR_SERIE, *it); } // Always Deal with 'IMAGE' Elements SetElement(path, GDCM_DICOMDIR_IMAGE, *it); patPrevName = patCurName; patPrevID = patCurID; studPrevInstanceUID = studCurInstanceUID; studPrevID = studCurID; serPrevInstanceUID = serCurInstanceUID; serPrevID = serCurID; first = false; } }

void gdcm::DicomDir::SetEndMethod (  void(*)(void *)  method, void *  arg, void(*)(void *)  argDelete )

void gdcm::DicomDir::SetEndMethod (  DicomDir::Method *  method, void *  arg = NULL )

Definition at line 384 of file gdcmDicomDir.cxx. Referenced by ~DicomDir(). { SetEndMethod(method,arg,NULL); }

void gdcm::DicomDir::SetEndMethodArgDelete (  DicomDir::Method *  method  )

Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed. Parameters: method  Method to call to delete the argument Definition at line 480 of file gdcmDicomDir.cxx. References EndMethodArgDelete. { EndMethodArgDelete = method; }

bool gdcm::DocEntrySet::SetEntryBinArea (  uint8_t *  content, int  lgth, DataEntry *  entry )  [inherited]

Accesses an existing DataEntry (i.e. a Dicom Element) and modifies it's content with the given value. Parameters: content  new value (void* -> uint8_t*) to substitute with entry  Entry to be modified lgth  new value length Definition at line 229 of file gdcmDocEntrySet.cxx. References gdcm::DataEntry::SetBinArea(), and gdcm::DocEntry::SetLength(). { if (entry) { entry->SetLength(lgth); entry->SetBinArea(content); return true; } return false; }

bool gdcm::DocEntrySet::SetEntryBinArea (  uint8_t *  content, int  lgth, uint16_t  group, uint16_t  elem )  [inherited]

Accesses an existing DocEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value. Parameters: content  new value (void* -> uint8_t*) to substitute with lgth  new value length group  group number of the Dicom Element to modify elem  element number of the Dicom Element to modify Definition at line 192 of file gdcmDocEntrySet.cxx. References gdcmWarningMacro, and gdcm::DocEntrySet::GetDataEntry(). Referenced by gdcm::DocEntrySet::InsertEntryBinArea(), and gdcm::FileHelper::SetEntryBinArea(). { DataEntry *entry = GetDataEntry(group, elem); if (!entry ) { gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << "," << elem << " element (try promotion first)."); return false; } return SetEntryBinArea(content,lgth,entry); }

bool gdcm::DocEntrySet::SetEntryString (  std::string const &  content, DataEntry *  entry )  [inherited]

Accesses an existing DocEntry (i.e. a Dicom Element) and modifies it's content with the given value. Parameters: content  new value (string) to substitute with entry  Entry to be modified Definition at line 212 of file gdcmDocEntrySet.cxx. References gdcm::DataEntry::SetString(). { if (entry) { entry->SetString(content); return true; } return false; }

bool gdcm::DocEntrySet::SetEntryString (  std::string const &  content, uint16_t  group, uint16_t  elem )  [inherited]

Accesses an existing DocEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value. Parameters: content  new value (string) to substitute with group  group number of the Dicom Element to modify elem  element number of the Dicom Element to modify Definition at line 170 of file gdcmDocEntrySet.cxx. References gdcmWarningMacro, and gdcm::DocEntrySet::GetDataEntry(). Referenced by gdcm::File::AnonymizeFile(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::DocEntrySet::InsertEntryString(), and gdcm::FileHelper::SetEntryString(). { DataEntry *entry = GetDataEntry(group, elem); if (!entry ) { gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << "," << elem << " element (try promotion first)."); return false; } return SetEntryString(content,entry); }

virtual void gdcm::DicomDir::SetFileName (  std::string const &  fileName  )  [inline, virtual]

Accessor to Filename. Reimplemented from gdcm::Document. Definition at line 69 of file gdcmDicomDir.h. Referenced by DoTheLoadingJob(). { ParseDir = false; if (Filename != fileName) Filename = fileName, IsDocumentModified = true;}

void gdcm::Document::SetLoadMode (  int  mode  )  [inline, inherited]

Sets the LoadMode as a boolean string. LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ ... (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 ! Parameters: mode  Load mode to be used Definition at line 103 of file gdcmDocument.h. Referenced by gdcm::SerieHelper::AddFileName(), CreateDicomDirChainedList(), and gdcm::FileHelper::SetLoadMode(). { if (LoadMode != mode) LoadMode=mode, IsDocumentModified = true; }

void gdcm::Base::SetPrintLevel (  int  level  )  [inline, inherited]

Sets the print level for the Dicom Header Elements. Note: 0 for Light Print; 1 for 'medium' Print, 2 for Heavy Print Definition at line 47 of file gdcmBase.h. Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), and Print(). { PrintLevel = level; }

void gdcm::DicomDir::SetProgressMethod (  void(*)(void *)  method, void *  arg, void(*)(void *)  argDelete )

void gdcm::DicomDir::SetProgressMethod (  DicomDir::Method *  method, void *  arg = NULL )

Definition at line 379 of file gdcmDicomDir.cxx. Referenced by ~DicomDir(). { SetProgressMethod(method,arg,NULL); }

void gdcm::DicomDir::SetProgressMethodArgDelete (  DicomDir::Method *  method  )

Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed. Parameters: method  Method to call to delete the argument Definition at line 469 of file gdcmDicomDir.cxx. References ProgressMethodArgDelete. { ProgressMethodArgDelete = method; }

bool gdcm::Document::SetShaDict (  DictKey const &  dictName  )  [inherited]

Set the shadow dictionary used. Parameters: dictName  name of the dictionary to use in shadow Definition at line 327 of file gdcmDocument.cxx. References gdcm::DictSet::GetDict(), gdcm::Global::GetDicts(), and gdcm::Document::RefShaDict. { RefShaDict = Global::GetDicts()->GetDict(dictName); return !RefShaDict; }

bool gdcm::Document::SetShaDict (  Dict *  dict  )  [inherited]

Set the shadow dictionary used. Parameters: dict  dictionary to use in shadow Definition at line 317 of file gdcmDocument.cxx. References gdcm::Document::RefShaDict. { RefShaDict = dict; return !RefShaDict; }

void gdcm::DicomDir::SetStartMethod (  void(*)(void *)  method, void *  arg, void(*)(void *)  argDelete )

void gdcm::DicomDir::SetStartMethod (  DicomDir::Method *  method, void *  arg = NULL )

Definition at line 374 of file gdcmDicomDir.cxx. Referenced by ~DicomDir(). { SetStartMethod(method,arg,NULL); }

void gdcm::DicomDir::SetStartMethodArgDelete (  DicomDir::Method *  method  )

Set the method to delete the argument The argument is destroyed when the method is changed or when the class is destroyed. Parameters: method  Method to call to delete the argument Definition at line 458 of file gdcmDicomDir.cxx. References StartMethodArgDelete. { StartMethodArgDelete = method; }

void gdcm::Document::SkipBytes (  uint32_t  nBytes  )  [protected, inherited]

skips bytes inside the source file Returns: Definition at line 947 of file gdcmDocument.cxx. References gdcm::Document::Fp. Referenced by gdcm::File::ComputeJPEGFragmentInfo(), gdcm::File::ComputeRLEInfo(), gdcm::Document::FindDocEntryLengthOBOrOW(), and gdcm::Document::SkipDocEntry(). { //FIXME don't dump the returned value Fp->seekg((long)nBytes, std::ios::cur); }

void gdcm::RefCounter::Unregister (   )  [inline, inherited]

Unregister the object. Remarks: It decrements the reference counting Definition at line 49 of file gdcmRefCounter.h. Referenced by gdcm::SeqEntry::ClearSQItem(), gdcm::DocEntrySet::GetDictEntry(), gdcm::DocEntrySet::NewDataEntry(), gdcm::DocEntrySet::NewSeqEntry(), gdcm::Document::ReadNextDocEntry(), gdcm::SQItem::RemoveEntry(), gdcm::ElementSet::RemoveEntry(), gdcm::SeqEntry::SetDelimitationItem(), gdcm::DocEntry::~DocEntry(), and gdcm::FileHelper::~FileHelper(). { RefCount--; if(RefCount<=0) delete this; }

bool gdcm::DicomDir::Write (  std::string const &  fileName  )

writes on disc a DICOMDIR \ warning does NOT add the missing elements in the header : it's up to the user doing it ! Parameters: fileName  file to be written to Returns: false only when fail to open Definition at line 493 of file gdcmDicomDir.cxx. References gdcm::binary_write(), gdcm::ExplicitVR, gdcmWarningMacro, GetMeta(), Patients, and gdcm::DicomDirMeta::WriteContent(). { int i; uint16_t sq[6] = { 0x0004, 0x1220, 0x5153, 0x0000, 0xffff, 0xffff }; uint16_t sqt[4]= { 0xfffe, 0xe0dd, 0xffff, 0xffff }; std::ofstream *fp = new std::ofstream(fileName.c_str(), std::ios::out | std::ios::binary); if ( !fp ) { gdcmWarningMacro("Failed to open(write) File: " << fileName.c_str()); return false; } char filePreamble[128]; memset(filePreamble, 0, 128); fp->write(filePreamble, 128); binary_write( *fp, "DICM"); DicomDirMeta *ptrMeta = GetMeta(); ptrMeta->WriteContent(fp, ExplicitVR); // force writing 0004|1220 [SQ ], that CANNOT exist within DicomDirMeta for(i=0;i<6;++i) { binary_write(*fp, sq[i]); } for(ListDicomDirPatient::iterator cc = Patients.begin(); cc != Patients.end(); ++cc ) { (*cc)->WriteContent( fp, ExplicitVR ); } // force writing Sequence Delimitation Item for(i=0;i<4;++i) { binary_write(*fp, sqt[i]); // fffe e0dd ffff ffff } fp->close(); delete fp; return true; }

void gdcm::Document::WriteContent (  std::ofstream *  fp, FileType  filetype )  [virtual, inherited]

Writes in a file all the Entries (Dicom Elements). Parameters: fp  file pointer on an already open file (actually: Output File Stream) filetype  Type of the File to be written (ACR-NEMA, ExplicitVR, ImplicitVR) Reimplemented from gdcm::ElementSet. Definition at line 675 of file gdcmDocument.cxx. References gdcm::ExplicitVR, gdcm::ImplicitVR, gdcm::JPEG, and gdcm::ElementSet::WriteContent(). Referenced by gdcm::File::Write(). { // Skip if user wants to write an ACR-NEMA file if ( filetype == ImplicitVR || filetype == ExplicitVR || filetype == JPEG ) { // writing Dicom File Preamble char filePreamble[128]; memset(filePreamble, 0, 128); fp->write(filePreamble, 128); fp->write("DICM", 4); } /* * \todo rewrite later, if really usefull * - 'Group Length' element is optional in DICOM * - but un-updated odd groups lengthes can causes pb * (xmedcon breaker) * * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) ) * UpdateGroupLength(false,filetype); * if ( filetype == ACR) * UpdateGroupLength(true,ACR); * * --> Computing group length for groups with embeded Sequences * --> was too much tricky / we were [in a hurry / too lazy] * --> We don't write the element 0x0000 (group length) */ ElementSet::WriteContent(fp, filetype); // This one is recursive }

---

Member Data Documentation

bool gdcm::DicomDir::Abort [private]

value of the ??? for any progress bar Definition at line 198 of file gdcmDicomDir.h. Referenced by CallStartMethod(), CreateDicomDirChainedList(), DoTheLoadingJob(), and Initialize().

void* gdcm::DicomDir::EndArg [private]

pointer to the ??? for any progress bar Definition at line 194 of file gdcmDicomDir.h. Referenced by CallEndMethod(), and Initialize().

Method* gdcm::DicomDir::EndMethod [private]

pointer to the termination method for any progress bar Definition at line 182 of file gdcmDicomDir.h. Referenced by CallEndMethod(), and Initialize().

Method* gdcm::DicomDir::EndMethodArgDelete [private]

pointer to the ??? method for any progress bar Definition at line 188 of file gdcmDicomDir.h. Referenced by Initialize(), and SetEndMethodArgDelete().

std::string gdcm::Document::Filename [protected, inherited]

Refering underlying filename. Definition at line 121 of file gdcmDocument.h. Referenced by gdcm::File::AnonymizeNoLoad(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::Document::Load(), and gdcm::Document::OpenFile().

FileType gdcm::Document::Filetype [protected, inherited]

ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown. Definition at line 147 of file gdcmDocument.h. Referenced by gdcm::Document::CheckSwap(), gdcm::Document::Document(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::Document::FindDocEntryVR(), gdcm::Document::GetFileType(), gdcm::Document::HandleOutOfGroup0002(), gdcm::Document::Initialize(), gdcm::Document::IsParsable(), IsReadable(), and gdcm::Document::ReadNextDocEntry().

std::ifstream* gdcm::Document::Fp [protected, inherited]

File Pointer, opened during Document parsing. Definition at line 144 of file gdcmDocument.h. Referenced by gdcm::Document::Backtrack(), gdcm::Document::CheckSwap(), gdcm::Document::CloseFile(), gdcm::File::ComputeJPEGFragmentInfo(), gdcm::File::ComputeRLEInfo(), gdcm::Document::Document(), gdcm::Document::DoTheLoadingDocumentJob(), gdcm::File::DoTheLoadingJob(), DoTheLoadingJob(), gdcm::Document::FindDocEntryLengthOBOrOW(), gdcm::Document::FindDocEntryVR(), gdcm::Document::IsDocEntryAnInteger(), gdcm::Document::LoadDocEntry(), gdcm::Document::LoadDocEntrySafe(), gdcm::Document::LoadEntryBinArea(), gdcm::Document::OpenFile(), gdcm::Document::ParseDES(), gdcm::Document::ParseSQ(), gdcm::File::ReadEncapsulatedBasicOffsetTable(), gdcm::Document::ReadInt16(), gdcm::Document::ReadInt32(), gdcm::Document::ReadNextDocEntry(), gdcm::File::ReadTag(), gdcm::File::ReadTagLength(), gdcm::Document::SkipBytes(), gdcm::Document::SkipToNextDocEntry(), and gdcm::Document::SwitchByteSwapCode().

bool gdcm::Document::Group0002Parsed [protected, inherited]

whether we already parsed group 0002 (Meta Elements) Definition at line 138 of file gdcmDocument.h. Referenced by gdcm::Document::Document(), gdcm::Document::DoTheLoadingDocumentJob(), and gdcm::Document::HandleOutOfGroup0002().

bool gdcm::Document::HasDCMPreamble [protected, inherited]

whether file has a DCM Preamble Definition at line 141 of file gdcmDocument.h. Referenced by gdcm::Document::OpenFile(), and gdcm::Document::ReadNextDocEntry().

const unsigned int gdcm::Document::HEADER_LENGTH_TO_READ [static, protected, inherited]

After opening the file, we read HEADER_LENGTH_TO_READ bytes. Definition at line 150 of file gdcmDocument.h.

bool gdcm::Document::IsDocumentAlreadyLoaded [protected, inherited]

Whether the gdcm::Document is already parsed/loaded : False from the creation of the gdcm::Document untill gdcm::Document:Load(). Definition at line 170 of file gdcmDocument.h. Referenced by gdcm::Document::Document(), and gdcm::Document::DoTheLoadingDocumentJob().

bool gdcm::Document::IsDocumentModified [protected, inherited]

Whether the gdcm::Document was modified since the last Load(). Definition at line 173 of file gdcmDocument.h. Referenced by gdcm::Document::Document(), and gdcm::Document::DoTheLoadingDocumentJob().

ListDicomDirPatient::iterator gdcm::DicomDir::ItPatient [private]

Definition at line 175 of file gdcmDicomDir.h. Referenced by GetFirstPatient(), and GetNextPatient().

int gdcm::Document::LoadMode [protected, inherited]

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. Definition at line 165 of file gdcmDocument.h. Referenced by CreateDicomDirChainedList(), gdcm::Document::Document(), and gdcm::Document::ParseDES().

const unsigned int gdcm::Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff [static, protected, inherited]

Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE are NOT loaded. Definition at line 153 of file gdcmDocument.h. Referenced by gdcm::Document::Document().

DicomDirMeta* gdcm::DicomDir::MetaElems [private]

Pointer on *the* DicomDirObject 'DicomDirMeta Elements'. Definition at line 171 of file gdcmDicomDir.h. Referenced by Initialize(), IsReadable(), NewMeta(), Print(), SetElement(), and ~DicomDir().

bool gdcm::DicomDir::ParseDir [private]

Definition at line 199 of file gdcmDicomDir.h. Referenced by DicomDir(), DoTheLoadingJob(), and Load().

ListDicomDirPatient gdcm::DicomDir::Patients [private]

Chained list of DicomDirPatient (to be exploited hierarchicaly). Definition at line 174 of file gdcmDicomDir.h. Referenced by AddImageToEnd(), AddPatientToEnd(), AddSerieToEnd(), AddStudyToEnd(), AddVisitToEnd(), Anonymize(), ClearPatient(), GetFirstPatient(), GetNextPatient(), IsReadable(), Print(), and Write().

DocEntry* gdcm::DocEntrySet::PreviousDocEntry [protected, inherited]

To be able to backtrack (Private Sequence, Implicit VR related pb). Definition at line 124 of file gdcmDocEntrySet.h. Referenced by gdcm::Document::Backtrack(), gdcm::DocEntrySet::DocEntrySet(), and gdcm::Document::ParseDES().

int gdcm::Base::PrintLevel [protected, inherited]

Amount of printed details for each Dicom Entries : 0 : stands for the least detail level. Definition at line 55 of file gdcmBase.h. Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), gdcm::DocEntry::Print(), gdcm::DictEntry::Print(), gdcm::DicomDirStudy::Print(), gdcm::DicomDirSerie::Print(), gdcm::DicomDirPatient::Print(), gdcm::DicomDirMeta::Print(), Print(), and gdcm::DataEntry::Print().

float gdcm::DicomDir::Progress [private]

value of the ??? for any progress bar Definition at line 196 of file gdcmDicomDir.h. Referenced by CallEndMethod(), CallStartMethod(), CreateDicomDirChainedList(), DoTheLoadingJob(), and Initialize().

void* gdcm::DicomDir::ProgressArg [private]

pointer to the ??? for any progress bar Definition at line 192 of file gdcmDicomDir.h. Referenced by CallProgressMethod(), and Initialize().

Method* gdcm::DicomDir::ProgressMethod [private]

pointer to the incrementation method for any progress bar Definition at line 180 of file gdcmDicomDir.h. Referenced by CallProgressMethod(), and Initialize().

Method* gdcm::DicomDir::ProgressMethodArgDelete [private]

pointer to the ??? method for any progress bar Definition at line 186 of file gdcmDicomDir.h. Referenced by Initialize(), and SetProgressMethodArgDelete().

void* gdcm::DicomDir::StartArg [private]

pointer to the ??? for any progress bar Definition at line 190 of file gdcmDicomDir.h. Referenced by CallStartMethod(), and Initialize().

Method* gdcm::DicomDir::StartMethod [private]

pointer to the initialisation method for any progress bar Definition at line 178 of file gdcmDicomDir.h. Referenced by CallStartMethod(), and Initialize().

Method* gdcm::DicomDir::StartMethodArgDelete [private]

pointer to the ??? method for any progress bar Definition at line 184 of file gdcmDicomDir.h. Referenced by Initialize(), and SetStartMethodArgDelete().

int gdcm::Document::SwapCode [protected, inherited]

Swap code gives an information on the byte order of a supposed to be an int32, as it's read on disc (depending on the image Transfer Syntax *and* on the processor endianess) as opposed as it should in memory to be dealt as an int32. For instance : a 'Little Endian' image, read with a little endian processor will have a SwapCode= 1234 (the order is OK; nothing to do) a 'Little Endian' image, read with a big endian procesor will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be swapped) note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and the well known 'Bad Big Endian' and 'Bad Little Endian' codes. Definition at line 135 of file gdcmDocument.h. Referenced by gdcm::Document::CheckSwap(), gdcm::Document::Document(), gdcm::Document::SwapDouble(), gdcm::Document::SwapLong(), gdcm::Document::SwapShort(), and gdcm::Document::SwitchByteSwapCode().

ListElements gdcm::Document::UserAnonymizeList [protected, inherited]

User supplied list of elements to Anonymize. Definition at line 156 of file gdcmDocument.h. Referenced by gdcm::File::AddAnonymizeElement(), gdcm::File::AnonymizeFile(), and gdcm::File::AnonymizeNoLoad().

ListElements gdcm::Document::UserForceLoadList [protected, inherited]

User supplied list of elements to force Load. Definition at line 159 of file gdcmDocument.h. Referenced by gdcm::Document::AddForceLoadElement(), and gdcm::Document::DoTheLoadingDocumentJob().

---

The documentation for this class was generated from the following files:

• gdcmDicomDir.h
• gdcmDicomDir.cxx

---