-// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.42 2003/11/10 09:21:40 jpr Exp $
+// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.47 2004/01/13 11:32:30 jpr Exp $
#ifndef GDCMHEADER_H
#define GDCMHEADER_H
typedef std::string VRAtr;
typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
-/// 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
-/// of a DICOM file.
-///
-/// 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
-/// 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
-/// instances.
-/// \note The gdcmHeader::Set*Tag* family members cannot be defined as
-/// protected due to Swig limitations for as Has_a dependency between
-/// gdcmFile and gdcmHeader.
-
+/*
+ * 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
+ * of a DICOM file.
+ *
+ * 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
+ * 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
+ * instances.
+ * \note The gdcmHeader::Set*Tag* family members cannot be defined as
+ * protected due to Swig limitations for as Has_a dependency between
+ * gdcmFile and gdcmHeader.
+ */
class GDCM_EXPORT gdcmHeader {
- void SkipBytes(guint32);
private:
/// 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;
- /// 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
/// ELement VALueS parsed with the PUBlic dictionary.
gdcmElValSet PubElValSet;
- /// ELement VALueS parsed with the SHAdow dictionary.
- gdcmElValSet ShaElValSet;
+
/// Refering underlying filename.
std::string filename;
-
+
+ int enableSequences;
+
// FIXME sw should be an enum e.g.
//enum EndianType {
//LittleEndian,
void CheckSwap(void);
void SwitchSwapToBigEndian(void);
// CLEAN ME: NewManualElValToPubDict is NOT called any more.
- gdcmElValue* NewManualElValToPubDict(std::string NewTagName,
+ gdcmElValue *NewManualElValToPubDict(std::string NewTagName,
std::string VR);
void SetMaxSizeLoadElementValue(long);
- gdcmDictEntry * GetDictEntryByNumber(guint16, guint16);
- gdcmDictEntry * GetDictEntryByName(std::string Name);
+ gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
+ gdcmDictEntry *GetDictEntryByName (std::string Name);
// ElValue related utilities
- gdcmElValue * ReadNextElement(void);
- gdcmElValue * NewElValueByNumber(guint16 group, guint16 element);
- gdcmElValue * NewElValueByName(std::string Name);
+ gdcmElValue *ReadNextElement(void);
+ gdcmElValue *NewElValueByNumber(guint16 group, guint16 element);
+ gdcmElValue *NewElValueByName (std::string Name);
+
+ gdcmElValue* GetElementByName (std::string Name);
+ // moved from gdcmElValSet
- void FindLength(gdcmElValue *);
- void FindVR(gdcmElValue *);
- void LoadElementValue(gdcmElValue *);
+ void FindLength (gdcmElValue *);
+ void FindVR (gdcmElValue *);
+ void LoadElementValue (gdcmElValue *);
void LoadElementValueSafe(gdcmElValue *);
- void SkipElementValue(gdcmElValue *);
- void FixFoundLength(gdcmElValue*, guint32);
- bool IsAnInteger(gdcmElValue *);
+ void SkipElementValue (gdcmElValue *);
+ void FixFoundLength (gdcmElValue *, guint32);
+ bool IsAnInteger (gdcmElValue *);
void LoadElements(void);
-
+ void SkipBytes(guint32);
+
protected:
FILE * fp;
- FileType filetype;
+ FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
gdcmElValue * GetElValueByNumber(guint16 group, guint16 element);
- int CheckIfExistByNumber(guint16 Group, guint16 Elem );
+ bool CheckIfExistByNumber(guint16 Group, guint16 Elem );
- guint16 SwapShort(guint16); // needed by gdcmFile
- guint32 SwapLong(guint32); // for JPEG Files :-(
- bool OpenFile(bool exception_on_error = false)
- throw(gdcmFileError);
- bool CloseFile(void);
int write(std::ostream&);
int anonymize(std::ostream&); // FIXME : anonymize should be a friend ?
+
public:
+ FILE *OpenFile(bool exception_on_error = false)
+ throw(gdcmFileError);
+ bool CloseFile(void);
+ FileType GetFileType(void);
+
bool IsReadable(void);
bool IsImplicitVRLittleEndianTransferSyntax(void);
bool IsExplicitVRLittleEndianTransferSyntax(void);
virtual void ParseHeader(bool exception_on_error = false)
throw(gdcmFormatError);
- gdcmHeader(const char *filename, bool exception_on_error = false);
- gdcmHeader( bool exception_on_error = false);
+
+ gdcmHeader(bool exception_on_error = false);
+ gdcmHeader(const char *filename,
+ bool exception_on_error = false,
+ bool enable_sequences = false);
+
virtual ~gdcmHeader();
- std::string GetFileName(void) {return filename;}
+ inline std::string GetFileName(void) {return filename;}
size_t GetPixelOffset(void);
size_t GetPixelAreaLength(void);
- int GetSwapCode(void) { return sw; }
-
- // TODO Swig int SetPubDict(std::string filename);
+ inline int GetSwapCode(void) { return sw; }
+
// 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);
- std::string GetPubElValByName (std::string TagName);
- std::string GetPubElValRepByName (std::string TagName);
+ 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);
- size_t GetPubElValOffsetByNumber(guint16 Group, guint16 Elem);
+ size_t GetPubElValOffsetByNumber (guint16 Group, guint16 Elem);
void * GetPubElValVoidAreaByNumber(guint16 Group, guint16 Elem);
- void * LoadElementVoidArea(guint16 Group, guint16 Element);
+ void * LoadElementVoidArea (guint16 Group, guint16 Element);
+
+ inline ListTag & GetListElem(void) { return PubElValSet.GetListElem();};
+ inline TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); };
- ListTag & GetListElem(void) { return PubElValSet.GetListElem(); };
-
- TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); };
void PrintPubElVal(std::ostream & os = std::cout);
void PrintPubDict (std::ostream & os = std::cout);
-
- // TODO Swig std::string* GetShaTagNames();
- std::string GetShaElValByName (std::string TagName);
- std::string GetShaElValRepByName (std::string TagName);
- std::string GetShaElValByNumber (guint16 group, guint16 element);
- std::string GetShaElValRepByNumber(guint16 group, guint16 element);
-
- 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);
-
- int SetPubElValByName (std::string content, std::string TagName);
- int SetShaElValByName (std::string content, std::string ShadowTagName);
-
- int SetPubElValByNumber(std::string content, guint16 group, guint16 element);
- int SetShaElValByNumber(std::string content, guint16 group, guint16 element);
-
- int SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element);
- int ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem);
- int ReplaceOrCreateByNumber( char * Value, guint16 Group, guint16 Elem);
- int ReplaceIfExistByNumber ( char * Value, guint16 Group, guint16 Elem);
+ 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);
+
+ 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);
+
+ bool SetElValueByName(std::string content,std::string tagName);
+ // moved from ElValSet
+
+ 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);
- int Write(FILE *, FileType);
+ bool Write(FILE *, FileType);
// 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 GetSamplesPerPixel(void);
int GetPlanarConfiguration(void);
-
- int GetPixelSize(void);
+ int GetPixelSize(void);
+
std::string GetPixelType(void);
std::string GetTransferSyntaxName(void);
- int HasLUT(void);
+ bool HasLUT(void);
int GetLUTNbits(void);
- void * GetLUTRGBA(void);
-
+ unsigned char * GetLUTRGBA(void);
+
+ // voir gdcmFile::SetImageData ?!?
+ void SetImageDataSize (size_t ExpectedSize);
+// System access
+ guint16 SwapShort(guint16); // needed by gdcmFile
+ guint32 SwapLong(guint32); // for JPEG Files
};
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff