Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2005/01/07 08:46:18 $
- Version: $Revision: 1.76 $
+ Date: $Date: 2005/06/02 13:42:18 $
+ Version: $Revision: 1.111 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "gdcmVR.h"
#include "gdcmDict.h"
#include "gdcmElementSet.h"
+#include "gdcmException.h"
#include <map>
#include <list>
#include <fstream>
+#define NO_SEQ 0x0000001
+#define NO_SHADOW 0x00000002
+
namespace gdcm
{
class ValEntry;
class BinEntry;
class SeqEntry;
class Dict;
-class RLEFramesInfo;
-class JPEGFragmentsInfo;
-
-enum TransferSyntaxType {
- ImplicitVRLittleEndian = 0,
- ImplicitVRLittleEndianDLXGE,
- ExplicitVRLittleEndian,
- DeflatedExplicitVRLittleEndian,
- ExplicitVRBigEndian,
- JPEGBaselineProcess1,
- JPEGExtendedProcess2_4,
- JPEGExtendedProcess3_5,
- JPEGSpectralSelectionProcess6_8,
- JPEGFullProgressionProcess10_12,
- JPEGLosslessProcess14,
- JPEGLosslessProcess14_1,
- JPEG2000Lossless,
- JPEG2000,
- RLELossless,
- UnknownTS
-};
//-----------------------------------------------------------------------------
/**
- * \brief Derived by both Header and DicomDir
+ * \brief Derived by both gdcm::File and gdcm::DicomDir
*/
class GDCM_EXPORT Document : public ElementSet
{
public:
-// Informations contained in the parser
- virtual bool IsReadable();
- FileType GetFileType();
-
- TransferSyntaxType GetTransferSyntax();
- bool IsJPEGLossless();
- bool IsJPEG2000();
- bool IsJPEG();
- bool IsEncapsulate();
- bool IsDicomV3();
+typedef std::list<Element> ListElements;
- RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
- JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
+// Loading
+ virtual bool Load( std::string const &filename );
-// Dictionnaries
- virtual void PrintPubDict (std::ostream &os = std::cout);
- virtual void PrintShaDict (std::ostream &os = std::cout);
-
- Dict* GetPubDict();
- Dict* GetShaDict();
- bool SetShaDict(Dict* dict);
+// Dictionaries
+ Dict *GetPubDict();
+ Dict *GetShaDict();
+ bool SetShaDict(Dict *dict);
bool SetShaDict(DictKey const &dictName);
+// Informations contained in the gdcm::Document
+ virtual bool IsReadable();
+ bool IsDicomV3();
+ bool IsPapyrus();
+ FileType GetFileType();
+ std::string GetTransferSyntax();
+ /// Return the Transfer Syntax as a string
+ std::string GetTransferSyntaxName();
+
// Swap code
/// 'Swap code' accessor (see \ref SwapCode )
int GetSwapCode() { return SwapCode; }
// System access (meaning endian related !?)
- uint16_t SwapShort(uint16_t); // needed by File
- uint32_t SwapLong(uint32_t); // needed by File
- uint16_t UnswapShort(uint16_t); // needed by File
- uint32_t UnswapLong(uint32_t); // needed by File
+ uint16_t SwapShort(uint16_t);
+ uint32_t SwapLong(uint32_t);
+ /// \brief Unswaps back the bytes of 2-bytes long integer
+ /// so they agree with the processor order.
+ uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
+ /// \brief Unswaps back the bytes of 4-byte long integer
+ /// so they agree with the processor order.
+ uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
-// Ordering of Documents
- bool operator<(Document &document);
-
-public:
// File I/O
/// Accessor to \ref Filename
const std::string &GetFileName() const { return Filename; }
void WriteContent( std::ofstream *fp, FileType type );
// Content entries
-
- virtual bool SetEntryByNumber(std::string const &content,
- uint16_t group, uint16_t element);
- virtual bool SetEntryByNumber(uint8_t *content, int lgth,
- uint16_t group, uint16_t element);
- virtual bool SetEntry(std::string const &content,ValEntry *entry);
- virtual bool SetEntry(uint8_t *content, int lgth,BinEntry *entry);
-
- virtual void *GetEntryBinAreaByNumber(uint16_t group, uint16_t elem);
-
- virtual std::string GetEntryByNumber (uint16_t group, uint16_t elem);
- virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
- virtual int GetEntryLengthByNumber(uint16_t group, uint16_t elem);
-
- DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
- ValEntry *GetValEntryByNumber(uint16_t group, uint16_t element);
- BinEntry *GetBinEntryByNumber(uint16_t group, uint16_t element);
-
- ValEntry *ReplaceOrCreateByNumber(std::string const &value,
- uint16_t group, uint16_t elem,
- TagName const &vr = GDCM_UNKNOWN);
- BinEntry *ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
- uint16_t group, uint16_t elem,
- TagName const &vr = GDCM_UNKNOWN);
- SeqEntry *ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
-
- bool ReplaceIfExistByNumber ( std::string const &value,
- uint16_t group, uint16_t elem );
-
virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
virtual void LoadEntryBinArea(BinEntry *entry);
void LoadDocEntrySafe(DocEntry *entry);
- TagDocEntryHT *BuildFlatHashTable();
-
-// Divers
- static std::string GetTransferSyntaxValue(TransferSyntaxType type);
+
+// Ordering of Documents
+ bool operator<(Document &document);
+
+/**
+ * \brief \brief Sets the LoadMode as a boolean string.
+ * NO_SEQ, NO_SHADOW, ... (nothing more, right now)
+ * WARNING : before using NO_SHADOW, be sure *all* your files
+ * contain accurate values in the 0x0000 element
+ * of each Shadow Group. The paser will fail if the size is wrong !
+ * @param mode Load mode to be used
+ */
+ void SetLoadMode (int mode) { LoadMode = mode; }
protected:
// Methods
// Constructor and destructor are protected to forbid end user
- // to instanciate from this class Document (only Header and
- // DicomDir are meaningfull).
+ // to instanciate from this class Document (only gdcm::File and
+ // gdcm::DicomDir are meaningfull).
Document();
Document( std::string const &filename );
virtual ~Document();
- void ReadAndSkipEncapsulatedBasicOffsetTable();
- void ComputeRLEInfo();
- void ComputeJPEGFragmentInfo();
- // Entry
- bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
-
+ uint16_t ReadInt16() throw ( FormatError );
+ uint32_t ReadInt32() throw ( FormatError );
+ void SkipBytes(uint32_t);
int ComputeGroup0002Length( FileType filetype );
// Variables
/// Refering underlying filename.
std::string Filename;
- /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian,
- /// Bad Little Endian) according to the processor Endianity and
- /// what is written on disc.
+ /// \brief Swap code gives an information on the byte order of a
+ /// supposed to be an int32, as it's read on disc
+ /// (depending on the image Transfer Syntax *and* on the processor endianess)
+ /// as opposed as it should in memory to be dealt as an int32.
+ /// For instance :
+ /// - a 'Little Endian' image, read with a little endian processor
+ /// will have a SwapCode= 1234 (the order is OK; nothing to do)
+ /// - a 'Little Endian' image, read with a big endian procesor
+ /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
+ /// swapped)
+ /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
+ /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
int SwapCode;
- /// File Pointer, opened during Header parsing.
+ ///\brief whether we already parsed group 0002 (Meta Elements)
+ bool Group0002Parsed;
+
+ ///\brief whether file has a DCM Preamble
+ bool HasDCMPreamble;
+
+ /// File Pointer, opened during Document parsing.
std::ifstream *Fp;
/// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
/// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
static const unsigned int HEADER_LENGTH_TO_READ;
-
/// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
/// are NOT loaded.
static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
- /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE
- /// are NOT printed.
- /// \todo Currently not used since collides with #define in
- /// class DocEntry . See also
- /// method ref Document::SetMaxSizePrintEntry()
- static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
-
- /// Store the RLE frames info obtained during parsing of pixels.
- RLEFramesInfo *RLEInfo;
+ /// List of elements to Anonymize
+ ListElements AnonymizeList;
- /// Store the JPEG fragments info obtained during parsing of pixels.
- JPEGFragmentsInfo *JPEGInfo;
+ /// \brief Bit string integer (each one considered as a boolean)
+ /// Bit 0 : Skip Sequences, if possible
+ /// Bit 1 : Skip Shadow Groups if possible
+ /// Some more to add
+ int LoadMode;
+
+ /// Whether the gdcm::Document is already parsed/loaded
+ /// - False from the creation of the gdcm::Document untill
+ /// gdcm::Document:Load()
+ bool IsDocumentAlreadyLoaded;
private:
// Methods
+ void Initialize();
+
// Read
- void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
- void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
+ void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
+ void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
void LoadDocEntry (DocEntry *e);
void FindDocEntryLength (DocEntry *e) throw ( FormatError );
+ uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
std::string FindDocEntryVR();
bool CheckDocEntryVR (VRKey k);
- std::string GetDocEntryValue (DocEntry *e);
- std::string GetDocEntryUnvalue(DocEntry *e);
+ std::string GetDocEntryValue (DocEntry *entry);
+ std::string GetDocEntryUnvalue(DocEntry *entry);
+ void SkipDocEntry (DocEntry *entry);
+ void SkipToNextDocEntry (DocEntry *entry);
- void SkipDocEntry (DocEntry *e);
- void SkipToNextDocEntry (long offset,long readLgth);
+ void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
+ bool IsDocEntryAnInteger (DocEntry *entry);
- void FixDocEntryFoundLength(DocEntry *e, uint32_t l);
- bool IsDocEntryAnInteger (DocEntry *e);
-
- uint32_t FindDocEntryLengthOB() throw( FormatUnexpected );
-
- uint16_t ReadInt16() throw ( FormatError );
- uint32_t ReadInt32() throw ( FormatError );
- void SkipBytes(uint32_t);
- bool ReadTag(uint16_t, uint16_t);
- uint32_t ReadTagLength(uint16_t, uint16_t);
-
- void Initialise();
bool CheckSwap();
- void SwitchSwapToBigEndian();
+ void SwitchByteSwapCode();
void SetMaxSizeLoadEntry(long);
- void SetMaxSizePrintEntry(long);
// DocEntry related utilities
DocEntry *ReadNextDocEntry();
- uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
- void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
- DocEntrySet* set );
-
- void HandleBrokenEndian(uint16_t group, uint16_t elem);
+ void HandleBrokenEndian (uint16_t &group, uint16_t &elem);
+ void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
// Variables
/// Public dictionary used to parse this header
Dict *RefPubDict;
-
/// \brief Optional "shadow dictionary" (private elements) used to parse
/// this header
Dict *RefShaDict;
/// when one considers the definition of the various VR contents).
uint32_t MaxSizeLoadEntry;
- /// \brief Size threshold above which an element value will NOT be *printed*
- /// in order no to polute the screen output. By default, this upper bound
- /// is fixed to 64 bytes.
- uint32_t MaxSizePrintEntry;
+// uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
+// DocEntrySet *set );
-private:
- friend class File;
};
+
} // end namespace gdcm
//-----------------------------------------------------------------------------
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff