-// gdcmHeader.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmHeader.h,v $
+ Language: C++
+ Date: $Date: 2004/07/31 23:30:04 $
+ Version: $Revision: 1.85 $
+
+ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+ l'Image). All rights reserved. See Doc/License.txt or
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
+
#ifndef GDCMHEADER_H
#define GDCMHEADER_H
#include "gdcmCommon.h"
-#include "gdcmVR.h"
-#include "gdcmTS.h"
-#include "gdcmException.h"
-#include "gdcmDictSet.h"
-#include "gdcmElValue.h"
-#include "gdcmElValSet.h"
-#include <map>
-
+#include "gdcmDocument.h"
//-----------------------------------------------------------------------------
-typedef std::string VRKey;
-typedef std::string VRAtr;
-typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
-
-//-----------------------------------------------------------------------------
-/*
+/**
+ * \brief
* The purpose of an instance of gdcmHeader is to act as a container of
* all the DICOM elements and their corresponding values (and
* additionaly the corresponding DICOM dictionary entry) of the header
* The typical usage of instances of class gdcmHeader is to classify a set of
* dicom files according to header information e.g. to create a file hierarchy
* reflecting the Patient/Study/Serie informations, or extracting a given
- * SerieId. Accesing the content (image[s] or volume[s]) is beyond the
+ * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
* functionality of this class and belongs to gdmcFile.
* \note The various entries of the explicit value representation (VR) shall
* be managed within a dictionary which is shared by all gdcmHeader
* protected due to Swig limitations for as Has_a dependency between
* gdcmFile and gdcmHeader.
*/
-class GDCM_EXPORT gdcmHeader {
+
+//-----------------------------------------------------------------------------
+// Dicom Part 3.3 Compliant
+enum ModalityType {
+ Unknow,
+ AU, // Voice Audio
+ AS, // Angioscopy
+ BI, // Biomagnetic Imaging
+ CF, // Cinefluorography
+ CP, // Culposcopy
+ CR, // Computed Radiography
+ CS, // Cystoscopy
+ CT, // Computed Tomography
+ DD, // Duplex Dopler
+ DF, // Digital Fluoroscopy
+ DG, // Diaphanography
+ DM, // Digital Microscopy
+ DS, // Digital Substraction Angiography
+ DX, // Digital Radiography
+ ECG, // Echocardiography
+ EPS, // Basic Cardiac EP
+ ES, // Endoscopy
+ FA, // Fluorescein Angiography
+ FS, // Fundoscopy
+ HC, // Hard Copy
+ HD, // Hemodynamic
+ LP, // Laparoscopy
+ LS, // Laser Surface Scan
+ MA, // Magnetic Resonance Angiography
+ MR, // Magnetic Resonance
+ NM, // Nuclear Medicine
+ OT, // Other
+ PT, // Positron Emission Tomography
+ RF, // Radio Fluoroscopy
+ RG, // Radiographic Imaging
+ RTDOSE, // Radiotherapy Dose
+ RTIMAGE, // Radiotherapy Image
+ RTPLAN, // Radiotherapy Plan
+ RTSTRUCT, // Radiotherapy Structure Set
+ SM, // Microscopic Imaging
+ ST, // Single-photon Emission Computed Tomography
+ TG, // Thermography
+ US, // Ultrasound
+ VF, // Videofluorography
+ XA, // X-Ray Angiography
+ XC // Photographic Imaging
+};
+//-----------------------------------------------------------------------------
+
+class GDCM_EXPORT gdcmHeader : public gdcmDocument
+{
+protected:
+ /// \brief In some cases (e.g. for some ACR-NEMA images) the Header Entry Element
+ /// Number of the 'Pixel Element' is *not* found at 0x0010. In order to
+ /// make things easier the parser shall store the proper value in
+ /// NumPixel to provide a unique access facility. See also the constructor
+ /// \ref gdcmHeader::gdcmHeader
+ uint16_t NumPixel;
+ /// \brief In some cases (e.g. for some ACR-NEMA images) the header entry for
+ /// the group of pixels is *not* found at 0x7fe0. In order to
+ /// make things easier the parser shall store the proper value in
+ /// GrPixel to provide a unique access facility. See also the constructor
+ /// \ref gdcmHeader::gdcmHeader
+ uint16_t GrPixel;
+
public:
gdcmHeader(bool exception_on_error = false);
- gdcmHeader(const char *filename,
- bool exception_on_error = false,
- bool enable_sequences = false);
-
+ gdcmHeader(std::string const & filename,
+ bool exception_on_error = false);
+
virtual ~gdcmHeader();
-// Standard values and informations contained in the header
- inline std::string GetFileName(void) {return filename;}
-
- bool IsReadable(void);
- bool IsImplicitVRLittleEndianTransferSyntax(void);
- bool IsExplicitVRLittleEndianTransferSyntax(void);
- bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void);
- bool IsExplicitVRBigEndianTransferSyntax(void);
- bool IsJPEGBaseLineProcess1TransferSyntax(void);
- bool IsJPEGExtendedProcess2_4TransferSyntax(void);
- bool IsJPEGExtendedProcess3_5TransferSyntax(void);
- bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void);
- bool IsRLELossLessTransferSyntax(void);
- bool IsJPEGLossless(void);
- bool IsJPEG2000(void);
- bool IsDicomV3(void);
- FileType GetFileType(void);
+ // Standard values and informations contained in the header
+ virtual bool IsReadable();
// Some heuristic based accessors, end user intended
- // (to be move to gdcmHeaderHelper?)
- int GetXSize(void);
- int GetYSize(void);
- int GetZSize(void);
- int GetBitsStored(void);
- int GetBitsAllocated(void);
- int GetSamplesPerPixel(void);
- int GetPlanarConfiguration(void);
-
- int GetPixelSize(void);
- std::string GetPixelType(void);
- size_t GetPixelOffset(void);
- size_t GetPixelAreaLength(void);
-
- bool HasLUT(void);
- int GetLUTNbits(void);
- unsigned char * GetLUTRGBA(void);
-
- std::string GetTransfertSyntaxName(void);
-
- // When some proprietary shadow groups are disclosed, we can set up
- // an additional specific dictionary to access extra information.
-
- // OK : we still have *ONE* ElValSet,
- // with both Public and Shadow Elements
- // parsed against THE Public Dictionary and A (single) Shadow Dictionary
-
- // TODO Swig int SetShaDict(std::string filename);
- // TODO Swig int SetPubDict(std::string filename);
-
-// Public element value
- std::string GetPubElValByName (std::string tagName);
- std::string GetPubElValRepByName (std::string tagName);
- std::string GetPubElValByNumber (guint16 group, guint16 element);
- std::string GetPubElValRepByNumber(guint16 group, guint16 element);
-
- bool SetPubElValByName (std::string content, std::string tagName);
- bool SetPubElValByNumber(std::string content, guint16 group, guint16 element);
- bool SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element);
+ int GetBitsStored();
+ int GetBitsAllocated();
+ int GetSamplesPerPixel();
+ int GetPlanarConfiguration();
+ int GetPixelSize();
- inline ListTag & GetPubListElem(void) { return PubElValSet.GetListElem();};
- inline TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); };
+ std::string GetPixelType();
+ size_t GetPixelOffset();
+ size_t GetPixelAreaLength();
- void PrintPubElVal(std::ostream & os = std::cout);
- void PrintPubDict (std::ostream & os = std::cout);
+ //Some image informations needed for third package imaging library
+ int GetXSize();
+ int GetYSize();
+ int GetZSize();
-// Element value
- std::string GetElValByName (std::string tagName);
- std::string GetElValRepByName (std::string tagName);
- std::string GetElValByNumber (guint16 group, guint16 element);
- std::string GetElValRepByNumber(guint16 group, guint16 element);
+ float GetXSpacing();
+ float GetYSpacing();
+ float GetZSpacing();
+ //void GetSpacing(float &x, float &y, float &z);
- bool SetElValueByName(std::string content,std::string tagName);
-// bool SetElValueByNumber(std::string content,guint16 group, guint16 element);
+ // Useful for rescaling graylevel:
+ float GetRescaleIntercept();
+ float GetRescaleSlope();
-// inline ListTag & GetListElem(void) { return PubElValSet.GetListElem();};
-// inline TagElValueHT & GetElVal(void) { return PubElValSet.GetTagHt(); };
+ int GetNumberOfScalarComponents();
+ int GetNumberOfScalarComponentsRaw();
-// Read (used in gdcmFile)
- FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError);
- bool CloseFile(void);
- virtual void ParseHeader(bool exception_on_error = false) throw(gdcmFormatError);
+ int GetImageNumber();
+ ModalityType GetModality();
-// Write (used in gdcmFile)
- bool Write(FILE *, FileType);
- void SetImageDataSize(size_t ExpectedSize);
+ float GetXOrigin();
+ float GetYOrigin();
+ float GetZOrigin();
+ //void GetOrigin(float &x, float &y, float &z);
-// System access
- inline int GetSwapCode(void) { return sw; }
- guint16 SwapShort(guint16); // needed by gdcmFile
- guint32 SwapLong(guint32); // for JPEG Files
-
- // was protected
- bool ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem);
- bool ReplaceOrCreateByNumber( char * Value, guint16 Group, guint16 Elem);
- bool ReplaceIfExistByNumber ( char * Value, guint16 Group, guint16 Elem);
+ bool HasLUT();
+ int GetLUTNbits();
+ unsigned char * GetLUTRGBA();
-protected:
- bool CheckIfExistByNumber(guint16 Group, guint16 Elem );
- gdcmElValue * GetElValueByNumber(guint16 group, guint16 element);
+ std::string GetTransfertSyntaxName();
- int write(std::ostream&);
- int anonymize(std::ostream&); // FIXME : anonymize should be a friend ?
+ /// Accessor to \ref gdcmHeader::GrPixel
+ uint16_t GetGrPixel() { return GrPixel; }
+
+ /// Accessor to \ref gdcmHeader::NumPixel
+ uint16_t GetNumPixel() { return NumPixel; }
- size_t GetPubElValOffsetByNumber (guint16 Group, guint16 Elem);
- void * GetPubElValVoidAreaByNumber(guint16 Group, guint16 Elem);
- void * LoadElementVoidArea (guint16 Group, guint16 Element);
+ /// Read (used in gdcmFile)
+ void SetImageDataSize(size_t expectedSize);
+ void Write(FILE* fp, FileType filetype);
+
+protected:
+ bool AnonymizeHeader();
+ void GetImageOrientationPatient( float iop[6] );
-// Variables
- FILE * fp;
- FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
-
private:
- // Read
- void LoadElements (void);
- void LoadElementValue (gdcmElValue *);
- void LoadElementValueSafe(gdcmElValue *);
- void FindLength (gdcmElValue *);
- void FindVR (gdcmElValue *);
-
- guint32 FindLengthOB(void);
-
- void SkipElementValue (gdcmElValue *);
- void FixFoundLength (gdcmElValue *, guint32);
- bool IsAnInteger (gdcmElValue *);
-
- guint16 ReadInt16(void);
- guint32 ReadInt32(void);
- void SkipBytes(guint32);
-
- void Initialise(void);
- void CheckSwap(void);
- void SwitchSwapToBigEndian(void);
- void SetMaxSizeLoadElementValue(long);
-
- // Dict
- gdcmDictEntry *GetDictEntryByName (std::string Name);
- gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
-
- // ElValue related utilities
- gdcmElValue *ReadNextElement (void);
- gdcmElValue *NewElValueByNumber(guint16 group, guint16 element);
- gdcmElValue *NewElValueByName (std::string Name);
- gdcmElValue* GetElementByName (std::string Name);
-
- // Deprecated
- gdcmElValue *NewManualElValToPubDict(std::string NewTagName,
- std::string VR);
-
-// Variables
- // Pointer to the Value Representation Hash Table which contains all
- // the VR of the DICOM version3 public dictionary.
- gdcmVR *dicom_vr; // Not a class member for thread-safety reasons
-
- // Pointer to the Transfert Syntax Hash Table which contains all
- // the TS of the DICOM version3 public dictionary.
- gdcmTS *dicom_ts; // Not a class member for thread-safety reasons
-
- // Pointer to global dictionary container
- gdcmDictSet *Dicts; // Not a class member for thread-safety reasons
-
- // Public dictionary used to parse this header
- gdcmDict *RefPubDict;
-
- // Optional "shadow dictionary" (private elements) used to parse this
- // header
- gdcmDict *RefShaDict;
-
- /// ELement VALueS parsed with the PUBlic dictionary.
- gdcmElValSet PubElValSet;
-
- // Refering underlying filename.
- std::string filename;
-
- int enableSequences;
-
- // FIXME sw should be an enum e.g.
- //enum EndianType {
- //LittleEndian,
- //BadLittleEndian,
- //BigEndian,
- //BadBigEndian};
- // Swap code e.g. little, big, bad-big, bad-little endian). Warning:
- // this code is not fixed during header parsing.
- int sw;
-
- // Size treshold above which an element value will NOT be loaded in
- // memory (to avoid loading the image/volume itself). By default,
- // this upper bound is fixed to 1024 bytes (which might look reasonable
- // when one considers the definition of the various VR contents).
- guint32 MaxSizeLoadElementValue;
-
- static const unsigned int HEADER_LENGTH_TO_READ;
- static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
+ friend class gdcmSerieHeader;
};
//-----------------------------------------------------------------------------
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff