]> Creatis software - gdcm.git/blobdiff - src/gdcmFileHelper.cxx
- Add construct and destructor to class gdcm::Debug to close the debug file
[gdcm.git] / src / gdcmFileHelper.cxx
index cec029642f569a7e365e50325ed3e5d49c4782d1..a1cfd210b9f1a45ec058f9f9efce5cb1fd65acd7 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFileHelper.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/20 16:22:52 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2005/01/26 16:28:58 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -23,7 +23,9 @@
 #include "gdcmDebug.h"
 #include "gdcmUtil.h"
 #include "gdcmBinEntry.h"
-#include "gdcmHeader.h"
+#include "gdcmValEntry.h"
+#include "gdcmContentEntry.h"
+#include "gdcmFile.h"
 #include "gdcmPixelReadConvert.h"
 #include "gdcmPixelWriteConvert.h"
 #include "gdcmDocEntryArchive.h"
@@ -38,11 +40,10 @@ typedef std::pair<TagDocEntryHT::iterator,TagDocEntryHT::iterator> IterHT;
 // Constructor / Destructor
 /**
  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- *        file (Header only deals with the ... header)
+ *        file (gdcm::File only deals with the ... header)
  *        Opens (in read only and when possible) an existing file and checks
  *        for DICOM compliance. Returns NULL on failure.
  *        It will be up to the user to load the pixels into memory
- *        (see GetImageData, GetImageDataRaw)
  * \note  the in-memory representation of all available tags found in
  *        the DICOM header is post-poned to first header information access.
  *        This avoid a double parsing of public part of the header when
@@ -51,18 +52,17 @@ typedef std::pair<TagDocEntryHT::iterator,TagDocEntryHT::iterator> IterHT;
  */
 FileHelper::FileHelper( )
 {
-   HeaderInternal = new Header( );
+   FileInternal = new File( );
    SelfHeader = true;
-   Initialise();
+   Initialize();
 }
 
 /**
  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- *        file (Header only deals with the ... header)
+ *        file (File only deals with the ... header)
  *        Opens (in read only and when possible) an existing file and checks
  *        for DICOM compliance. Returns NULL on failure.
  *        It will be up to the user to load the pixels into memory
- *        (see GetImageData, GetImageDataRaw)
  * \note  the in-memory representation of all available tags found in
  *        the DICOM header is post-poned to first header information access.
  *        This avoid a double parsing of public part of the header when
@@ -70,20 +70,19 @@ FileHelper::FileHelper( )
  *        seen as a side effect).   
  * @param header already built Header
  */
-FileHelper::FileHelper(Header *header)
+FileHelper::FileHelper(File *header)
 {
-   HeaderInternal = header;
+   FileInternal = header;
    SelfHeader = false;
-   Initialise();
+   Initialize();
 }
 
 /**
  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- *        file (Header only deals with the ... header)
+ *        file (gdcm::File only deals with the ... header)
  *        Opens (in read only and when possible) an existing file and checks
  *        for DICOM compliance. Returns NULL on failure.
  *        It will be up to the user to load the pixels into memory
- *        (see GetImageData, GetImageDataRaw)
  * \note  the in-memory representation of all available tags found in
  *        the DICOM header is post-poned to first header information access.
  *        This avoid a double parsing of public part of the header when
@@ -93,9 +92,9 @@ FileHelper::FileHelper(Header *header)
  */
 FileHelper::FileHelper(std::string const & filename )
 {
-   HeaderInternal = new Header( filename );
+   FileInternal = new File( filename );
    SelfHeader = true;
-   Initialise();
+   Initialize();
 }
 
 /**
@@ -120,17 +119,17 @@ FileHelper::~FileHelper()
 
    if( SelfHeader )
    {
-      delete HeaderInternal;
+      delete FileInternal;
    }
-   HeaderInternal = 0;
+   FileInternal = 0;
 }
 
 //-----------------------------------------------------------------------------
 // Print
 void FileHelper::Print(std::ostream &os, std::string const &)
 {
-   HeaderInternal->SetPrintLevel(PrintLevel);
-   HeaderInternal->Print(os);
+   FileInternal->SetPrintLevel(PrintLevel);
+   FileInternal->Print(os);
 
    PixelReadConverter->SetPrintLevel(PrintLevel);
    PixelReadConverter->Print(os);
@@ -196,7 +195,7 @@ uint8_t *FileHelper::GetImageData()
       return 0;
    }
 
-   if ( HeaderInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
+   if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
    {
       return PixelReadConverter->GetRGB();
    }
@@ -254,7 +253,7 @@ size_t FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
       return 0;
    }
 
-   if ( HeaderInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
+   if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
    {
       if ( PixelReadConverter->GetRGBSize() > maxSize )
       {
@@ -285,7 +284,7 @@ size_t FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
  *          'image' Pixels are presented as C-like 2D arrays : line per line.
  *          'volume'Pixels are presented as C-like 3D arrays : plane per plane 
  * \warning Since the pixels are not copied, it is the caller's responsability
- *          not to deallocate it's data before gdcm uses them (e.g. with
+ *          not to deallocate its data before gdcm uses them (e.g. with
  *          the Write() method.
  * @param inData user supplied pixel area
  * @param expectedSize total image size, in Bytes
@@ -298,8 +297,8 @@ void FileHelper::SetImageData(uint8_t *inData, size_t expectedSize)
 }
 
 /**
- * \brief   Set the image datas defined by the user
- * \warning When writting the file, this datas are get as default datas to write
+ * \brief   Set the image data defined by the user
+ * \warning When writting the file, this data are get as default data to write
  */
 void FileHelper::SetUserData(uint8_t *data, size_t expectedSize)
 {
@@ -307,8 +306,8 @@ void FileHelper::SetUserData(uint8_t *data, size_t expectedSize)
 }
 
 /**
- * \brief   Get the image datas defined by the user
- * \warning When writting the file, this datas are get as default data to write
+ * \brief   Get the image data defined by the user
+ * \warning When writting the file, this data are get as default data to write
  */
 uint8_t *FileHelper::GetUserData()
 {
@@ -317,7 +316,7 @@ uint8_t *FileHelper::GetUserData()
 
 /**
  * \brief   Get the image data size defined by the user
- * \warning When writting the file, this datas are get as default data to write
+ * \warning When writting the file, this data are get as default data to write
  */
 size_t FileHelper::GetUserDataSize()
 {
@@ -325,7 +324,7 @@ size_t FileHelper::GetUserDataSize()
 }
 
 /**
- * \brief   Get the image datas from the file.
+ * \brief   Get the image data from the file.
  *          If a LUT is found, the data are expanded to be RGB
  */
 uint8_t *FileHelper::GetRGBData()
@@ -343,8 +342,8 @@ size_t FileHelper::GetRGBDataSize()
 }
 
 /**
- * \brief   Get the image datas from the file.
- *          If a LUT is found, the datas are not expanded !
+ * \brief   Get the image data from the file.
+ *          If a LUT is found, the data are not expanded !
  */
 uint8_t *FileHelper::GetRawData()
 {
@@ -508,7 +507,7 @@ bool FileHelper::Write(std::string const &fileName)
    bool check = CheckWriteIntegrity();
    if(check)
    {
-      check = HeaderInternal->Write(fileName,WriteType);
+      check = FileInternal->Write(fileName,WriteType);
    }
 
    RestoreWrite();
@@ -517,7 +516,7 @@ bool FileHelper::Write(std::string const &fileName)
    // --------------------------------------------------------------
    // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
    // 
-   // ...and we restore the Header to be Dicom Compliant again 
+   // ...and we restore the header to be Dicom Compliant again 
    // just after writting
    RestoreWriteOfLibido();
    // ----------------- End of Special Patch ----------------
@@ -530,13 +529,13 @@ bool FileHelper::Write(std::string const &fileName)
  *          through it's (group, element) and modifies it's content with
  *          the given value.
  * @param   content new value (string) to substitute with
- * @param   group     group number of the Dicom Element to modify
+ * @param   group  group number of the Dicom Element to modify
  * @param   elem element number of the Dicom Element to modify
  */
-bool FileHelper::SetEntry(std::string const &content,
+bool FileHelper::SetValEntry(std::string const &content,
                     uint16_t group, uint16_t elem)
 { 
-   return HeaderInternal->SetEntry(content,group,elem);
+   return FileInternal->SetValEntry(content,group,elem);
 }
 
 
@@ -546,44 +545,58 @@ bool FileHelper::SetEntry(std::string const &content,
  *          the given value.
  * @param   content new value (void*  -> uint8_t*) to substitute with
  * @param   lgth new value length
- * @param   group     group number of the Dicom Element to modify
+ * @param   group  group number of the Dicom Element to modify
  * @param   elem element number of the Dicom Element to modify
  */
-bool FileHelper::SetEntry(uint8_t *content, int lgth,
-                    uint16_t group, uint16_t elem)
+bool FileHelper::SetBinEntry(uint8_t *content, int lgth,
+                                 uint16_t group, uint16_t elem)
 {
-   return HeaderInternal->SetEntry(content,lgth,group,elem);
+   return FileInternal->SetBinEntry(content,lgth,group,elem);
 }
 
 /**
- * \brief   Modifies the value of a given Doc Entry (Dicom Element)
+ * \brief   Modifies the value of a given DocEntry (Dicom entry)
  *          when it exists. Create it with the given value when unexistant.
  * @param   content (string) Value to be set
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
- * \return  pointer to the modified/created Header Entry (NULL when creation
+ * \return  pointer to the modified/created Dicom entry (NULL when creation
  *          failed).
  */ 
-bool FileHelper::ReplaceOrCreate(std::string const &content,
-                           uint16_t group, uint16_t elem)
+ValEntry *FileHelper::InsertValEntry(std::string const &content,
+                                uint16_t group, uint16_t elem)
 {
-   return HeaderInternal->ReplaceOrCreate(content,group,elem) != NULL;
+   return FileInternal->InsertValEntry(content,group,elem);
 }
 
 /*
- * \brief   Modifies the value of a given Header Entry (Dicom Element)
+ * \brief   Modifies the value of a given DocEntry (Dicom entry)
  *          when it exists. Create it with the given value when unexistant.
  *          A copy of the binArea is made to be kept in the Document.
  * @param   binArea (binary) value to be set
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
- * \return  pointer to the modified/created Header Entry (NULL when creation
+ * \return  pointer to the modified/created Dicom entry (NULL when creation
+ *          failed).
+ */
+BinEntry *FileHelper::InsertBinEntry(uint8_t *binArea, int lgth,
+                                uint16_t group, uint16_t elem)
+{
+   return FileInternal->InsertBinEntry(binArea,lgth,group,elem);
+}
+
+/*
+ * \brief   Modifies the value of a given DocEntry (Dicom entry)
+ *          when it exists. Create it with the given value when unexistant.
+ *          A copy of the binArea is made to be kept in the Document.
+ * @param   group   Group number of the Entry 
+ * @param   elem  Element number of the Entry
+ * \return  pointer to the modified/created Dicom entry (NULL when creation
  *          failed).
  */
-bool FileHelper::ReplaceOrCreate(uint8_t *binArea, int lgth,
-                           uint16_t group, uint16_t elem)
+SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
 {
-   return HeaderInternal->ReplaceOrCreate(binArea,lgth,group,elem) != NULL;
+   return FileInternal->InsertSeqEntry(group,elem);
 }
 
 /**
@@ -603,25 +616,25 @@ uint8_t* FileHelper::GetLutRGBA()
  * The tests made are :
  *  - verify the size of the image to write with the possible write
  *    when the user set an image data
- * @return true if the check successfulls
+ * @return true if check is successfull
  */
 bool FileHelper::CheckWriteIntegrity()
 {
    if(PixelWriteConverter->GetUserData())
    {
-      int numberBitsAllocated = HeaderInternal->GetBitsAllocated();
+      int numberBitsAllocated = FileInternal->GetBitsAllocated();
       if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
       {
          numberBitsAllocated = 16;
       }
 
-      size_t decSize = HeaderInternal->GetXSize()
-                    * HeaderInternal->GetYSize() 
-                    * HeaderInternal->GetZSize()
+      size_t decSize = FileInternal->GetXSize()
+                    * FileInternal->GetYSize() 
+                    * FileInternal->GetZSize()
                     * ( numberBitsAllocated / 8 )
-                    * HeaderInternal->GetSamplesPerPixel();
+                    * FileInternal->GetSamplesPerPixel();
       size_t rgbSize = decSize;
-      if( HeaderInternal->HasLUT() )
+      if( FileInternal->HasLUT() )
          rgbSize = decSize * 3;
 
       switch(WriteMode)
@@ -629,16 +642,18 @@ bool FileHelper::CheckWriteIntegrity()
          case WMODE_RAW :
             if( decSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               gdcmVerboseMacro( "Data size is incorrect (Raw)" << decSize 
-                    << " / " << PixelWriteConverter->GetUserDataSize() );
+               gdcmVerboseMacro( "Data size (Raw) is incorrect. Should be " 
+                           << decSize << " / Found :" 
+                           << PixelWriteConverter->GetUserDataSize() );
                return false;
             }
             break;
          case WMODE_RGB :
             if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               gdcmVerboseMacro( "Data size is incorrect (RGB)" << decSize
-                   << " / " << PixelWriteConverter->GetUserDataSize() );
+               gdcmVerboseMacro( "Data size (RGB) is incorrect. Should be " 
+                          << decSize << " / Found " 
+                          << PixelWriteConverter->GetUserDataSize() );
                return false;
             }
             break;
@@ -653,15 +668,15 @@ bool FileHelper::CheckWriteIntegrity()
  */ 
 void FileHelper::SetWriteToRaw()
 {
-   if( HeaderInternal->GetNumberOfScalarComponents() == 3 
-    && !HeaderInternal->HasLUT())
+   if( FileInternal->GetNumberOfScalarComponents() == 3 
+    && !FileInternal->HasLUT())
    {
       SetWriteToRGB();
    } 
    else
    {
       ValEntry *photInt = CopyValEntry(0x0028,0x0004);
-      if(HeaderInternal->HasLUT())
+      if(FileInternal->HasLUT())
       {
          photInt->SetValue("PALETTE COLOR ");
       }
@@ -674,7 +689,7 @@ void FileHelper::SetWriteToRaw()
                                        PixelReadConverter->GetRawSize());
 
       BinEntry *pixel = 
-         CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+         CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
       pixel->SetLength(PixelWriteConverter->GetDataSize());
@@ -684,13 +699,12 @@ void FileHelper::SetWriteToRaw()
    }
 }
 
-
 /**
  * \brief   
  */ 
 void FileHelper::SetWriteToRGB()
 {
-   if(HeaderInternal->GetNumberOfScalarComponents()==3)
+   if(FileInternal->GetNumberOfScalarComponents()==3)
    {
       PixelReadConverter->BuildRGBImage();
       
@@ -715,7 +729,7 @@ void FileHelper::SetWriteToRGB()
       }
 
       BinEntry *pixel = 
-         CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+         CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
       pixel->SetLength(PixelWriteConverter->GetDataSize());
@@ -736,7 +750,7 @@ void FileHelper::SetWriteToRGB()
       // For old ACR-NEMA
       // Thus, we have a RGB image and the bits allocated = 24 and 
       // samples per pixels = 1 (in the read file)
-      if(HeaderInternal->GetBitsAllocated()==24) 
+      if(FileInternal->GetBitsAllocated()==24) 
       {
          ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
          bitsAlloc->SetValue("8 ");
@@ -766,7 +780,7 @@ void FileHelper::RestoreWrite()
    Archive->Restore(0x0028,0x0002);
    Archive->Restore(0x0028,0x0004);
    Archive->Restore(0x0028,0x0006);
-   Archive->Restore(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+   Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
 
    // For old ACR-NEMA (24 bits problem)
    Archive->Restore(0x0028,0x0100);
@@ -830,9 +844,9 @@ void FileHelper::RestoreWriteFileType()
 void FileHelper::SetWriteToLibido()
 {
    ValEntry *oldRow = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntry(0x0028, 0x0010));
+                (FileInternal->GetDocEntry(0x0028, 0x0010));
    ValEntry *oldCol = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntry(0x0028, 0x0011));
+                (FileInternal->GetDocEntry(0x0028, 0x0011));
    
    if( oldRow && oldCol )
    {
@@ -862,7 +876,7 @@ void FileHelper::SetWriteToLibido()
 void FileHelper::SetWriteToNoLibido()
 {
    ValEntry *recCode = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntry(0x0008,0x0010));
+                (FileInternal->GetDocEntry(0x0008,0x0010));
    if( recCode )
    {
       if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
@@ -886,7 +900,7 @@ void FileHelper::RestoreWriteOfLibido()
 
 ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
 {
-   DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+   DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
    ValEntry *newE;
 
    if(oldE)
@@ -896,7 +910,7 @@ ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
    }
    else
    {
-      newE = GetHeader()->NewValEntry(group,elem);
+      newE = GetFile()->NewValEntry(group,elem);
    }
 
    return newE;
@@ -905,7 +919,6 @@ ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
 /**
  * \brief   Modifies the value of a given Bin Entry (Dicom Element)
  *          when it exists. Create it with the given value when unexistant.
- * @param   content (string) Value to be set
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
  * \return  pointer to the modified/created Bin Entry (NULL when creation
@@ -913,7 +926,7 @@ ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
  */ 
 BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
 {
-   DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+   DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
    BinEntry *newE;
 
    if(oldE)
@@ -923,7 +936,7 @@ BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
    }
    else
    {
-      newE = GetHeader()->NewBinEntry(group,elem);
+      newE = GetFile()->NewBinEntry(group,elem);
    }
 
    return newE;
@@ -934,18 +947,18 @@ BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
 /**
  * \brief Factorization for various forms of constructors.
  */
-void FileHelper::Initialise()
+void FileHelper::Initialize()
 {
    WriteMode = WMODE_RAW;
    WriteType = ExplicitVR;
 
    PixelReadConverter = new PixelReadConvert;
    PixelWriteConverter = new PixelWriteConvert;
-   Archive = new DocEntryArchive( HeaderInternal );
+   Archive = new DocEntryArchive( FileInternal );
 
-   if ( HeaderInternal->IsReadable() )
+   if ( FileInternal->IsReadable() )
    {
-      PixelReadConverter->GrabInformationsFromHeader( HeaderInternal );
+      PixelReadConverter->GrabInformationsFromFile( FileInternal );
    }
 }
 
@@ -958,10 +971,10 @@ uint8_t *FileHelper::GetRaw()
    if ( ! raw )
    {
       // The Raw image migth not be loaded yet:
-      std::ifstream *fp = HeaderInternal->OpenFile();
+      std::ifstream *fp = FileInternal->OpenFile();
       PixelReadConverter->ReadAndDecompressPixelData( fp );
       if(fp) 
-         HeaderInternal->CloseFile();
+         FileInternal->CloseFile();
 
       raw = PixelReadConverter->GetRaw();
       if ( ! raw )