-// gdcmFile.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmFile.h,v $
+ Language: C++
+ Date: $Date: 2004/06/23 16:22:21 $
+ Version: $Revision: 1.35 $
+
+ 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 GDCMFILE_H
#define GDCMFILE_H
{
public:
gdcmFile(gdcmHeader *header);
- gdcmFile(std::string & filename);
- gdcmFile(const char * filename);
- virtual ~gdcmFile(void);
+ gdcmFile(std::string const & filename,
+ bool exception_on_error = false,
+ bool enable_sequences = false,
+ bool skip_shadow = false);
+
+ virtual ~gdcmFile();
- gdcmHeader *GetHeader(void);
+ /// \brief returns the gdcmHeader *Header
+ inline gdcmHeader *GetHeader() { return Header;};
- // For promotion (performs a deepcopy of pointed header object)
- // TODO Swig gdcmFile(gdcmHeader* header);
- // TODO Swig ~gdcmFile();
+ // For promotion (performs a deepcopy of pointed header object)
+ // TODO Swig gdcmFile(gdcmHeader* header);
+ // TODO Swig ~gdcmFile();
- // On writing purposes. When instance was created through
- // gdcmFile(std::string filename) then the filename argument MUST be
+ // On writing purposes. When instance was created through
+ // gdcmFile(std::string filename) then the filename argument MUST be
// different from the constructor's one (no overwriting allowed).
- // TODO Swig int SetFileName(std::string filename);
+ // TODO Swig int SetFileName(std::string filename);
- void SetPixelDataSizeFromHeader(void);
+ void SetPixelDataSizeFromHeader();
size_t GetImageDataSize();
size_t GetImageDataSizeRaw();
size_t GetImageDataIntoVector(void* destination, size_t MaxSize);
void * GetImageDataRaw();
size_t GetImageDataIntoVectorRaw(void* destination, size_t MaxSize);
-
+
// Allocates ExpectedSize bytes of memory at this->Data and copies the
// pointed data to it. Copying the image might look useless but
// the caller might destroy it's image (without knowing it: think
bool SetImageData (void * Data, size_t ExpectedSize);
// When the caller is aware we simply point to the data:
// TODO int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
-
- // Push to disk.
- // A NE PAS OUBLIER : que fait-on en cas de Transfert Syntax (dans l'entete)
- // incohérente avec l'ordre des octets en mémoire ?
- // TODO Swig int Write();
-
+
+ // Push to disk.
+ // TODO Swig int Write();
+
// 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 fileName);
- bool WriteDcmImplVR(std::string fileName);
- bool WriteDcmImplVR(const char * fileName);
- bool WriteDcmExplVR(std::string fileName);
- bool WriteAcr (std::string fileName);
-
- // Body in file gdcmParse.cxx
- bool ParsePixelData(void);
+ bool WriteRawData (std::string const & fileName);
+ bool WriteDcmImplVR(std::string const & fileName);
+ bool WriteDcmExplVR(std::string const & fileName);
+ bool WriteAcr (std::string const & fileName);
+
+ // Don't look any longer for the code :
+ // It's in file gdcmParsePixels.cxx
+ bool ParsePixelData();
+
+ inline virtual bool SetEntryByNumber(std::string const & content,
+ guint16 group, guint16 element)
+ {
+ GetHeader()->SetEntryByNumber(content,group,element);
+ return true; //default behavior ?
+ }
+
protected:
- bool WriteBase(std::string FileName, FileType type);
+ bool WriteBase(std::string const & FileName, FileType type);
private:
void SwapZone(void* im, int swap, int lgr, int nb);
bool gdcm_read_RLE_file (FILE *fp,void * image_buffer);
// Variables
- /// Header to use to load the file
- gdcmHeader *Header;
+
+ /// \brief Header to use to load the file
+ gdcmHeader *Header;
+
+ /// \brief Whether the underlying \ref gdcmHeader was loaded by
+ /// the constructor or passed to the constructor. When false
+ /// the destructor is in charge of deletion.
bool SelfHeader;
+ /// \brief to hold the Pixels (when read)
void* PixelData;
- /// Area length to receive the pixels
+ /// \brief Area length to receive the pixels
size_t lgrTotaleRaw;
- /// Area length to receive the RGB pixels
+ /// \brief Area length to receive the RGB pixels
/// from Grey Plane + Palette Color
size_t lgrTotale;
- /// ==1 if GetImageDataRaw was used
- /// ==0 if GetImageData was used
- /// ==-1 if ImageData never read
+ /// \brief ==1 if GetImageDataRaw was used
+ /// ==0 if GetImageData was used
+ /// ==-1 if ImageData never read
int PixelRead;
- /// weather already parsed
+ /// wether already parsed
int Parsed;
/// To avoid file overwrite