Program: gdcm
Module: $RCSfile: gdcmFileHelper.h,v $
Language: C++
- Date: $Date: 2005/01/20 16:22:52 $
- Version: $Revision: 1.1 $
+ Date: $Date: 2005/02/06 14:39:35 $
+ Version: $Revision: 1.11 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
=========================================================================*/
-#ifndef GDCMFILE_H
-#define GDCMFILE_H
+#ifndef GDCMFILEHELPER_H
+#define GDCMFILEHELPER_H
#include <iostream>
#include "gdcmBase.h"
namespace gdcm
{
-class Header;
+class File;
class ValEntry;
class BinEntry;
+class SeqEntry;
class PixelReadConvert;
class PixelWriteConvert;
class DocEntryArchive;
//-----------------------------------------------------------------------------
/**
- * \brief In addition to Dicom Header exploration, this class is designed
+ * \brief In addition to Dicom header exploration, this class is designed
* for accessing the image/volume content. One can also use it to
* write Dicom/ACR-NEMA/RAW files.
*/
public:
FileHelper( );
- FileHelper( Header *header );
+ FileHelper( File *header );
FileHelper( std::string const &filename );
virtual ~FileHelper();
- void Print(std::ostream &os = std::cout, std::string const & indent = "");
+ void Print(std::ostream &os = std::cout, std::string const &indent = "");
- /// Accessor to \ref Header
- Header *GetHeader() { return HeaderInternal; }
+ /// Accessor to \ref File
+ File *GetFile() { return FileInternal; }
+ // File methods
+ bool SetValEntry(std::string const &content,
+ uint16_t group, uint16_t elem);
+ bool SetBinEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem);
+
+ ValEntry *InsertValEntry(std::string const &content,
+ uint16_t group, uint16_t elem);
+ BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t elem);
+ SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
+
+ // File helpers
size_t GetImageDataSize();
size_t GetImageDataRawSize();
void SetImageData(uint8_t *data, size_t expectedSize);
- // User datas
+ // User data
void SetUserData(uint8_t *data, size_t expectedSize);
- uint8_t* GetUserData();
+ uint8_t *GetUserData();
size_t GetUserDataSize();
- // RBG datas (from file
- uint8_t* GetRGBData();
+ // RBG data (from file)
+ uint8_t *GetRGBData();
size_t GetRGBDataSize();
- // RAW datas (from file
- uint8_t* GetRawData();
+ // RAW data (from file)
+ uint8_t *GetRawData();
size_t GetRawDataSize();
- // Write pixels of ONE image on hard drive
- // No test is made on processor "endianity"
- // The user must call his reader correctly
- bool WriteRawData (std::string const &fileName);
- bool WriteDcmImplVR(std::string const &fileName);
- bool WriteDcmExplVR(std::string const &fileName);
- bool WriteAcr (std::string const &fileName);
- bool Write (std::string const &fileName);
-
- bool SetEntry(std::string const &content,
- uint16_t group, uint16_t elem);
- bool SetEntry(uint8_t *content, int lgth,
- uint16_t group, uint16_t elem);
- bool ReplaceOrCreate(std::string const &content,
- uint16_t group, uint16_t elem);
- bool ReplaceOrCreate(uint8_t *binArea, int lgth,
- uint16_t group, uint16_t elem);
-
+ // LUT
uint8_t* GetLutRGBA();
// Write mode
- void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
- void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
- void SetWriteMode(FileMode mode) { WriteMode = mode; };
- FileMode GetWriteMode() { return WriteMode; };
+
+ /// \brief Tells the writer we want to write a Raw File (no header)
+ void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
+ /// \brief Tells the writer we want to write RGB image when possible
+ /// (as opposite to 'Grey pixels + Palettes color')
+ void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
+ /// \brief Sets the Write Mode ( )
+ void SetWriteMode(FileMode mode) { WriteMode = mode; };
+ /// \brief Gets the Write Mode ( )
+ FileMode GetWriteMode() { return WriteMode; };
// Write format
+
+ /// \brief Tells the writer we want to write as Implicit VR
void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); };
+ /// \brief Tells the writer we want to write as Explicit VR
void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); };
- void SetWriteTypeToAcr() { SetWriteType(ACR); };
+ /// \brief Tells the writer we want to write as ACR-NEMA
+ void SetWriteTypeToAcr() { SetWriteType(ACR); };
+ /// \brief Tells the writer we want to write as LibIDO
void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); };
- void SetWriteType(FileType format) { WriteType = format; };
- FileType GetWriteType() { return WriteType; };
+ /// \brief Tells the writer which format want to write
+ /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+ void SetWriteType(FileType format) { WriteType = format; };
+ /// \brief Gets the format we want to write
+ /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+ FileType GetWriteType() { return WriteType; };
+
+ // Write pixels of ONE image on hard drive
+ // No test is made on processor "endianness"
+ // The user must call his reader correctly
+ bool WriteRawData (std::string const &fileName);
+ bool WriteDcmImplVR(std::string const &fileName);
+ bool WriteDcmExplVR(std::string const &fileName);
+ bool WriteAcr (std::string const &fileName);
+ bool Write (std::string const &fileName);
protected:
bool CheckWriteIntegrity();
void SetWriteToNoLibido();
void RestoreWriteOfLibido();
- ValEntry *CopyValEntry(uint16_t group,uint16_t elem);
- BinEntry *CopyBinEntry(uint16_t group,uint16_t elem);
+ ValEntry *CopyValEntry(uint16_t group, uint16_t elem);
+ BinEntry *CopyBinEntry(uint16_t group, uint16_t elem);
private:
- void Initialise();
+ void Initialize();
uint8_t *GetRaw();
// members variables:
- /// Header to use to load the file
- Header *HeaderInternal;
+ /// gdcm::File to use to load the file
+ File *FileInternal;
- /// \brief Whether the underlying \ref Header was loaded by
+ /// \brief Whether the underlying \ref gdcm::File was loaded by
/// the constructor or passed to the constructor. When false
/// the destructor is in charge of deletion.
bool SelfHeader;
/// Wether already parsed or not
bool Parsed;
- /// Utility pixel converter
+ // Utility pixel converter
+ /// \brief Pointer to the PixelReadConverter
PixelReadConvert *PixelReadConverter;
+ /// \brief Pointer to the PixelWriteConverter
PixelWriteConvert *PixelWriteConverter;
// Utility header archive
+ /// \brief Pointer to the DocEntryArchive (used while writting process)
DocEntryArchive *Archive;
// Write variables
+ /// \brief (WMODE_RAW, WMODE_RGB)
FileMode WriteMode;
+ /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
FileType WriteType;
};
} // end namespace gdcm
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff