gdcmHeader Class Reference

#include <gdcmHeader.h>

Inheritance diagram for gdcmHeader:

List of all members.

Public Member Functions
	gdcmHeader (bool exception_on_error=false)
	Constructor.
	gdcmHeader (const char *filename, bool exception_on_error=false, bool enable_sequences=false, bool skip_shadow=false)
	Constructor.
virtual	~gdcmHeader ()
	Canonical destructor.
virtual bool	IsReadable (void)
	This predicate, based on hopefully reasonable heuristics, decides whether or not the current gdcmParser was properly parsed and contains the mandatory information for being considered as a well formed and usable Dicom/Acr File.
bool	IsJPEGBaseLineProcess1TransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGBaseLineProcess1 one.
bool	IsJPEGExtendedProcess2_4TransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGExtendedProcess2-4 one.
bool	IsJPEGExtendedProcess3_5TransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGExtendeProcess3-5 one.
bool	IsJPEGSpectralSelectionProcess6_8TransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGSpectralSelectionProcess6-8 one.
bool	IsRLELossLessTransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a RLE Lossless one.
bool	IsJPEGLossless (void)
	Determines if Transfer Syntax was already encountered and if it corresponds to a JPEG Lossless one.
bool	IsJPEG2000 (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEG2000 one.
bool	IsDicomV3 (void)
	Predicate for dicom version 3 file.
int	GetXSize (void)
	Retrieve the number of columns of image.
int	GetYSize (void)
	Retrieve the number of lines of image.
int	GetZSize (void)
	Retrieve the number of planes of volume or the number of frames of a multiframe.
int	GetBitsStored (void)
	Retrieve the number of Bits Stored (actually used) (as opposite to number of Bits Allocated).
int	GetBitsAllocated (void)
	Retrieve the number of Bits Allocated (8, 12 -compacted ACR-NEMA files, 16, ...).
int	GetSamplesPerPixel (void)
	Retrieve the number of Samples Per Pixel (1 : gray level, 3 : RGB -1 or 3 Planes-).
int	GetPlanarConfiguration (void)
	Retrieve the Planar Configuration for RGB images (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane).
int	GetPixelSize (void)
	Return the size (in bytes) of a single pixel of data.
std::string	GetPixelType (void)
	Build the Pixel Type of the image. Possible values are: -8U unsigned 8 bit, -8S signed 8 bit, -16U unsigned 16 bit, -16S signed 16 bit, -32U unsigned 32 bit, -32S signed 32 bit, -FD floating double 64 bits (Not kosher DICOM, but so usefull!).
size_t	GetPixelOffset (void)
	Recover the offset (from the beginning of the file) of *image* pixels (not *icone image* pixels, if any !).
size_t	GetPixelAreaLength (void)
	Recover the pixel area length (in Bytes).
bool	HasLUT (void)
	tells us if LUT are used
int	GetLUTNbits (void)
	gets the info from 0028,1101 : Lookup Table Desc-Red else 0
unsigned char *	GetLUTRGBA (void)
	builts Red/Green/Blue/Alpha LUT from Header when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] and (0028,1101),(0028,1102),(0028,1102) -xxx Palette Color Lookup Table Descriptor - are found and (0028,1201),(0028,1202),(0028,1202) -xxx Palette Color Lookup Table Data - are found
std::string	GetTransfertSyntaxName (void)
	gets the info from 0002,0010 : Transfert Syntax and gdcmTS else 1.
virtual std::string	GetEntryByNumber (guint16 group, guint16 element)
	Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag.
virtual std::string	GetEntryVRByNumber (guint16 group, guint16 element)
	Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag..
virtual std::string	GetEntryByName (std::string tagName)
	Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value of a given tag.
virtual std::string	GetEntryVRByName (std::string tagName)
	Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag.
virtual bool	SetEntryByNumber (std::string content, guint16 group, guint16 element)
	Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value.
virtual bool	SetEntryByName (std::string content, std::string tagName)
	Sets the value (string) of the Header Entry (Dicom Element).
virtual bool	SetEntryLengthByNumber (guint32 l, guint16 group, guint16 element)
	Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element) in the PubHeaderEntrySet of this instance through it's (group, element) and modifies it's length with the given value.
virtual void	UpdateShaEntries (void)
	Update the entries with the shadow dictionary. Only non even entries are analyzed.
void	SetImageDataSize (size_t ExpectedSize)
	Sets the Pixel Area size in the Header --> not-for-rats function.
bool	operator< (gdcmHeader &header)
	compares 2 Headers, according to DICOMDIR rules --> not-for-rats function
void	SetPrintLevel (int level)
	Sets the print level for the Dicom Header.
virtual void	Print (std::ostream &os=std::cout)
virtual void	PrintEntry (std::ostream &os=std::cout)
	Prints the Header Entries (Dicom Elements) both from the H Table and the chained list.
virtual void	PrintPubDict (std::ostream &os=std::cout)
	Prints The Dict Entries of THE public Dicom Dictionnry.
virtual void	PrintShaDict (std::ostream &os=std::cout)
	Prints The Dict Entries of THE shadow Dicom Dictionnry.
std::string	GetFileName (void)
gdcmDict *	GetPubDict (void)
	Get the public dictionary used.
gdcmDict *	GetShaDict (void)
	Get the shadow dictionary used.
bool	SetShaDict (gdcmDict *dict)
	Set the shadow dictionary used.
bool	SetShaDict (DictKey dictName)
	Set the shadow dictionary used.
bool	IsImplicitVRLittleEndianTransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a ImplicitVRLittleEndian one.
bool	IsExplicitVRLittleEndianTransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a ExplicitVRLittleEndian one.
bool	IsDeflatedExplicitVRLittleEndianTransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a DeflatedExplicitVRLittleEndian one.
bool	IsExplicitVRBigEndianTransferSyntax (void)
	Determines if the Transfer Syntax was already encountered and if it corresponds to a Explicit VR Big Endian one.
FileType	GetFileType (void)
	returns the File Type (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
TagHeaderEntryHT &	GetEntry (void)
	returns a ref to the Dicom Header H table (multimap) return the Dicom Header H table
ListTag &	GetListEntry (void)
	returns a ref to the Dicom Header chained list return the Dicom Header chained list
FILE *	OpenFile (bool exception_on_error=false) throw (gdcmFileError)
	opens the file
bool	CloseFile (void)
	closes the file
virtual bool	Write (FILE *, FileType)
bool	ReplaceOrCreateByNumber (std::string Value, guint16 Group, guint16 Elem)
	Modifies the value of a given Header Entry (Dicom Element) if it exists; Creates it with the given value if it doesn't.
bool	ReplaceOrCreateByNumber (char *Value, guint16 Group, guint16 Elem)
	Modifies the value of a given Header Entry (Dicom Element) if it exists; Creates it with the given value if it doesn't.
bool	ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem)
	Set a new value if the invoked element exists Seems to be useless !!!
int	GetSwapCode (void)
guint16	GetGrPixel (void)
guint16	GetNumPixel (void)
guint16	SwapShort (guint16)
	Swaps the bytes so they agree with the processor order.
guint32	SwapLong (guint32)
	Swaps back the bytes of 4-byte long integer accordingly to processor order.
guint16	UnswapShort (guint16)
	Unswaps the bytes so they agree with the processor order.
guint32	UnswapLong (guint32)
	Unswaps back the bytes of 4-byte long integer accordingly to processor order.
Protected Member Functions
int	write (std::ostream &)
int	anonymize (std::ostream &)
bool	anonymizeHeader (void)
	anonymize a Header (removes Patient's personal info) (read the code to see which ones ...)
int	CheckIfEntryExistByNumber (guint16 Group, guint16 Elem)
	Checks if a given Dicom Element exists within the H table.
virtual size_t	GetEntryOffsetByNumber (guint16 Group, guint16 Elem)
	Gets (from Header) the offset of a 'non string' element value (LoadElementValues has already be executed).
virtual void *	GetEntryVoidAreaByNumber (guint16 Group, guint16 Elem)
	Gets (from Header) a 'non string' element value (LoadElementValues has already be executed).
virtual void *	LoadEntryVoidArea (guint16 Group, guint16 Element)
	Loads (from disk) the element content when a string is not suitable.
virtual bool	SetEntryVoidAreaByNumber (void *a, guint16 Group, guint16 Elem)
	Sets a 'non string' value to a given Dicom Element.
gdcmHeaderEntry *	GetHeaderEntryByNumber (guint16 group, guint16 element)
	retrieves a Dicom Element (the first one) using (group, element)
gdcmHeaderEntry *	GetHeaderEntryByName (std::string Name)
	Searches within the Header Entries for a Dicom Element of a given tag.
IterHT	GetHeaderEntrySameNumber (guint16 group, guint16 element)
	retrieves the Dicom Elements (all of them) using (group, element)
void	LoadHeaderEntrySafe (gdcmHeaderEntry *)
	Loads the element while preserving the current underlying file position indicator as opposed to to LoadHeaderEntry that modifies it.
void	UpdateGroupLength (bool SkipSequence=false, FileType type=ImplicitVR)
	Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader.
void	WriteEntries (FILE *_fp, FileType type)
	writes on disc according to the requested format (ACR-NEMA, ExplicitVR, ImplicitVR) the image
Protected Attributes
FILE *	fp
FileType	filetype
TagHeaderEntryHT	tagHT
ListTag	listEntries
int	enableSequences
int	printLevel
guint16	GrPixel
guint16	NumPixel
int	countGrPixel
Static Protected Attributes
const unsigned int	HEADER_LENGTH_TO_READ = 256
const unsigned int	MAX_SIZE_LOAD_ELEMENT_VALUE = 4096
const unsigned int	MAX_SIZE_PRINT_ELEMENT_VALUE = 64

---

Constructor & Destructor Documentation

gdcmHeader::gdcmHeader (  bool  exception_on_error = false  )

Constructor. Parameters: exception_on_error  Definition at line 68 of file gdcmHeader.cxx. : gdcmParser(exception_on_error) { }

gdcmHeader::gdcmHeader (  const char *  InFilename, bool  exception_on_error = false, bool  enable_sequences = false, bool  ignore_shadow = false )

Constructor. Parameters: InFilename  exception_on_error  enable_sequences  = true to allow the header to be parsed *inside* the SeQuences, when they have an actual length ignore_shadow  = true if user wants to skip shadow groups during parsing, to save memory space Definition at line 26 of file gdcmHeader.cxx. References GDCM_UNFOUND, gdcmParser::GetEntry(), GetEntryByNumber(), TagKey, and gdcmDictEntry::TranslateToKey(). : gdcmParser(InFilename,exception_on_error,enable_sequences,ignore_shadow) { // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010 // We may encounter the 'RETired' (0x0028, 0x0200) tag // (Image Location") . This Element contains the number of // the group that contains the pixel data (hence the "Pixel Data" // is found by indirection through the "Image Location"). // Inside the group pointed by "Image Location" the searched element // is conventionally the element 0x0010 (when the norm is respected). // When the "Image Location" is absent we default to group 0x7fe0. // This IS the right place for the code std::string ImageLocation = GetEntryByNumber(0x0028, 0x0200); if ( ImageLocation == GDCM_UNFOUND ) { // Image Location GrPixel = 0x7fe0; // default value } else { GrPixel = (guint16) atoi( ImageLocation.c_str() ); } if (GrPixel == 0xe07f) // sometimes Image Location value doesn't follow GrPixel = 0x7fe0; // the supposed processor endianity. // see gdcmData/cr172241.dcm if (GrPixel != 0x7fe0) // This is a kludge for old dirty Philips imager. NumPixel = 0x1010; else NumPixel = 0x0010; TagKey key = gdcmDictEntry::TranslateToKey(GrPixel, NumPixel); countGrPixel = GetEntry().count(key); }

gdcmHeader::~gdcmHeader (  void   )  [virtual]

Canonical destructor. Definition at line 77 of file gdcmHeader.cxx. { }

---

Member Function Documentation

int gdcmHeader::anonymize (  std::ostream &   )  [protected]

bool gdcmHeader::anonymizeHeader (  void   )  [protected]

anonymize a Header (removes Patient's personal info) (read the code to see which ones ...) Parameters: Definition at line 795 of file gdcmHeader.cxx. References GDCM_UNFOUND, GetEntryByNumber(), gdcmParser::GetHeaderEntryByNumber(), gdcmParser::ReplaceIfExistByNumber(), and gdcmParser::ReplaceOrCreateByNumber(). { gdcmHeaderEntry *patientNameHE = GetHeaderEntryByNumber (0x0010, 0x0010); // gdcmHeaderEntry *patientIDHE = GetHeaderEntryByNumber (0x0010, 0x0020); ReplaceIfExistByNumber (" ",0x0010, 0x2154); // Telephone ReplaceIfExistByNumber (" ",0x0010, 0x1040); // Adress ReplaceIfExistByNumber (" ",0x0010, 0x0020); // Patient ID if (patientNameHE) { std::string StudyInstanceUID = GetEntryByNumber (0x0020, 0x000d); if (StudyInstanceUID !=GDCM_UNFOUND) ReplaceOrCreateByNumber(StudyInstanceUID, 0x0010, 0x0010); else ReplaceOrCreateByNumber("anonymised", 0x0010, 0x0010); } // Just for fun :-( // (if any) remove or replace //0008 0012 DA ID Instance Creation Date //0008 0020 DA ID Study Date //0008 0021 DA ID Series Date //0008 0022 DA ID Acquisition Date //0008 0023 DA ID Content Date //0008 0024 DA ID Overlay Date //0008 0025 DA ID Curve Date //0008 002a DT ID Acquisition Datetime //0018 9074 DT ACQ Frame Acquisition Datetime //0018 9151 DT ACQ Frame Reference Datetime //0018 a002 DT ACQ Contribution Date Time //0020 3403 SH REL Modified Image Date (RET) //0032 0032 DA SDY Study Verified Date //0032 0034 DA SDY Study Read Date //0032 1000 DA SDY Scheduled Study Start Date //0032 1010 DA SDY Scheduled Study Stop Date //0032 1040 DA SDY Study Arrival Date //0032 1050 DA SDY Study Completion Date //0038 001a DA VIS Scheduled Admission Date //0038 001c DA VIS Scheduled Discharge Date //0038 0020 DA VIS Admitting Date //0038 0030 DA VIS Discharge Date //0040 0002 DA PRC Scheduled Procedure Step Start Date //0040 0004 DA PRC Scheduled Procedure Step End Date //0040 0244 DA PRC Performed Procedure Step Start Date //0040 0250 DA PRC Performed Procedure Step End Date //0040 2004 DA PRC Issue Date of Imaging Service Request //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time //0040 4011 DT PRC Expected Completion Date and Time //0040 a030 DT PRC Verification Date Time //0040 a032 DT PRC Observation Date Time //0040 a120 DT PRC DateTime //0040 a121 DA PRC Date //0040 a13a DT PRC Referenced Datetime //0070 0082 DA ??? Presentation Creation Date //0100 0420 DT ??? SOP Autorization Date and Time //0400 0105 DT ??? Digital Signature DateTime //2100 0040 DA PJ Creation Date //3006 0008 DA SSET Structure Set Date //3008 0024 DA ??? Treatment Control Point Date //3008 0054 DA ??? First Treatment Date //3008 0056 DA ??? Most Recent Treatment Date //3008 0162 DA ??? Safe Position Exit Date //3008 0166 DA ??? Safe Position Return Date //3008 0250 DA ??? Treatment Date //300a 0006 DA RT RT Plan Date //300a 022c DA RT Air Kerma Rate Reference Date //300e 0004 DA RT Review Date return true; }

int gdcmParser::CheckIfEntryExistByNumber (  guint16  group, guint16  element )  [protected, inherited]

Checks if a given Dicom Element exists within the H table. Parameters: group  Group number of the searched Dicom Element element  Element number of the searched Dicom Element Returns: number of occurences Definition at line 509 of file gdcmParser.cxx. References gdcmParser::tagHT, and gdcmDictEntry::TranslateToKey(). Referenced by gdcmParser::ReplaceOrCreateByNumber(). { std::string key = gdcmDictEntry::TranslateToKey(group, element ); return (tagHT.count(key)); }

bool gdcmParser::CloseFile (  void   )  [inherited]

closes the file Returns: TRUE if the close was successfull Definition at line 365 of file gdcmParser.cxx. References gdcmParser::fp. Referenced by gdcmParser::gdcmParser(), gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { int closed = fclose(fp); fp = (FILE *)0; if (! closed) return false; return true; }

int gdcmHeader::GetBitsAllocated (  void   )

Retrieve the number of Bits Allocated (8, 12 -compacted ACR-NEMA files, 16, ...). Returns: The encountered number of Bits Allocated, 0 by default. 0 means the file is NOT USABLE. The caller has to check it ! Definition at line 336 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmFile::gdcm_read_RLE_file(), and gdcmFile::ReadPixelData(). { std::string StrSize = GetEntryByNumber(0x0028,0x0100); if (StrSize == GDCM_UNFOUND) return 0; // It's supposed to be mandatory // the caller will have to check return atoi(StrSize.c_str()); }

int gdcmHeader::GetBitsStored (  void   )

Retrieve the number of Bits Stored (actually used) (as opposite to number of Bits Allocated). Returns: The encountered number of Bits Stored, 0 by default. 0 means the file is NOT USABLE. The caller has to check it ! Definition at line 321 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmFile::ReadPixelData(). { std::string StrSize = GetEntryByNumber(0x0028,0x0101); if (StrSize == GDCM_UNFOUND) return 0; // It's supposed to be mandatory // the caller will have to check return atoi(StrSize.c_str()); }

TagHeaderEntryHT& gdcmParser::GetEntry (  void   )  [inline, inherited]

returns a ref to the Dicom Header H table (multimap) return the Dicom Header H table Definition at line 80 of file gdcmParser.h. References TagHeaderEntryHT. Referenced by gdcmHeader(), and gdcmFile::WriteBase(). { return tagHT; };

virtual std::string gdcmHeader::GetEntryByName (  std::string  tagName  )  [inline, virtual]

Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value of a given tag. Warning: Don't use any longer : use GetPubEntryByName Parameters: tagName  name of the searched element. Returns: Corresponding element value when it exists, and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. Reimplemented from gdcmParser. Definition at line 90 of file gdcmHeader.h. References gdcmParser::GetEntryByName(). { return(gdcmParser::GetEntryByName(tagName)); }

virtual std::string gdcmHeader::GetEntryByNumber (  guint16  group, guint16  element )  [inline, virtual]

Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag. Parameters: group  Group of the searched tag. element  Element of the searched tag. Returns: Corresponding element value representation when it exists, and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. Reimplemented from gdcmParser. Definition at line 85 of file gdcmHeader.h. References gdcmParser::GetEntryByNumber(). Referenced by anonymizeHeader(), gdcmHeader(), GetBitsAllocated(), GetBitsStored(), gdcmHeaderHelper::GetClassUID(), gdcmFile::GetImageDataIntoVectorRaw(), gdcmHeaderHelper::GetImageNumber(), gdcmHeaderHelper::GetImageOrientationPatient(), gdcmHeaderHelper::GetInstanceUID(), GetLUTNbits(), GetLUTRGBA(), gdcmHeaderHelper::GetModality(), gdcmHeaderHelper::GetNumberOfScalarComponents(), gdcmHeaderHelper::GetNumberOfScalarComponentsRaw(), gdcmHeaderHelper::GetPixelSize(), gdcmHeaderHelper::GetPixelType(), GetPixelType(), GetPlanarConfiguration(), gdcmHeaderHelper::GetRescaleIntercept(), gdcmHeaderHelper::GetRescaleSlope(), GetSamplesPerPixel(), gdcmHeaderHelper::GetSeriesUID(), gdcmHeaderHelper::GetStudyUID(), GetTransfertSyntaxName(), gdcmHeaderHelper::GetXOrigin(), GetXSize(), gdcmHeaderHelper::GetXSpacing(), gdcmHeaderHelper::GetYOrigin(), GetYSize(), gdcmHeaderHelper::GetYSpacing(), gdcmHeaderHelper::GetZOrigin(), GetZSize(), gdcmHeaderHelper::GetZSpacing(), IsReadable(), operator<(), gdcmFile::ParsePixelData(), gdcmFile::ReadPixelData(), gdcmDicomDir::SetElement(), gdcmFile::SetPixelDataSizeFromHeader(), and gdcmFile::WriteBase(). { return(gdcmParser::GetEntryByNumber(group,element)); }

size_t gdcmParser::GetEntryOffsetByNumber (  guint16  Group, guint16  Elem )  [protected, virtual, inherited]

Gets (from Header) the offset of a 'non string' element value (LoadElementValues has already be executed). Parameters: Group  group of the Entry Elem  element of the Entry Returns: File Offset of the Element Value Definition at line 695 of file gdcmParser.cxx. References dbg, gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetOffset(), and gdcmDebug::Verbose(). { gdcmHeaderEntry* Entry = GetHeaderEntryByNumber(Group, Elem); if (!Entry) { dbg.Verbose(1, "gdcmParser::GetHeaderEntryByNumber", "failed to Locate gdcmHeaderEntry"); return (size_t)0; } return Entry->GetOffset(); }

void * gdcmParser::GetEntryVoidAreaByNumber (  guint16  Group, guint16  Elem )  [protected, virtual, inherited]

Gets (from Header) a 'non string' element value (LoadElementValues has already be executed). Parameters: Group  group of the Entry Elem  element of the Entry Returns: Pointer to the 'non string' area Definition at line 715 of file gdcmParser.cxx. References dbg, gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetVoidArea(), and gdcmDebug::Verbose(). Referenced by GetLUTRGBA(). { gdcmHeaderEntry* Entry = GetHeaderEntryByNumber(Group, Elem); if (!Entry) { dbg.Verbose(1, "gdcmParser::GetHeaderEntryByNumber", "failed to Locate gdcmHeaderEntry"); return (NULL); } return Entry->GetVoidArea(); }

virtual std::string gdcmHeader::GetEntryVRByName (  std::string  tagName  )  [inline, virtual]

Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag. Obtaining the VR (Value Representation) might be needed by caller to convert the string typed content to caller's native type (think of C++ vs Python). The VR is actually of a higher level of semantics than just the native C++ type. Parameters: tagName  name of the searched element. Returns: Corresponding element value representation when it exists, and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. Reimplemented from gdcmParser. Definition at line 92 of file gdcmHeader.h. References gdcmParser::GetEntryVRByName(). { return(gdcmParser::GetEntryVRByName(tagName)); }

virtual std::string gdcmHeader::GetEntryVRByNumber (  guint16  group, guint16  element )  [inline, virtual]

Searches within Header Entries (Dicom Elements) parsed with the public and private dictionaries for the element value representation of a given tag.. Obtaining the VR (Value Representation) might be needed by caller to convert the string typed content to caller's native type (think of C++ vs Python). The VR is actually of a higher level of semantics than just the native C++ type. Parameters: group  Group of the searched tag. element  Element of the searched tag. Returns: Corresponding element value representation when it exists, and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. Reimplemented from gdcmParser. Definition at line 87 of file gdcmHeader.h. References gdcmParser::GetEntryVRByNumber(). { return(gdcmParser::GetEntryVRByNumber(group,element)); }

std::string gdcmParser::GetFileName (  void   )  [inline, inherited]

Definition at line 58 of file gdcmParser.h. Referenced by gdcmDicomDir::GetPath(), and gdcmDicomDir::SetElement(). {return filename;}

FileType gdcmParser::GetFileType (  void   )  [inherited]

returns the File Type (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown) Returns: the FileType code Definition at line 315 of file gdcmParser.cxx. References gdcmParser::filetype, and FileType. Referenced by gdcmFile::WriteBase(). { return(filetype); }

guint16 gdcmParser::GetGrPixel (  void   )  [inline, inherited]

Definition at line 102 of file gdcmParser.h. Referenced by gdcmFile::WriteBase(). {return GrPixel;}

gdcmHeaderEntry * gdcmParser::GetHeaderEntryByName (  std::string  tagName  )  [protected, inherited]

Searches within the Header Entries for a Dicom Element of a given tag. Parameters: tagName  name of the searched Dicom Element. Returns: Corresponding Dicom Element when it exists, and NULL otherwise. Definition at line 829 of file gdcmParser.cxx. References gdcmDict::GetDictEntryByName(), gdcmDictEntry::GetElement(), gdcmDictEntry::GetGroup(), gdcmParser::GetHeaderEntryByNumber(), and gdcmParser::RefPubDict. { gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); if( dictEntry == NULL) return NULL; return(GetHeaderEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement())); }

gdcmHeaderEntry * gdcmParser::GetHeaderEntryByNumber (  guint16  group, guint16  element )  [protected, inherited]

retrieves a Dicom Element (the first one) using (group, element) Warning: (group, element) IS NOT an identifier inside the Dicom Header if you think it's NOT UNIQUE, check the count number and use iterators to retrieve ALL the Dicoms Elements within a given couple (group, element) Parameters: group  Group number of the searched Dicom Element element  Element number of the searched Dicom Element Returns: Definition at line 848 of file gdcmParser.cxx. References gdcmParser::tagHT, TagKey, and gdcmDictEntry::TranslateToKey(). Referenced by anonymizeHeader(), gdcmParser::GetEntryOffsetByNumber(), gdcmParser::GetEntryVoidAreaByNumber(), gdcmParser::GetEntryVRByName(), gdcmParser::GetEntryVRByNumber(), gdcmParser::GetHeaderEntryByName(), HasLUT(), gdcmParser::IsDeflatedExplicitVRLittleEndianTransferSyntax(), IsDicomV3(), gdcmParser::IsExplicitVRBigEndianTransferSyntax(), gdcmParser::IsExplicitVRLittleEndianTransferSyntax(), gdcmParser::IsImplicitVRLittleEndianTransferSyntax(), IsJPEG2000(), IsJPEGBaseLineProcess1TransferSyntax(), IsJPEGExtendedProcess2_4TransferSyntax(), IsJPEGExtendedProcess3_5TransferSyntax(), IsJPEGLossless(), IsJPEGSpectralSelectionProcess6_8TransferSyntax(), IsReadable(), IsRLELossLessTransferSyntax(), gdcmParser::LoadEntryVoidArea(), SetImageDataSize(), and gdcmParser::UpdateGroupLength(). { TagKey key = gdcmDictEntry::TranslateToKey(group, element); if ( ! tagHT.count(key)) return NULL; return tagHT.find(key)->second; }

IterHT gdcmParser::GetHeaderEntrySameNumber (  guint16  group, guint16  element )  [protected, inherited]

retrieves the Dicom Elements (all of them) using (group, element) Parameters: group  Group number of the searched Dicom Element. element  Element number of the searched Dicom Element. Returns: a range (i.e.pair<,>) containing all elements whose key is group|element) Definition at line 864 of file gdcmParser.cxx. References IterHT, gdcmParser::tagHT, TagKey, and gdcmDictEntry::TranslateToKey(). Referenced by GetPixelAreaLength(), and GetPixelOffset(). { TagKey key = gdcmDictEntry::TranslateToKey(group, element); return (tagHT.equal_range(key)); }

ListTag& gdcmParser::GetListEntry (  void   )  [inline, inherited]

returns a ref to the Dicom Header chained list return the Dicom Header chained list Definition at line 87 of file gdcmParser.h. References ListTag. Referenced by gdcmDicomDir::CreateDicomDir(), gdcmDicomDir::gdcmDicomDir(), and gdcmParser::LoadHeaderEntries(). { return listEntries; };

int gdcmHeader::GetLUTNbits (  void   )

gets the info from 0028,1101 : Lookup Table Desc-Red else 0 Returns: Lookup Table number of Bits , 0 by default when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] @ return bit number of each LUT item Definition at line 538 of file gdcmHeader.cxx. References GDCM_UNFOUND, GetEntryByNumber(), and Tokenize(). { std::vector<std::string> tokens; //int LutLength; //int LutDepth; int LutNbits; //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red = Lookup Table Desc-Blue // Consistency already checked in GetLUTLength std::string LutDescription = GetEntryByNumber(0x0028,0x1101); if (LutDescription == GDCM_UNFOUND) return 0; tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize (LutDescription, tokens, "\\"); //LutLength=atoi(tokens[0].c_str()); //LutDepth=atoi(tokens[1].c_str()); LutNbits=atoi(tokens[2].c_str()); tokens.clear(); return LutNbits; }

unsigned char * gdcmHeader::GetLUTRGBA (  void   )

builts Red/Green/Blue/Alpha LUT from Header when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] and (0028,1101),(0028,1102),(0028,1102) -xxx Palette Color Lookup Table Descriptor - are found and (0028,1201),(0028,1202),(0028,1202) -xxx Palette Color Lookup Table Data - are found Warning: does NOT deal with : 0028 1100 Gray Lookup Table Descriptor (Retired) 0028 1221 Segmented Red Palette Color Lookup Table Data 0028 1222 Segmented Green Palette Color Lookup Table Data 0028 1223 Segmented Blue Palette Color Lookup Table Data no known Dicom reader deals with them :-( Returns: a RGBA Lookup Table Definition at line 573 of file gdcmHeader.cxx. References GDCM_UNFOUND, GetEntryByNumber(), gdcmParser::GetEntryVoidAreaByNumber(), and Tokenize(). Referenced by gdcmFile::GetImageDataIntoVector(). { // Not so easy : see // http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables // if Photometric Interpretation # PALETTE COLOR, no LUT to be done if (GetEntryByNumber(0x0028,0x0004) != "PALETTE COLOR ") { return NULL; } int lengthR, debR, nbitsR; int lengthG, debG, nbitsG; int lengthB, debB, nbitsB; // Get info from Lut Descriptors // (the 3 LUT descriptors may be different) std::string LutDescriptionR = GetEntryByNumber(0x0028,0x1101); if (LutDescriptionR == GDCM_UNFOUND) return NULL; std::string LutDescriptionG = GetEntryByNumber(0x0028,0x1102); if (LutDescriptionG == GDCM_UNFOUND) return NULL; std::string LutDescriptionB = GetEntryByNumber(0x0028,0x1103); if (LutDescriptionB == GDCM_UNFOUND) return NULL; std::vector<std::string> tokens; tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize (LutDescriptionR, tokens, "\\"); lengthR=atoi(tokens[0].c_str()); // Red LUT length in Bytes debR =atoi(tokens[1].c_str()); // subscript of the first Lut Value nbitsR =atoi(tokens[2].c_str()); // Lut item size (in Bits) tokens.clear(); tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize (LutDescriptionG, tokens, "\\"); lengthG=atoi(tokens[0].c_str()); // Green LUT length in Bytes debG =atoi(tokens[1].c_str()); // subscript of the first Lut Value nbitsG =atoi(tokens[2].c_str()); // Lut item size (in Bits) tokens.clear(); tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize (LutDescriptionB, tokens, "\\"); lengthB=atoi(tokens[0].c_str()); // Blue LUT length in Bytes debB =atoi(tokens[1].c_str()); // subscript of the first Lut Value nbitsB =atoi(tokens[2].c_str()); // Lut item size (in Bits) tokens.clear(); // Load LUTs into memory, (as they were stored on disk) unsigned char *lutR = (unsigned char *) GetEntryVoidAreaByNumber(0x0028,0x1201); unsigned char *lutG = (unsigned char *) GetEntryVoidAreaByNumber(0x0028,0x1202); unsigned char *lutB = (unsigned char *) GetEntryVoidAreaByNumber(0x0028,0x1203); if (!lutR || !lutG || !lutB ) { return NULL; } // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT unsigned char *LUTRGBA = (unsigned char *)calloc(1024,1); // 256 * 4 (R, G, B, Alpha) if (!LUTRGBA) { return NULL; } memset(LUTRGBA, 0, 1024); // Bits Allocated int nb; std::string str_nb = GetEntryByNumber(0x0028,0x0100); if (str_nb == GDCM_UNFOUND ) { nb = 16; } else { nb = atoi(str_nb.c_str() ); } int mult; if (nbitsR==16 && nb==8) // when LUT item size is different than pixel size mult=2; // high byte must be = low byte else // See PS 3.3-2003 C.11.1.1.2 p 619 mult=1; // if we get a black image, let's just remove the '+1' // from 'i*mult+1' and check again // if it works, we shall have to check the 3 Palettes // to see which byte is ==0 (first one, or second one) // and fix the code // We give up the checking to avoid some (useless ?)overhead // (optimistic asumption) unsigned char *a; int i; a = LUTRGBA+0; for(i=0;i<lengthR;i++) { *a = lutR[i*mult+1]; a+=4; } a = LUTRGBA+1; for(i=0;i<lengthG;i++) { *a = lutG[i*mult+1]; a+=4; } a = LUTRGBA+2; for(i=0;i<lengthB;i++) { *a = lutB[i*mult+1]; a+=4; } a = LUTRGBA+3; for(i=0;i<256;i++) { *a = 1; // Alpha component a+=4; } //How to free the now useless LUTs? //free(LutR); free(LutB); free(LutG); // Seg Fault when used return(LUTRGBA); }

guint16 gdcmParser::GetNumPixel (  void   )  [inline, inherited]

Definition at line 103 of file gdcmParser.h. Referenced by gdcmFile::WriteBase(). {return NumPixel;}

size_t gdcmHeader::GetPixelAreaLength (  void   )

Recover the pixel area length (in Bytes). Returns: Pixel Element Length, as stored in the header (NOT the memory space necessary to hold the Pixels -in case of embeded compressed image-) 0 : NOT USABLE file. The caller has to check. Definition at line 476 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntrySameNumber(), gdcmHeaderEntry::GetLength(), IterHT, TagKey, and gdcmDictEntry::TranslateToKey(). Referenced by gdcmFile::ReadPixelData(). { IterHT it = GetHeaderEntrySameNumber(GrPixel,NumPixel); TagKey key = gdcmDictEntry::TranslateToKey(GrPixel,NumPixel); gdcmHeaderEntry* PixelElement; if (countGrPixel==1) PixelElement = (it.first)->second; else PixelElement = (++it.first)->second; if (PixelElement) { return PixelElement->GetLength(); } else { /* std::cout << "Big trouble : Pixel Element (" << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" << std::endl;*/ return 0; } }

size_t gdcmHeader::GetPixelOffset (  void   )

Recover the offset (from the beginning of the file) of *image* pixels (not *icone image* pixels, if any !). Returns: Pixel Offset Definition at line 440 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntrySameNumber(), gdcmHeaderEntry::GetOffset(), IterHT, TagKey, and gdcmDictEntry::TranslateToKey(). Referenced by gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { // // If the element (0x0088,0x0200) 'icone image sequence' is found // (grPixel,numPixel) is stored twice : the first one for the icon // the second one for the image ... // pb : sometimes , (0x0088,0x0200) exists, but doesn't contain *anything* // see gdcmData/MxTwinLossLess.dcm ... //std::string icone = GetEntryByNumber(0x0088,0x0200); //icone image sequence IterHT it = GetHeaderEntrySameNumber(GrPixel,NumPixel); TagKey key = gdcmDictEntry::TranslateToKey(GrPixel,NumPixel); gdcmHeaderEntry* PixelElement; if (countGrPixel == 1) PixelElement = (it.first)->second; else { PixelElement = (++it.first)->second; // hope there are no more than 2 ! } if (PixelElement) { return PixelElement->GetOffset(); } else { /* std::cout << "Big trouble : Pixel Element (" << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" << std::endl; */ return 0; } }

int gdcmHeader::GetPixelSize (  void   )

Return the size (in bytes) of a single pixel of data. Returns: The size in bytes of a single pixel of data; 0 by default 0 means the file is NOT USABLE; the caller will have to check Reimplemented in gdcmHeaderHelper. Definition at line 378 of file gdcmHeader.cxx. References dbg, GetPixelType(), and gdcmDebug::Verbose(). Referenced by gdcmFile::ReadPixelData(). { std::string PixelType = GetPixelType(); if (PixelType == "8U" || PixelType == "8S") return 1; if (PixelType == "16U" || PixelType == "16S") return 2; if (PixelType == "32U" || PixelType == "32S") return 4; if (PixelType == "FD") return 8; dbg.Verbose(0, "gdcmHeader::GetPixelSize: Unknown pixel type"); return 0; }

std::string gdcmHeader::GetPixelType (  void   )

Build the Pixel Type of the image. Possible values are: -8U unsigned 8 bit, -8S signed 8 bit, -16U unsigned 16 bit, -16S signed 16 bit, -32U unsigned 32 bit, -32S signed 32 bit, -FD floating double 64 bits (Not kosher DICOM, but so usefull!). Warning: 12 bit images appear as 16 bit. 24 bit images appear as 8 bit Returns: 0S if nothing found. NOT USABLE file. The caller has to check Reimplemented in gdcmHeaderHelper. Definition at line 407 of file gdcmHeader.cxx. References dbg, GDCM_UNFOUND, GetEntryByNumber(), and gdcmDebug::Verbose(). Referenced by GetPixelSize(). { std::string BitsAlloc = GetEntryByNumber(0x0028, 0x0100); // Bits Allocated if (BitsAlloc == GDCM_UNFOUND) { dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Bits Allocated"); BitsAlloc = std::string("16"); } if (BitsAlloc == "64") // ) return ("FD"); if (BitsAlloc == "12") // It will be unpacked BitsAlloc = std::string("16"); else if (BitsAlloc == "24") // (in order no to be messed up BitsAlloc = std::string("8"); // by old RGB images) std::string Signed = GetEntryByNumber(0x0028, 0x0103); // "Pixel Representation" if (Signed == GDCM_UNFOUND) { dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Pixel Representation"); BitsAlloc = std::string("0"); } if (Signed == "0") Signed = std::string("U"); else Signed = std::string("S"); return( BitsAlloc + Signed); }

int gdcmHeader::GetPlanarConfiguration (  void   )

Retrieve the Planar Configuration for RGB images (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane). Returns: The encountered Planar Configuration, 0 by default. Definition at line 365 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmFile::GetImageDataIntoVectorRaw(). { std::string StrSize = GetEntryByNumber(0x0028,0x0006); if (StrSize == GDCM_UNFOUND) return 0; return atoi(StrSize.c_str()); }

gdcmDict * gdcmParser::GetPubDict (  void   )  [inherited]

Get the public dictionary used. Definition at line 185 of file gdcmParser.cxx. References gdcmParser::RefPubDict. Referenced by gdcmDicomDir::SetElement(). { return(RefPubDict); }

int gdcmHeader::GetSamplesPerPixel (  void   )

Retrieve the number of Samples Per Pixel (1 : gray level, 3 : RGB -1 or 3 Planes-). Returns: The encountered number of Samples Per Pixel, 1 by default. (Gray level Pixels) Definition at line 351 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmHeaderHelper::GetNumberOfScalarComponents(), gdcmHeaderHelper::GetNumberOfScalarComponentsRaw(), gdcmFile::ParsePixelData(), gdcmFile::ReadPixelData(), and gdcmFile::SetPixelDataSizeFromHeader(). { std::string StrSize = GetEntryByNumber(0x0028,0x0002); if (StrSize == GDCM_UNFOUND) return 1; // Well, it's supposed to be mandatory ... // but sometimes it's missing : *we* assume Gray pixels return atoi(StrSize.c_str()); }

gdcmDict * gdcmParser::GetShaDict (  void   )  [inherited]

Get the shadow dictionary used. Definition at line 193 of file gdcmParser.cxx. References gdcmParser::RefShaDict. { return(RefShaDict); }

int gdcmParser::GetSwapCode (  void   )  [inline, inherited]

Definition at line 101 of file gdcmParser.h. Referenced by gdcmFile::gdcm_read_RLE_file(), gdcmFile::GetImageDataIntoVectorRaw(), gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { return sw; }

std::string gdcmHeader::GetTransfertSyntaxName (  void   )

gets the info from 0002,0010 : Transfert Syntax and gdcmTS else 1. Returns: the full Transfert Syntax Name (as oposite to Transfert Syntax UID) Definition at line 695 of file gdcmHeader.cxx. References dbg, GDCM_UNFOUND, GetEntryByNumber(), gdcmGlobal::GetTS(), gdcmTS::GetValue(), and gdcmDebug::Verbose(). { // use the gdcmTS (TS : Transfert Syntax) std::string TransfertSyntax = GetEntryByNumber(0x0002,0x0010); if (TransfertSyntax == GDCM_UNFOUND) { dbg.Verbose(0, "gdcmHeader::GetTransfertSyntaxName: unfound Transfert Syntax (0002,0010)"); return "Uncompressed ACR-NEMA"; } // we do it only when we need it gdcmTS * ts = gdcmGlobal::GetTS(); std::string tsName=ts->GetValue(TransfertSyntax); //delete ts; // Seg Fault when deleted ?! return tsName; }

int gdcmHeader::GetXSize (  void   )

Retrieve the number of columns of image. Returns: The encountered size when found, 0 by default. 0 means the file is NOT USABLE. The caller will have to check Definition at line 264 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmFile::gdcm_read_RLE_file(), gdcmFile::GetImageDataIntoVectorRaw(), gdcmFile::ParsePixelData(), gdcmFile::ReadPixelData(), and gdcmFile::SetPixelDataSizeFromHeader(). { std::string StrSize; StrSize = GetEntryByNumber(0x0028,0x0011); if (StrSize == GDCM_UNFOUND) return 0; return atoi(StrSize.c_str()); }

int gdcmHeader::GetYSize (  void   )

Retrieve the number of lines of image. Warning: The defaulted value is 1 as opposed to gdcmHeader::GetXSize() Returns: The encountered size when found, 1 by default (The ACR-MEMA file contains a Signal, not an Image). Definition at line 279 of file gdcmHeader.cxx. References GDCM_UNFOUND, GetEntryByNumber(), and IsDicomV3(). Referenced by gdcmFile::gdcm_read_RLE_file(), gdcmFile::GetImageDataIntoVectorRaw(), gdcmFile::ParsePixelData(), gdcmFile::ReadPixelData(), and gdcmFile::SetPixelDataSizeFromHeader(). { std::string StrSize = GetEntryByNumber(0x0028,0x0010); if (StrSize != GDCM_UNFOUND) return atoi(StrSize.c_str()); if ( IsDicomV3() ) return 0; else // The Rows (0028,0010) entry was optional for ACR/NEMA. It might // hence be a signal (1d image). So we default to 1: return 1; }

int gdcmHeader::GetZSize (  void   )

Retrieve the number of planes of volume or the number of frames of a multiframe. Warning: When present we consider the "Number of Frames" as the third dimension. When absent we consider the third dimension as being the ACR-NEMA "Planes" tag content. Returns: The encountered size when found, 1 by default (single image). Definition at line 300 of file gdcmHeader.cxx. References GDCM_UNFOUND, and GetEntryByNumber(). Referenced by gdcmFile::gdcm_read_RLE_file(), gdcmFile::GetImageDataIntoVectorRaw(), and gdcmFile::SetPixelDataSizeFromHeader(). { // Both DicomV3 and ACR/Nema consider the "Number of Frames" // as the third dimension. std::string StrSize = GetEntryByNumber(0x0028,0x0008); if (StrSize != GDCM_UNFOUND) return atoi(StrSize.c_str()); // We then consider the "Planes" entry as the third dimension StrSize = GetEntryByNumber(0x0028,0x0012); if (StrSize != GDCM_UNFOUND) return atoi(StrSize.c_str()); return 1; }

bool gdcmHeader::HasLUT (  void   )

tells us if LUT are used Warning: Right now, 'Segmented xxx Palette Color Lookup Table Data' are NOT considered as LUT, since nobody knows how to deal with them Please warn me if you know sbdy that *does* know ... jprx Returns: true if LUT Descriptors and LUT Tables were found Definition at line 506 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(). Referenced by gdcmFile::GetImageDataIntoVector(), gdcmFile::GetImageDataRaw(), gdcmHeaderHelper::GetNumberOfScalarComponents(), and gdcmFile::SetPixelDataSizeFromHeader(). { // Check the presence of the LUT Descriptors, and LUT Tables // LutDescriptorRed if ( !GetHeaderEntryByNumber(0x0028,0x1101) ) return false; // LutDescriptorGreen if ( !GetHeaderEntryByNumber(0x0028,0x1102) ) return false; // LutDescriptorBlue if ( !GetHeaderEntryByNumber(0x0028,0x1103) ) return false; // Red Palette Color Lookup Table Data if ( !GetHeaderEntryByNumber(0x0028,0x1201) ) return false; // Green Palette Color Lookup Table Data if ( !GetHeaderEntryByNumber(0x0028,0x1202) ) return false; // Blue Palette Color Lookup Table Data if ( !GetHeaderEntryByNumber(0x0028,0x1203) ) return false; return true; }

bool gdcmParser::IsDeflatedExplicitVRLittleEndianTransferSyntax (  void   )  [inherited]

Determines if the Transfer Syntax was already encountered and if it corresponds to a DeflatedExplicitVRLittleEndian one. Returns: True when DeflatedExplicitVRLittleEndian found. False in all other cases. Definition at line 279 of file gdcmParser.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), gdcmParser::LoadHeaderEntrySafe(), and UI1_2_840_10008_1_2_1_99. Referenced by gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == UI1_2_840_10008_1_2_1_99 ) return true; return false; }

bool gdcmHeader::IsDicomV3 (  void   )

Predicate for dicom version 3 file. Returns: True when the file is a dicom version 3. Definition at line 250 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(). Referenced by GetYSize(), gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { // Checking if Transfert Syntax exists is enough // Anyway, it's to late check if the 'Preamble' was found ... // And ... would it be a rich idea to check ? // (some 'no Preamble' DICOM images exist !) return (GetHeaderEntryByNumber(0x0002, 0x0010) != NULL); }

bool gdcmParser::IsExplicitVRBigEndianTransferSyntax (  void   )  [inherited]

Determines if the Transfer Syntax was already encountered and if it corresponds to a Explicit VR Big Endian one. Returns: True when big endian found. False in all other cases. Definition at line 297 of file gdcmParser.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), gdcmParser::LoadHeaderEntrySafe(), and UI1_2_840_10008_1_2_2. Referenced by gdcmParser::FindHeaderEntryLength(), gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == UI1_2_840_10008_1_2_2 ) //1.2.2 ??? A verifier ! return true; return false; }

bool gdcmParser::IsExplicitVRLittleEndianTransferSyntax (  void   )  [inherited]

Determines if the Transfer Syntax was already encountered and if it corresponds to a ExplicitVRLittleEndian one. Returns: True when ExplicitVRLittleEndian found. False in all other cases. Definition at line 261 of file gdcmParser.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), gdcmParser::LoadHeaderEntrySafe(), and UI1_2_840_10008_1_2_1. Referenced by gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == UI1_2_840_10008_1_2_1 ) return true; return false; }

bool gdcmParser::IsImplicitVRLittleEndianTransferSyntax (  void   )  [inherited]

Determines if the Transfer Syntax was already encountered and if it corresponds to a ImplicitVRLittleEndian one. Returns: True when ImplicitVRLittleEndian found. False in all other cases. Definition at line 243 of file gdcmParser.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), gdcmParser::LoadHeaderEntrySafe(), and UI1_2_840_10008_1_2. Referenced by gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { gdcmHeaderEntry *Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == UI1_2_840_10008_1_2 ) return true; return false; }

bool gdcmHeader::IsJPEG2000 (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEG2000 one. Returns: True when JPEG2000 (Lossly or LossLess) found. False in all other cases. Definition at line 232 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). Referenced by gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( (Transfer == "1.2.840.10008.1.2.4.90") || (Transfer == "1.2.840.10008.1.2.4.91") ) return true; return false; }

bool gdcmHeader::IsJPEGBaseLineProcess1TransferSyntax (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGBaseLineProcess1 one. Returns: True when JPEGBaseLineProcess1found. False in all other cases. Definition at line 120 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.50" ) return true; return false; }

bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGExtendedProcess2-4 one. Returns: True when JPEGExtendedProcess2-4 found. False in all other cases. Definition at line 138 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); return ( Element->GetValue() == "1.2.840.10008.1.2.4.51" ); }

bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGExtendeProcess3-5 one. Returns: True when JPEGExtendedProcess3-5 found. False in all other cases. Definition at line 152 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.52" ) return true; return false; }

bool gdcmHeader::IsJPEGLossless (  void   )

Determines if Transfer Syntax was already encountered and if it corresponds to a JPEG Lossless one. Returns: True when RLE Lossless found. False in all other cases. Definition at line 210 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). Referenced by gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); // faire qq chose d'intelligent a la place de ça if ( !Element ) return false; LoadHeaderEntrySafe(Element); const char * Transfert = Element->GetValue().c_str(); if ( memcmp(Transfert+strlen(Transfert)-2 ,"70",2)==0) return true; if ( memcmp(Transfert+strlen(Transfert)-2 ,"55",2)==0) return true; if (Element->GetValue() == "1.2.840.10008.1.2.4.57") return true; return false; }

bool gdcmHeader::IsJPEGSpectralSelectionProcess6_8TransferSyntax (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a JPEGSpectralSelectionProcess6-8 one. Returns: True when JPEGSpectralSelectionProcess6-8 found. False in all other cases. Definition at line 171 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.53" ) return true; return false; }

bool gdcmHeader::IsReadable (  void   )  [virtual]

This predicate, based on hopefully reasonable heuristics, decides whether or not the current gdcmParser was properly parsed and contains the mandatory information for being considered as a well formed and usable Dicom/Acr File. Returns: true when gdcmParser is the one of a reasonable Dicom/Acr file, false otherwise. Reimplemented from gdcmParser. Definition at line 96 of file gdcmHeader.cxx. References GDCM_UNFOUND, GetEntryByNumber(), gdcmParser::GetHeaderEntryByNumber(), and gdcmParser::IsReadable(). Referenced by gdcmFile::gdcmFile(), and gdcmDicomDir::NewDicomDir(). { if(!gdcmParser::IsReadable()) { return(false); } std::string res = GetEntryByNumber(0x0028, 0x0005); if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 ) return false; // Image Dimensions if ( !GetHeaderEntryByNumber(0x0028, 0x0100) ) return false; // "Bits Allocated" if ( !GetHeaderEntryByNumber(0x0028, 0x0101) ) return false; // "Bits Stored" if ( !GetHeaderEntryByNumber(0x0028, 0x0102) ) return false; // "High Bit" if ( !GetHeaderEntryByNumber(0x0028, 0x0103) ) return false; // "Pixel Representation" i.e. 'Sign' return true; }

bool gdcmHeader::IsRLELossLessTransferSyntax (  void   )

Determines if the Transfer Syntax was already encountered and if it corresponds to a RLE Lossless one. Returns: True when RLE Lossless found. False in all other cases. Definition at line 190 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetValue(), and gdcmParser::LoadHeaderEntrySafe(). Referenced by gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadHeaderEntrySafe(Element); std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.5" ) { return true; } return false; }

void * gdcmParser::LoadEntryVoidArea (  guint16  Group, guint16  Elem )  [protected, virtual, inherited]

Loads (from disk) the element content when a string is not suitable. Parameters: Group  group of the Entry Elem  element of the Entry Definition at line 734 of file gdcmParser.cxx. References gdcmParser::fp, gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetLength(), gdcmHeaderEntry::GetOffset(), and gdcmParser::SetEntryVoidAreaByNumber(). Referenced by gdcmParser::LoadHeaderEntries(). { gdcmHeaderEntry * Element= GetHeaderEntryByNumber(Group, Elem); if ( !Element ) return NULL; size_t o =(size_t)Element->GetOffset(); fseek(fp, o, SEEK_SET); int l=Element->GetLength(); void * a = malloc(l); if(!a) return NULL; SetEntryVoidAreaByNumber(a, Group, Elem); // TODO check the result size_t l2 = fread(a, 1, l ,fp); if(l != l2) { free(a); return NULL; } return a; }

void gdcmParser::LoadHeaderEntrySafe (  gdcmHeaderEntry *  entry  )  [protected, inherited]

Loads the element while preserving the current underlying file position indicator as opposed to to LoadHeaderEntry that modifies it. Parameters: entry  Header Entry whose value shall be loaded. Returns: Definition at line 877 of file gdcmParser.cxx. References gdcmParser::fp, and gdcmParser::LoadHeaderEntry(). Referenced by gdcmParser::IsDeflatedExplicitVRLittleEndianTransferSyntax(), gdcmParser::IsExplicitVRBigEndianTransferSyntax(), gdcmParser::IsExplicitVRLittleEndianTransferSyntax(), gdcmParser::IsImplicitVRLittleEndianTransferSyntax(), IsJPEG2000(), IsJPEGBaseLineProcess1TransferSyntax(), IsJPEGExtendedProcess2_4TransferSyntax(), IsJPEGExtendedProcess3_5TransferSyntax(), IsJPEGLossless(), IsJPEGSpectralSelectionProcess6_8TransferSyntax(), and IsRLELossLessTransferSyntax(). { long PositionOnEntry = ftell(fp); LoadHeaderEntry(entry); fseek(fp, PositionOnEntry, SEEK_SET); }

FILE * gdcmParser::OpenFile (  bool  exception_on_error = false  )  throw (gdcmFileError) [inherited]

opens the file Parameters: exception_on_error  Returns: Definition at line 325 of file gdcmParser.cxx. References dbg, and gdcmDebug::Verbose(). Referenced by gdcmParser::gdcmParser(), gdcmFile::ParsePixelData(), and gdcmFile::ReadPixelData(). { fp=fopen(filename.c_str(),"rb"); if(exception_on_error) { if(!fp) throw gdcmFileError("gdcmParser::gdcmParser(const char *, bool)"); } if ( fp ) { guint16 zero; fread(&zero, (size_t)2, (size_t)1, fp); //ACR -- or DICOM with no Preamble -- if( zero == 0x0008 || zero == 0x0800 || zero == 0x0002 || zero == 0x0200) return(fp); //DICOM fseek(fp, 126L, SEEK_CUR); char dicm[4]; fread(dicm, (size_t)4, (size_t)1, fp); if( memcmp(dicm, "DICM", 4) == 0 ) return(fp); fclose(fp); dbg.Verbose(0, "gdcmParser::OpenFile not DICOM/ACR", filename.c_str()); } else { dbg.Verbose(0, "gdcmParser::OpenFile cannot open file", filename.c_str()); } return(NULL); }

bool gdcmHeader::operator< (  gdcmHeader &  header  )

compares 2 Headers, according to DICOMDIR rules --> not-for-rats function Warning: does NOT work with ACR-NEMA files Todo: find a trick to solve the pb (use RET fields ?) Parameters: header  Returns: true if 'smaller' Definition at line 743 of file gdcmHeader.cxx. References GetEntryByNumber(). { std::string s1,s2; // Patient Name s1=this->GetEntryByNumber(0x0010,0x0010); s2=header.GetEntryByNumber(0x0010,0x0010); if(s1 < s2) return(true); else if(s1 > s2) return(false); else { // Patient ID s1=this->GetEntryByNumber(0x0010,0x0020); s2=header.GetEntryByNumber(0x0010,0x0020); if (s1 < s2) return(true); else if (s1 > s2) return(1); else { // Study Instance UID s1=this->GetEntryByNumber(0x0020,0x000d); s2=header.GetEntryByNumber(0x0020,0x000d); if (s1 < s2) return(true); else if(s1 > s2) return(false); else { // Serie Instance UID s1=this->GetEntryByNumber(0x0020,0x000e); s2=header.GetEntryByNumber(0x0020,0x000e); if (s1 < s2) return(true); else if(s1 > s2) return(false); } } } return(false); }

virtual void gdcmParser::Print (  std::ostream &  os = std::cout  )  [inline, virtual, inherited]

Reimplemented in gdcmDicomDir. Definition at line 52 of file gdcmParser.h. {PrintEntry(os);};

void gdcmParser::PrintEntry (  std::ostream &  os = std::cout  )  [virtual, inherited]

Prints the Header Entries (Dicom Elements) both from the H Table and the chained list. Returns: Definition at line 148 of file gdcmParser.cxx. References gdcmParser::listEntries. { std::ostringstream s; for (ListTag::iterator i = listEntries.begin(); i != listEntries.end(); ++i) { (*i)->SetPrintLevel(printLevel); (*i)->Print(os); } os<<s.str(); }

void gdcmParser::PrintPubDict (  std::ostream &  os = std::cout  )  [virtual, inherited]

Prints The Dict Entries of THE public Dicom Dictionnry. Returns: Definition at line 166 of file gdcmParser.cxx. References gdcmDict::Print(), and gdcmParser::RefPubDict. { RefPubDict->Print(os); }

void gdcmParser::PrintShaDict (  std::ostream &  os = std::cout  )  [virtual, inherited]

Prints The Dict Entries of THE shadow Dicom Dictionnry. Returns: Definition at line 175 of file gdcmParser.cxx. References gdcmDict::Print(), and gdcmParser::RefShaDict. { RefShaDict->Print(os); }

bool gdcmParser::ReplaceIfExistByNumber (  char *  Value, guint16  Group, guint16  Elem )  [inherited]

Set a new value if the invoked element exists Seems to be useless !!! Parameters: Value  new element value Group  group of the Entry Elem  element of the Entry Returns: boolean Definition at line 491 of file gdcmParser.cxx. References gdcmParser::SetEntryByNumber(). Referenced by anonymizeHeader(). { std::string v = Value; SetEntryByNumber(v, Group, Elem); return true; }

bool gdcmParser::ReplaceOrCreateByNumber (  char *  Value, guint16  Group, guint16  Elem )  [inherited]

Modifies the value of a given Header Entry (Dicom Element) if it exists; Creates it with the given value if it doesn't. Parameters: Value  passed as a char* Group  group of the Entry Elem  element of the Entry Returns: boolean Definition at line 469 of file gdcmParser.cxx. References gdcmParser::AddHeaderEntry(), gdcmParser::NewHeaderEntryByNumber(), and gdcmParser::SetEntryByNumber(). { gdcmHeaderEntry* nvHeaderEntry=NewHeaderEntryByNumber(Group, Elem); if(!nvHeaderEntry) return(false); AddHeaderEntry(nvHeaderEntry); std::string v = Value; SetEntryByNumber(v, Group, Elem); return(true); }

bool gdcmParser::ReplaceOrCreateByNumber (  std::string  Value, guint16  Group, guint16  Elem )  [inherited]

Modifies the value of a given Header Entry (Dicom Element) if it exists; Creates it with the given value if it doesn't. Parameters: Value  passed as a std::string Group  Elem  Returns: false only if new element creation fails Definition at line 446 of file gdcmParser.cxx. References gdcmParser::AddHeaderEntry(), gdcmParser::CheckIfEntryExistByNumber(), gdcmParser::NewHeaderEntryByNumber(), and gdcmParser::SetEntryByNumber(). Referenced by anonymizeHeader(), and gdcmParser::Write(). { if (CheckIfEntryExistByNumber(Group, Elem) == 0) { gdcmHeaderEntry *a =NewHeaderEntryByNumber(Group, Elem); if (a == NULL) return false; AddHeaderEntry(a); } SetEntryByNumber(Value, Group, Elem); return(true); }

virtual bool gdcmHeader::SetEntryByName (  std::string  content, std::string  tagName )  [inline, virtual]

Sets the value (string) of the Header Entry (Dicom Element). Parameters: content  string value of the Dicom Element tagName  name of the searched Dicom Element. Returns: true when found Reimplemented from gdcmParser. Definition at line 97 of file gdcmHeader.h. References gdcmParser::SetEntryByName(). { return(gdcmParser::SetEntryByName(content,tagName)); }

virtual bool gdcmHeader::SetEntryByNumber (  std::string  content, guint16  group, guint16  element )  [inline, virtual]

Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element) through it's (group, element) and modifies it's content with the given value. Warning: Don't use any longer : use SetPubEntryByNumber Parameters: content  new value to substitute with group  group of the Dicom Element to modify element  element of the Dicom Element to modify Reimplemented from gdcmParser. Definition at line 95 of file gdcmHeader.h. References gdcmParser::SetEntryByNumber(). Referenced by gdcmFile::GetImageDataIntoVector(), gdcmFile::GetImageDataIntoVectorRaw(), SetImageDataSize(), and gdcmFile::WriteBase(). { return(gdcmParser::SetEntryByNumber(content,group,element)); }

virtual bool gdcmHeader::SetEntryLengthByNumber (  guint32  l, guint16  group, guint16  element )  [inline, virtual]

Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element) in the PubHeaderEntrySet of this instance through it's (group, element) and modifies it's length with the given value. Warning: Use with extreme caution. Parameters: l  new length to substitute with group  group of the Entry to modify element  element of the Entry to modify Returns: 1 on success, 0 otherwise. Reimplemented from gdcmParser. Definition at line 100 of file gdcmHeader.h. References gdcmParser::SetEntryLengthByNumber(). { return(gdcmParser::SetEntryLengthByNumber(l,group,element)); }

bool gdcmParser::SetEntryVoidAreaByNumber (  void *  area, guint16  group, guint16  element )  [protected, virtual, inherited]

Sets a 'non string' value to a given Dicom Element. Parameters: area  group  Group number of the searched Dicom Element element  Element number of the searched Dicom Element Returns: Definition at line 766 of file gdcmParser.cxx. References gdcmParser::tagHT, TagKey, and gdcmDictEntry::TranslateToKey(). Referenced by gdcmParser::LoadEntryVoidArea(). { TagKey key = gdcmDictEntry::TranslateToKey(group, element); if ( ! tagHT.count(key)) return false; ( ((tagHT.equal_range(key)).first)->second )->SetVoidArea(area); return true; }

void gdcmHeader::SetImageDataSize (  size_t  ImageDataSize  )

Sets the Pixel Area size in the Header --> not-for-rats function. Parameters: ImageDataSize  new Pixel Area Size warning : nothing else is checked Definition at line 716 of file gdcmHeader.cxx. References gdcmParser::GetHeaderEntryByNumber(), SetEntryByNumber(), and gdcmHeaderEntry::SetLength(). Referenced by gdcmFile::SetImageData(). { std::string content1; char car[20]; // Assumes HeaderEntry (GrPixel, NumPixel) is unique ... // TODO deal with multiplicity (see gdcmData/icone.dcm) sprintf(car,"%d",ImageDataSize); gdcmHeaderEntry *a = GetHeaderEntryByNumber(GrPixel, NumPixel); a->SetLength(ImageDataSize); ImageDataSize+=8; sprintf(car,"%d",ImageDataSize); content1=car; SetEntryByNumber(content1, GrPixel, NumPixel); }

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

Sets the print level for the Dicom Header. Note: 0 for Light Print; 1 for 'medium' Print, 2 for Heavy Reimplemented in gdcmDicomDir. Definition at line 51 of file gdcmParser.h. { printLevel = level; };

bool gdcmParser::SetShaDict (  DictKey  dictName  )  [inherited]

Set the shadow dictionary used. Parameters: dictName  name of the dictionary to use in shadow Definition at line 212 of file gdcmParser.cxx. References DictKey, gdcmDictSet::GetDict(), gdcmGlobal::GetDicts(), and gdcmParser::RefShaDict. { RefShaDict=gdcmGlobal::GetDicts()->GetDict(dictName); return(!RefShaDict); }

bool gdcmParser::SetShaDict (  gdcmDict *  dict  )  [inherited]

Set the shadow dictionary used. Parameters: dict  dictionary to use in shadow Definition at line 202 of file gdcmParser.cxx. References gdcmParser::RefShaDict. { RefShaDict=dict; return(!RefShaDict); }

guint32 gdcmParser::SwapLong (  guint32  a  )  [inherited]

Swaps back the bytes of 4-byte long integer accordingly to processor order. Returns: The properly swaped 32 bits integer. Definition at line 1156 of file gdcmParser.cxx. References dbg, gdcmDebug::Error(), and gdcmParser::sw. Referenced by gdcmFile::gdcm_read_RLE_file(), gdcmParser::GetHeaderEntryValue(), gdcmFile::ParsePixelData(), gdcmParser::ReadInt32(), gdcmFile::ReadPixelData(), and gdcmParser::UnswapLong(). { switch (sw) { case 0 : break; case 4321 : a=( ((a<<24) & 0xff000000) | ((a<<8) & 0x00ff0000) | ((a>>8) & 0x0000ff00) | ((a>>24) & 0x000000ff) ); break; case 3412 : a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) ); break; case 2143 : a=( ((a<<8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff) ); break; default : dbg.Error(" gdcmParser::SwapLong : unset swap code"); a=0; } return(a); }

guint16 gdcmParser::SwapShort (  guint16  a  )  [inherited]

Swaps the bytes so they agree with the processor order. Returns: The properly swaped 16 bits integer. Definition at line 1194 of file gdcmParser.cxx. References gdcmParser::sw. Referenced by gdcmParser::FindHeaderEntryLength(), gdcmFile::gdcm_read_RLE_file(), gdcmParser::GetHeaderEntryValue(), gdcmFile::ParsePixelData(), gdcmParser::ReadInt16(), gdcmFile::ReadPixelData(), and gdcmParser::UnswapShort(). { if ( (sw==4321) || (sw==2143) ) a =(((a<<8) & 0x0ff00) | ((a>>8)&0x00ff)); return (a); }

guint32 gdcmParser::UnswapLong (  guint32  a  )  [inherited]

Unswaps back the bytes of 4-byte long integer accordingly to processor order. Returns: The properly unswaped 32 bits integer. Definition at line 1185 of file gdcmParser.cxx. References gdcmParser::SwapLong(). { return (SwapLong(a)); }

guint16 gdcmParser::UnswapShort (  guint16  a  )  [inherited]

Unswaps the bytes so they agree with the processor order. Returns: The properly unswaped 16 bits integer. Definition at line 1205 of file gdcmParser.cxx. References gdcmParser::SwapShort(). { return (SwapShort(a)); }

void gdcmParser::UpdateGroupLength (  bool  SkipSequence = false, FileType  type = ImplicitVR )  [protected, inherited]

Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader. Warning: : to be re-written using the chained list instead of the H table. : DO NOT use (doesn't work any longer because of the multimap) Todo: : to be re-written using the chained list instead of the H table Parameters: SkipSequence  TRUE if we don't want to write Sequences (ACR-NEMA Files) type  Type of the File (ExplicitVR,ImplicitVR, ACR, ...) Definition at line 892 of file gdcmParser.cxx. References gdcmParser::AddHeaderEntry(), ExplicitVR, gdcmHeaderEntry::GetElement(), gdcmHeaderEntry::GetGroup(), gdcmParser::GetHeaderEntryByNumber(), gdcmHeaderEntry::GetLength(), gdcmHeaderEntry::GetVR(), GroupHT, GroupKey, gdcmHeaderEntry::SetLength(), gdcmHeaderEntry::SetValue(), gdcmParser::tagHT, and TagKey. { guint16 gr, el; std::string vr; gdcmHeaderEntry *elem; char trash[10]; std::string str_trash; GroupKey key; GroupHT groupHt; // to hold the length of each group TagKey tk; // remember : // typedef std::map<GroupKey, int> GroupHT; gdcmHeaderEntry *elemZ; // for each Tag in the DCM Header for (TagHeaderEntryHT::iterator tag2 = tagHT.begin(); tag2 != tagHT.end(); ++tag2) { elem = tag2->second; gr = elem->GetGroup(); el = elem->GetElement(); vr = elem->GetVR(); sprintf(trash, "%04x", gr); key = trash; // generate 'group tag' // if the caller decided not to take SEQUENCEs into account // e.g : he wants to write an ACR-NEMA File if (SkipSequence && vr == "SQ") continue; // Still unsolved problem : // we cannot find the 'Sequence Delimitation Item' // since it's at the end of the Hash Table // (fffe,e0dd) // pas SEQUENCE en ACR-NEMA // WARNING : // --> la descente a l'interieur' des SQ // devrait etre faite avec une liste chainee, pas avec une HTable... if ( groupHt.count(key) == 0) // we just read the first elem of a given group { if (el == 0x0000) // the first elem is 0x0000 { groupHt[key] = 0; // initialize group length } else { groupHt[key] = 2 + 2 + 4 + elem->GetLength(); // non 0x0000 first group elem } } else // any elem but the first { if (type == ExplicitVR) { if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ) { groupHt[key] += 4; // explicit VR AND OB, OW, SQ : 4 more bytes } } groupHt[key] += 2 + 2 + 4 + elem->GetLength(); } } unsigned short int gr_bid; for (GroupHT::iterator g = groupHt.begin(); // for each group we found g != groupHt.end(); ++g) { // FIXME: g++ -Wall -Wstrict-prototypes reports on following line: // warning: unsigned int format, different type arg sscanf(g->first.c_str(),"%x",&gr_bid); tk = g->first + "|0000"; // generate the element full tag if ( tagHT.count(tk) == 0) // if element 0x0000 not found { gdcmDictEntry * tagZ = new gdcmDictEntry(gr_bid, 0x0000, "UL"); elemZ = new gdcmHeaderEntry(tagZ); elemZ->SetLength(4); AddHeaderEntry(elemZ); // create it } else { elemZ=GetHeaderEntryByNumber(gr_bid, 0x0000); } sprintf(trash ,"%d",g->second); str_trash=trash; elemZ->SetValue(str_trash); } }

virtual void gdcmHeader::UpdateShaEntries (  void   )  [inline, virtual]

Update the entries with the shadow dictionary. Only non even entries are analyzed. Reimplemented from gdcmParser. Definition at line 103 of file gdcmHeader.h. References gdcmParser::UpdateShaEntries(). { gdcmParser::UpdateShaEntries(); }

bool gdcmParser::Write (  FILE *  fp, FileType  type )  [virtual, inherited]

Parameters: fp  file pointer on an already open file type  type of the File to be written (ACR-NEMA, ExplicitVR, ImplicitVR) Returns: always "True" ?! Definition at line 381 of file gdcmParser.cxx. References ExplicitVR, gdcmParser::ReplaceOrCreateByNumber(), gdcmParser::SetEntryLengthByNumber(), UI1_2_840_10008_1_2, UI1_2_840_10008_1_2_1, and gdcmParser::WriteEntries(). Referenced by gdcmFile::WriteBase(). { // ============== // TODO The stuff was rewritten using the chained list instead // of the H table // so we could remove the GroupHT from the gdcmParser // To be checked // ============= // TODO : move the following lines (and a lot of others, to be written) // to a future function CheckAndCorrectHeader // Question : // Comment pourrait-on savoir si le DcmHeader vient d'un fichier DicomV3 ou non // (FileType est un champ de gdcmParser ...) // WARNING : Si on veut ecrire du DICOM V3 a partir d'un DcmHeader ACR-NEMA // no way // a moins de se livrer a un tres complique ajout des champs manquants. // faire un CheckAndCorrectHeader (?) if (type == ImplicitVR) { std::string implicitVRTransfertSyntax = UI1_2_840_10008_1_2; ReplaceOrCreateByNumber(implicitVRTransfertSyntax,0x0002, 0x0010); //FIXME Refer to standards on page 21, chapter 6.2 "Value representation": // values with a VR of UI shall be padded with a single trailing null // Dans le cas suivant on doit pader manuellement avec un 0 SetEntryLengthByNumber(18, 0x0002, 0x0010); } if (type == ExplicitVR) { std::string explicitVRTransfertSyntax = UI1_2_840_10008_1_2_1; ReplaceOrCreateByNumber(explicitVRTransfertSyntax,0x0002, 0x0010); //FIXME Refer to standards on page 21, chapter 6.2 "Value representation": // values with a VR of UI shall be padded with a single trailing null // Dans le cas suivant on doit pader manuellement avec un 0 SetEntryLengthByNumber(20, 0x0002, 0x0010); } /* TODO : rewrite later if ( (type == ImplicitVR) || (type == ExplicitVR) ) UpdateGroupLength(false,type); if ( type == ACR) UpdateGroupLength(true,ACR); */ WriteEntries(fp,type); return(true); }

int gdcmHeader::write (  std::ostream &   )  [protected]

void gdcmParser::WriteEntries (  FILE *  _fp, FileType  type )  [protected, inherited]

writes on disc according to the requested format (ACR-NEMA, ExplicitVR, ImplicitVR) the image Warning: does NOT add the missing elements in the header : it's up to the user doing it ! (function CheckHeaderCoherence to be written) DON'T try, right now, to write a DICOM image from an ACR Header (meta elements will be missing!) Parameters: type  type of the File to be written (ACR-NEMA, ExplicitVR, ImplicitVR) _fp  already open file pointer Definition at line 1003 of file gdcmParser.cxx. References ACR, gdcmParser::countGrPixel, DICOMDIR, ExplicitVR, gdcmParser::GrPixel, gdcmParser::listEntries, gdcmParser::NumPixel, and Tokenize(). Referenced by gdcmParser::Write(), and gdcmDicomDir::Write(). { guint16 gr, el; guint32 lgr; std::string value; const char * val; std::string vr; guint32 val_uint32; guint16 val_uint16; guint16 valZero =0; void *voidArea; std::vector<std::string> tokens; // TODO : function CheckHeaderCoherence to be written // uses now listEntries to iterate, not TagHt! // // pb : gdcmParser.Add does NOT update listEntries // TODO : find a trick (in STL?) to do it, at low cost ! void *ptr; // TODO (?) tester les echecs en ecriture (apres chaque fwrite) int compte =0; for (ListTag::iterator tag2=listEntries.begin(); tag2 != listEntries.end(); ++tag2) { // === Deal with the length // -------------------- if(((*tag2)->GetLength())%2==1) { (*tag2)->SetValue((*tag2)->GetValue()+"\0"); (*tag2)->SetLength((*tag2)->GetLength()+1); } gr = (*tag2)->GetGroup(); el = (*tag2)->GetElement(); lgr = (*tag2)->GetReadLength(); val = (*tag2)->GetValue().c_str(); vr = (*tag2)->GetVR(); voidArea = (*tag2)->GetVoidArea(); if ( type == ACR ) { if (gr < 0x0008) continue; // ignore pure DICOM V3 groups if (gr %2) continue; // ignore shadow groups if (vr == "SQ" ) continue; // ignore Sequences // TODO : find a trick to *skip* the SeQuences ! // Not only ignore the SQ element if (gr == 0xfffe ) continue; // ignore delimiters } fwrite ( &gr,(size_t)2 ,(size_t)1 ,_fp); //group fwrite ( &el,(size_t)2 ,(size_t)1 ,_fp); //element // if ( (type == ExplicitVR) && (gr <= 0x0002) ) // ?!? < 2 if ( (type == ExplicitVR) || (type == DICOMDIR) ) { // EXPLICIT VR guint16 z=0, shortLgr; if (vr == "unkn") { // Unknown was 'written' shortLgr=lgr; fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,_fp); fwrite ( &z, (size_t)2 ,(size_t)1 ,_fp); } else { if (gr != 0xfffe) { // NO value for 'delimiters' if (vr == "unkn") // Unknown was 'written' fwrite(&z,(size_t)2 ,(size_t)1 ,_fp); else fwrite (vr.c_str(),(size_t)2 ,(size_t)1 ,_fp); } if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || gr == 0xfffe) { if (gr != 0xfffe) fwrite ( &z, (size_t)2 ,(size_t)1 ,_fp); fwrite ( &lgr,(size_t)4 ,(size_t)1 ,_fp); } else { shortLgr=lgr; fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,_fp); } } } else // IMPLICIT VR { fwrite ( &lgr,(size_t)4 ,(size_t)1 ,_fp); } // === Deal with the value // ------------------- if (vr == "SQ") continue; // no "value" to write for the SEQuences if (gr == 0xfffe)continue; if (voidArea != NULL) { // there is a 'non string' LUT, overlay, etc fwrite ( voidArea,(size_t)lgr ,(size_t)1 ,_fp); // Elem value continue; } if (vr == "US" || vr == "SS") { tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize ((*tag2)->GetValue(), tokens, "\\"); for (unsigned int i=0; i<tokens.size();i++) { val_uint16 = atoi(tokens[i].c_str()); ptr = &val_uint16; fwrite ( ptr,(size_t)2 ,(size_t)1 ,_fp); } tokens.clear(); continue; } if (vr == "UL" || vr == "SL") { tokens.erase(tokens.begin(),tokens.end()); // clean any previous value Tokenize ((*tag2)->GetValue(), tokens, "\\"); for (unsigned int i=0; i<tokens.size();i++) { val_uint32 = atoi(tokens[i].c_str()); ptr = &val_uint32; fwrite ( ptr,(size_t)4 ,(size_t)1 ,_fp); } tokens.clear(); continue; } // Pixels are never loaded in the element ! // we stop writting when Pixel are processed // FIX : we loose trailing elements (RAB, right now) if ((gr == GrPixel) && (el == NumPixel) ) { compte++; if (compte == countGrPixel) // we passed *all* the GrPixel,NumPixel break; } fwrite ( val,(size_t)lgr ,(size_t)1 ,_fp); // Elem value } }

---

Member Data Documentation

int gdcmParser::countGrPixel [protected, inherited]

Definition at line 160 of file gdcmParser.h. Referenced by gdcmParser::WriteEntries().

int gdcmParser::enableSequences [protected, inherited]

Definition at line 152 of file gdcmParser.h. Referenced by gdcmParser::FixHeaderEntryFoundLength(), and gdcmParser::gdcmParser().

FileType gdcmParser::filetype [protected, inherited]

Definition at line 142 of file gdcmParser.h. Referenced by gdcmParser::CheckSwap(), gdcmParser::FindHeaderEntryLength(), gdcmParser::FindHeaderEntryVR(), gdcmParser::GetFileType(), gdcmParser::IsReadable(), and gdcmParser::LoadHeaderEntries().

FILE* gdcmParser::fp [protected, inherited]

Definition at line 141 of file gdcmParser.h. Referenced by gdcmParser::CheckSwap(), gdcmParser::CloseFile(), gdcmParser::FindHeaderEntryLength(), gdcmParser::FindHeaderEntryLengthOB(), gdcmParser::FindHeaderEntryVR(), gdcmParser::IsHeaderEntryAnInteger(), gdcmParser::LoadEntryVoidArea(), gdcmParser::LoadHeaderEntries(), gdcmParser::LoadHeaderEntry(), gdcmParser::LoadHeaderEntrySafe(), gdcmParser::ReadInt16(), gdcmParser::ReadInt32(), gdcmParser::ReadNextHeaderEntry(), and gdcmParser::SkipBytes().

guint16 gdcmParser::GrPixel [protected, inherited]

Definition at line 156 of file gdcmParser.h. Referenced by gdcmParser::FindHeaderEntryLength(), and gdcmParser::WriteEntries().

const unsigned int gdcmParser::HEADER_LENGTH_TO_READ = 256 [static, protected, inherited]

Definition at line 69 of file gdcmParser.cxx. Referenced by gdcmParser::CheckSwap().

ListTag gdcmParser::listEntries [protected, inherited]

Definition at line 150 of file gdcmParser.h. Referenced by gdcmParser::AddHeaderEntry(), gdcmParser::IsReadable(), gdcmParser::PrintEntry(), gdcmParser::UpdateShaEntries(), and gdcmParser::WriteEntries().

const unsigned int gdcmParser::MAX_SIZE_LOAD_ELEMENT_VALUE = 4096 [static, protected, inherited]

Definition at line 72 of file gdcmParser.cxx. Referenced by gdcmParser::gdcmParser().

const unsigned int gdcmParser::MAX_SIZE_PRINT_ELEMENT_VALUE = 64 [static, protected, inherited]

Definition at line 76 of file gdcmParser.cxx.

guint16 gdcmParser::NumPixel [protected, inherited]

Definition at line 157 of file gdcmParser.h. Referenced by gdcmParser::FindHeaderEntryLength(), and gdcmParser::WriteEntries().

int gdcmParser::printLevel [protected, inherited]

Definition at line 153 of file gdcmParser.h.

TagHeaderEntryHT gdcmParser::tagHT [protected, inherited]

Definition at line 149 of file gdcmParser.h. Referenced by gdcmParser::AddHeaderEntry(), gdcmParser::CheckIfEntryExistByNumber(), gdcmParser::GenerateFreeTagKeyInGroup(), gdcmParser::GetEntryByNumber(), gdcmParser::GetHeaderEntryByNumber(), gdcmParser::GetHeaderEntrySameNumber(), gdcmParser::SetEntryByNumber(), gdcmParser::SetEntryLengthByNumber(), gdcmParser::SetEntryVoidAreaByNumber(), and gdcmParser::UpdateGroupLength().

---

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

• gdcmHeader.h
• gdcmHeader.cxx

---