]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
Add missing Document::GetSeqEntry() method
[gdcm.git] / src / gdcmFile.cxx
index ae7e2ab2104f1676f472fbac18f1c5e91d80760a..593a0998dddb740408e43b48807ec1b358e7aefa 100644 (file)
@@ -1,10 +1,10 @@
-  /*=========================================================================
+/*=========================================================================
                                                                                 
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/12/16 13:46:37 $
-  Version:   $Revision: 1.179 $
+  Date:      $Date: 2005/01/16 04:50:42 $
+  Version:   $Revision: 1.193 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -17,6 +17,8 @@
 =========================================================================*/
 
 #include "gdcmFile.h"
+#include "gdcmGlobal.h"
+#include "gdcmTS.h"
 #include "gdcmDocument.h"
 #include "gdcmDebug.h"
 #include "gdcmUtil.h"
@@ -125,7 +127,7 @@ File::~File()
 
 //-----------------------------------------------------------------------------
 // Print
-void File::Print(std::ostream &os)
+void File::Print(std::ostream &os, std::string const &)
 {
    HeaderInternal->SetPrintLevel(PrintLevel);
    HeaderInternal->Print(os);
@@ -138,9 +140,10 @@ void File::Print(std::ostream &os)
 // Public
 /**
  * \brief   Get the size of the image data
- * 
  *          If the image can be RGB (with a lut or by default), the size 
  *          corresponds to the RGB image
+ *         (use GetImageDataRawSize if you want to be sure to get *only*
+ *          the size of the pixels)
  * @return  The image size
  */
 size_t File::GetImageDataSize()
@@ -155,9 +158,9 @@ size_t File::GetImageDataSize()
 
 /**
  * \brief   Get the size of the image data
- * 
- *          If the image can be RGB by transformation in a LUT, this
- *          transformation isn't considered
+ *          If the image could be converted to RGB using a LUT, 
+ *          this transformation is not taken into account by GetImageDataRawSize
+ *          (use GetImageDataSize if you wish)
  * @return  The raw image size
  */
 size_t File::GetImageDataRawSize()
@@ -180,7 +183,7 @@ size_t File::GetImageDataRawSize()
  * @return  Pointer to newly allocated pixel data.
  *          NULL if alloc fails 
  */
-uint8_tFile::GetImageData()
+uint8_t *File::GetImageData()
 {
    if ( PixelWriteConverter->GetUserData() )
    {
@@ -213,7 +216,7 @@ uint8_t* File::GetImageData()
  * @return  Pointer to newly allocated pixel data.
  * \        NULL if alloc fails 
  */
-uint8_tFile::GetImageDataRaw ()
+uint8_t *File::GetImageDataRaw ()
 {
    return GetRaw();
 }
@@ -243,7 +246,7 @@ uint8_t* File::GetImageDataRaw ()
  * @return  On success, the number of bytes actually copied. Zero on
  *          failure e.g. MaxSize is lower than necessary.
  */
-size_t File::GetImageDataIntoVector (voiddestination, size_t maxSize)
+size_t File::GetImageDataIntoVector (void *destination, size_t maxSize)
 {
    if ( ! GetRaw() )
    {
@@ -255,8 +258,7 @@ size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
    {
       if ( PixelReadConverter->GetRGBSize() > maxSize )
       {
-         dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
-                        "than caller's expected MaxSize");
+         gdcmVerboseMacro( "Pixel data bigger than caller's expected MaxSize");
          return 0;
       }
       memcpy( destination,
@@ -268,8 +270,7 @@ size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
    // Either no LUT conversion necessary or LUT conversion failed
    if ( PixelReadConverter->GetRawSize() > maxSize )
    {
-      dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
-                     "than caller's expected MaxSize");
+      gdcmVerboseMacro( "Pixel data bigger than caller's expected MaxSize");
       return 0;
    }
    memcpy( destination,
@@ -291,7 +292,7 @@ size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
  *
  * @return boolean
  */
-void File::SetImageData(uint8_tinData, size_t expectedSize)
+void File::SetImageData(uint8_t *inData, size_t expectedSize)
 {
    SetUserData(inData,expectedSize);
 }
@@ -300,23 +301,23 @@ void File::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
  */
-void File::SetUserData(uint8_tdata, size_t expectedSize)
+void File::SetUserData(uint8_t *data, size_t expectedSize)
 {
    PixelWriteConverter->SetUserData(data,expectedSize);
 }
 
 /**
  * \brief   Get the image datas defined by the user
- * \warning When writting the file, this datas are get as default datas to write
+ * \warning When writting the file, this datas are get as default data to write
  */
-uint8_tFile::GetUserData()
+uint8_t *File::GetUserData()
 {
    return PixelWriteConverter->GetUserData();
 }
 
 /**
  * \brief   Get the image data size defined by the user
- * \warning When writting the file, this datas are get as default datas to write
+ * \warning When writting the file, this datas are get as default data to write
  */
 size_t File::GetUserDataSize()
 {
@@ -325,16 +326,16 @@ size_t File::GetUserDataSize()
 
 /**
  * \brief   Get the image datas from the file.
- *          If a LUT is found, the datas are expanded to be RGB
+ *          If a LUT is found, the data are expanded to be RGB
  */
-uint8_tFile::GetRGBData()
+uint8_t *File::GetRGBData()
 {
    return PixelReadConverter->GetRGB();
 }
 
 /**
  * \brief   Get the image data size from the file.
- *          If a LUT is found, the datas are expanded to be RGB
+ *          If a LUT is found, the data are expanded to be RGB
  */
 size_t File::GetRGBDataSize()
 {
@@ -345,14 +346,14 @@ size_t File::GetRGBDataSize()
  * \brief   Get the image datas from the file.
  *          If a LUT is found, the datas are not expanded !
  */
-uint8_tFile::GetRawData()
+uint8_t *File::GetRawData()
 {
    return PixelReadConverter->GetRaw();
 }
 
 /**
  * \brief   Get the image data size from the file.
- *          If a LUT is found, the datas are not expanded !
+ *          If a LUT is found, the data are not expanded !
  */
 size_t File::GetRawDataSize()
 {
@@ -368,21 +369,34 @@ size_t File::GetRawDataSize()
  * @return false if write fails
  */
 
-bool File::WriteRawData(std::string const & fileName)
+bool File::WriteRawData(std::string const &fileName)
 {
   std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary );
    if (!fp1)
    {
-      dbg.Verbose(2, "Fail to open (write) file:", fileName.c_str());
+      gdcmVerboseMacro( "Fail to open (write) file:" << fileName.c_str());
       return false;
    }
 
-   if(PixelWriteConverter->GetUserData())
-      fp1.write((char*)PixelWriteConverter->GetUserData(), PixelWriteConverter->GetUserDataSize());
-   else if(PixelReadConverter->GetRGB())
-      fp1.write((char*)PixelReadConverter->GetRGB(), PixelReadConverter->GetRGBSize());
-   else if(PixelReadConverter->GetRaw())
-      fp1.write((char*)PixelReadConverter->GetRaw(), PixelReadConverter->GetRawSize());
+   if( PixelWriteConverter->GetUserData() )
+   {
+      fp1.write( (char*)PixelWriteConverter->GetUserData(), 
+                 PixelWriteConverter->GetUserDataSize() );
+   }
+   else if ( PixelReadConverter->GetRGB() )
+   {
+      fp1.write( (char*)PixelReadConverter->GetRGB(), 
+                 PixelReadConverter->GetRGBSize());
+   }
+   else if ( PixelReadConverter->GetRaw() )
+   {
+      fp1.write( (char*)PixelReadConverter->GetRaw(), 
+                 PixelReadConverter->GetRawSize());
+   }
+   else
+   {
+      gdcmErrorMacro( "Nothing written." );
+   }
 
    fp1.close();
 
@@ -398,7 +412,7 @@ bool File::WriteRawData(std::string const & fileName)
  * @return false if write fails
  */
 
-bool File::WriteDcmImplVR (std::string const & fileName)
+bool File::WriteDcmImplVR (std::string const &fileName)
 {
    SetWriteTypeToDcmImplVR();
    return Write(fileName);
@@ -407,12 +421,13 @@ bool File::WriteDcmImplVR (std::string const & fileName)
 /**
 * \brief Writes on disk A SINGLE Dicom file, 
  *        using the Explicit Value Representation convention
- *        NO test is performed on  processor "Endiannity". * @param fileName name of the file to be created
+ *        NO test is performed on  processor "Endiannity". 
+ * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails
  */
 
-bool File::WriteDcmExplVR (std::string const & fileName)
+bool File::WriteDcmExplVR (std::string const &fileName)
 {
    SetWriteTypeToDcmExplVR();
    return Write(fileName);
@@ -432,60 +447,19 @@ bool File::WriteDcmExplVR (std::string const & fileName)
  * @return false if write fails
  */
 
-bool File::WriteAcr (std::string const & fileName)
+bool File::WriteAcr (std::string const &fileName)
 {
    SetWriteTypeToAcr();
    return Write(fileName);
 }
 
-bool File::Write(std::string const& fileName)
-{
-   return WriteBase(fileName);
-}
-
-bool File::SetEntryByNumber(std::string const& content,
-                            uint16_t group, uint16_t element)
-{ 
-   return HeaderInternal->SetEntryByNumber(content,group,element);
-}
-
-bool File::SetEntryByNumber(uint8_t* content, int lgth,
-                            uint16_t group, uint16_t element)
-{
-   return HeaderInternal->SetEntryByNumber(content,lgth,group,element);
-}
-
-bool File::ReplaceOrCreateByNumber(std::string const& content,
-                                   uint16_t group, uint16_t element)
-{
-   return HeaderInternal->ReplaceOrCreateByNumber(content,group,element) != NULL;
-}
-
-bool File::ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
-                                   uint16_t group, uint16_t element)
-{
-   return HeaderInternal->ReplaceOrCreateByNumber(binArea,lgth,group,element) != NULL;
-}
-
 /**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
- */
-uint8_t* File::GetLutRGBA()
-{
-   return PixelReadConverter->GetLutRGBA();
-}
-
-//-----------------------------------------------------------------------------
-// Protected
-/**
- * \brief NOT a end user inteded function
- *        (used by WriteDcmExplVR, WriteDcmImplVR, WriteAcr, etc)
+ * \brief Writes on disk A SINGLE Dicom file, 
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
- * @param  type file type (ExplicitVR, ImplicitVR, ...)
  * @return false if write fails
  */
-bool File::WriteBase (std::string const & fileName)
+bool File::Write(std::string const &fileName)
 {
    switch(WriteType)
    {
@@ -551,6 +525,78 @@ bool File::WriteBase (std::string const & fileName)
    return check;
 }
 
+/**
+ * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
+ *          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   elem element number of the Dicom Element to modify
+ */
+bool File::SetEntry(std::string const &content,
+                    uint16_t group, uint16_t elem)
+{ 
+   return HeaderInternal->SetEntry(content,group,elem);
+}
+
+
+/**
+ * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
+ *          through it's (group, element) and modifies it's content with
+ *          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   elem element number of the Dicom Element to modify
+ */
+bool File::SetEntry(uint8_t *content, int lgth,
+                    uint16_t group, uint16_t elem)
+{
+   return HeaderInternal->SetEntry(content,lgth,group,elem);
+}
+
+/**
+ * \brief   Modifies the value of a given Doc 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 Header Entry (NULL when creation
+ *          failed).
+ */ 
+bool File::ReplaceOrCreate(std::string const &content,
+                           uint16_t group, uint16_t elem)
+{
+   return HeaderInternal->ReplaceOrCreate(content,group,elem) != NULL;
+}
+
+/*
+ * \brief   Modifies the value of a given Header Entry (Dicom Element)
+ *          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
+ *          failed).
+ */
+bool File::ReplaceOrCreate(uint8_t *binArea, int lgth,
+                           uint16_t group, uint16_t elem)
+{
+   return HeaderInternal->ReplaceOrCreate(binArea,lgth,group,elem) != NULL;
+}
+
+/**
+ * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
+ */
+uint8_t* File::GetLutRGBA()
+{
+   return PixelReadConverter->GetLutRGBA();
+}
+
+//-----------------------------------------------------------------------------
+// Protected
+
 /**
  * \brief Check the write integrity
  *
@@ -583,18 +629,16 @@ bool File::CheckWriteIntegrity()
          case WMODE_RAW :
             if( decSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (Raw)");
-               //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (Raw)\n"
-               //          << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
+               gdcmVerboseMacro( "Data size is incorrect (Raw)" << decSize 
+                    << " / " << PixelWriteConverter->GetUserDataSize() );
                return false;
             }
             break;
          case WMODE_RGB :
             if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (RGB)");
-               //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (RGB)\n"
-               //          << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
+               gdcmVerboseMacro( "Data size is incorrect (RGB)" << decSize
+                   << " / " << PixelWriteConverter->GetUserDataSize() );
                return false;
             }
             break;
@@ -606,13 +650,14 @@ bool File::CheckWriteIntegrity()
 
 void File::SetWriteToRaw()
 {
-   if(HeaderInternal->GetNumberOfScalarComponents()==3 && !HeaderInternal->HasLUT())
+   if( HeaderInternal->GetNumberOfScalarComponents() == 3 
+    && !HeaderInternal->HasLUT())
    {
       SetWriteToRGB();
    } 
    else
    {
-      ValEntryphotInt = CopyValEntry(0x0028,0x0004);
+      ValEntry *photInt = CopyValEntry(0x0028,0x0004);
       if(HeaderInternal->HasLUT())
       {
          photInt->SetValue("PALETTE COLOR ");
@@ -625,7 +670,8 @@ void File::SetWriteToRaw()
       PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
                                        PixelReadConverter->GetRawSize());
 
-      BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+      BinEntry *pixel = 
+         CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
       pixel->SetLength(PixelWriteConverter->GetDataSize());
@@ -641,13 +687,13 @@ void File::SetWriteToRGB()
    {
       PixelReadConverter->BuildRGBImage();
       
-      ValEntryspp = CopyValEntry(0x0028,0x0002);
+      ValEntry *spp = CopyValEntry(0x0028,0x0002);
       spp->SetValue("3 ");
 
-      ValEntryplanConfig = CopyValEntry(0x0028,0x0006);
+      ValEntry *planConfig = CopyValEntry(0x0028,0x0006);
       planConfig->SetValue("0 ");
 
-      ValEntryphotInt = CopyValEntry(0x0028,0x0004);
+      ValEntry *photInt = CopyValEntry(0x0028,0x0004);
       photInt->SetValue("RGB ");
 
       if(PixelReadConverter->GetRGB())
@@ -661,7 +707,8 @@ void File::SetWriteToRGB()
                                           PixelReadConverter->GetRawSize());
       }
 
-      BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+      BinEntry *pixel = 
+         CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
       pixel->SetLength(PixelWriteConverter->GetDataSize());
@@ -684,13 +731,13 @@ void File::SetWriteToRGB()
       // samples per pixels = 1 (in the read file)
       if(HeaderInternal->GetBitsAllocated()==24) 
       {
-         ValEntrybitsAlloc = CopyValEntry(0x0028,0x0100);
+         ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
          bitsAlloc->SetValue("8 ");
 
-         ValEntrybitsStored = CopyValEntry(0x0028,0x0101);
+         ValEntry *bitsStored = CopyValEntry(0x0028,0x0101);
          bitsStored->SetValue("8 ");
 
-         ValEntryhighBit = CopyValEntry(0x0028,0x0102);
+         ValEntry *highBit = CopyValEntry(0x0028,0x0102);
          highBit->SetValue("7 ");
 
          Archive->Push(bitsAlloc);
@@ -733,9 +780,9 @@ void File::SetWriteFileTypeToACR()
 void File::SetWriteFileTypeToExplicitVR()
 {
    std::string ts = Util::DicomString( 
-      Document::GetTransferSyntaxValue(ExplicitVRLittleEndian).c_str() );
+      Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
 
-   ValEntrytss = CopyValEntry(0x0002,0x0010);
+   ValEntry *tss = CopyValEntry(0x0002,0x0010);
    tss->SetValue(ts);
 
    Archive->Push(tss);
@@ -744,9 +791,9 @@ void File::SetWriteFileTypeToExplicitVR()
 void File::SetWriteFileTypeToImplicitVR()
 {
    std::string ts = Util::DicomString(
-      Document::GetTransferSyntaxValue(ImplicitVRLittleEndian).c_str() );
+      Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
 
-   ValEntrytss = CopyValEntry(0x0002,0x0010);
+   ValEntry *tss = CopyValEntry(0x0002,0x0010);
    tss->SetValue(ts);
 
    Archive->Push(tss);
@@ -760,9 +807,9 @@ void File::RestoreWriteFileType()
 void File::SetWriteToLibido()
 {
    ValEntry *oldRow = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0010));
+                (HeaderInternal->GetDocEntry(0x0028, 0x0010));
    ValEntry *oldCol = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0011));
+                (HeaderInternal->GetDocEntry(0x0028, 0x0011));
    
    if( oldRow && oldCol )
    {
@@ -789,7 +836,7 @@ void File::SetWriteToLibido()
 void File::SetWriteToNoLibido()
 {
    ValEntry *recCode = dynamic_cast<ValEntry *>
-                (HeaderInternal->GetDocEntryByNumber(0x0008,0x0010));
+                (HeaderInternal->GetDocEntry(0x0008,0x0010));
    if( recCode )
    {
       if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
@@ -808,10 +855,10 @@ void File::RestoreWriteOfLibido()
    Archive->Restore(0x0008,0x0010);
 }
 
-ValEntry* File::CopyValEntry(uint16_t group,uint16_t element)
+ValEntry *File::CopyValEntry(uint16_t group,uint16_t elem)
 {
-   DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element);
-   ValEntrynewE;
+   DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+   ValEntry *newE;
 
    if(oldE)
    {
@@ -820,16 +867,16 @@ ValEntry* File::CopyValEntry(uint16_t group,uint16_t element)
    }
    else
    {
-      newE = GetHeader()->NewValEntryByNumber(group,element);
+      newE = GetHeader()->NewValEntry(group,elem);
    }
 
-   return(newE);
+   return newE;
 }
 
-BinEntry* File::CopyBinEntry(uint16_t group,uint16_t element)
+BinEntry *File::CopyBinEntry(uint16_t group,uint16_t elem)
 {
-   DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element);
-   BinEntrynewE;
+   DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+   BinEntry *newE;
 
    if(oldE)
    {
@@ -838,10 +885,10 @@ BinEntry* File::CopyBinEntry(uint16_t group,uint16_t element)
    }
    else
    {
-      newE = GetHeader()->NewBinEntryByNumber(group,element);
+      newE = GetHeader()->NewBinEntry(group,elem);
    }
 
-   return(newE);
+   return newE;
 }
 
 //-----------------------------------------------------------------------------
@@ -864,13 +911,13 @@ void File::Initialise()
    }
 }
 
-uint8_tFile::GetRaw()
+uint8_t *File::GetRaw()
 {
-   uint8_traw = PixelReadConverter->GetRaw();
+   uint8_t *raw = PixelReadConverter->GetRaw();
    if ( ! raw )
    {
       // The Raw image migth not be loaded yet:
-      std::ifstreamfp = HeaderInternal->OpenFile();
+      std::ifstream *fp = HeaderInternal->OpenFile();
       PixelReadConverter->ReadAndDecompressPixelData( fp );
       if(fp) 
          HeaderInternal->CloseFile();
@@ -878,8 +925,7 @@ uint8_t* File::GetRaw()
       raw = PixelReadConverter->GetRaw();
       if ( ! raw )
       {
-         dbg.Verbose(0, "File::GetRaw: read/decompress of "
-                        "pixel data apparently went wrong.");
+         gdcmVerboseMacro( "Read/decompress of pixel data apparently went wrong.");
          return 0;
       }
    }