]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
* src/gdcmFile.[h|cxx] : add the Print method
[gdcm.git] / src / gdcmFile.cxx
index 43804b36618688ba894e783abefa4f94850b8ea6..336713c68cd5028d031927657ba75806ff3d1168 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/12/07 13:39:33 $
-  Version:   $Revision: 1.173 $
+  Date:      $Date: 2004/12/16 11:37:03 $
+  Version:   $Revision: 1.178 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -34,6 +34,26 @@ 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)
+ *        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
+ *        one sets an a posteriori shadow dictionary (efficiency can be
+ *        seen as a side effect).   
+ */
+File::File( )
+{
+   HeaderInternal = new Header( );
+   SelfHeader = true;
+   Initialise();
+}
+
 /**
  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
  *        file (Header only deals with the ... header)
@@ -76,24 +96,6 @@ File::File(std::string const & filename )
    Initialise();
 }
 
-/**
- * \brief Factorization for various forms of constructors.
- */
-void File::Initialise()
-{
-   WriteMode = WMODE_DECOMPRESSED;
-   WriteType = ImplicitVR;
-
-   PixelReadConverter = new PixelReadConvert;
-   PixelWriteConverter = new PixelWriteConvert;
-   Archive = new DocEntryArchive( HeaderInternal );
-
-   if ( HeaderInternal->IsReadable() )
-   {
-      PixelReadConverter->GrabInformationsFromHeader( HeaderInternal );
-   }
-}
-
 /**
  * \brief canonical destructor
  * \note  If the Header was created by the File constructor,
@@ -123,6 +125,12 @@ File::~File()
 
 //-----------------------------------------------------------------------------
 // Print
+void File::Print(std::ostream &os)
+{
+   HeaderInternal->SetPrintLevel(PrintLevel);
+   HeaderInternal->Print(os);
+   PixelReadConverter->Print(os);
+}
 
 //-----------------------------------------------------------------------------
 // Public
@@ -135,6 +143,11 @@ File::~File()
  */
 size_t File::GetImageDataSize()
 {
+   if ( PixelWriteConverter->GetUserData() )
+   {
+      return PixelWriteConverter->GetUserDataSize();
+   }
+
    return PixelReadConverter->GetRGBSize();
 }
 
@@ -147,7 +160,12 @@ size_t File::GetImageDataSize()
  */
 size_t File::GetImageDataRawSize()
 {
-   return PixelReadConverter->GetDecompressedSize();
+   if ( PixelWriteConverter->GetUserData() )
+   {
+      return PixelWriteConverter->GetUserDataSize();
+   }
+
+   return PixelReadConverter->GetRawSize();
 }
 
 /**
@@ -162,7 +180,12 @@ size_t File::GetImageDataRawSize()
  */
 uint8_t* File::GetImageData()
 {
-   if ( ! GetDecompressed() )
+   if ( PixelWriteConverter->GetUserData() )
+   {
+      return PixelWriteConverter->GetUserData();
+   }
+
+   if ( ! GetRaw() )
    {
       // If the decompression failed nothing can be done.
       return 0;
@@ -174,11 +197,25 @@ uint8_t* File::GetImageData()
    }
    else
    {
-      // When no LUT or LUT conversion fails, return the decompressed
-      return PixelReadConverter->GetDecompressed();
+      // When no LUT or LUT conversion fails, return the Raw
+      return PixelReadConverter->GetRaw();
    }
 }
 
+/**
+ * \brief   Allocates necessary memory, 
+ *          Transforms YBR pixels (if any) into RGB pixels
+ *          Transforms 3 planes R, G, B  (if any) into a single RGB Plane
+ *          Copies the pixel data (image[s]/volume[s]) to newly allocated zone. 
+ *          DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
+ * @return  Pointer to newly allocated pixel data.
+ * \        NULL if alloc fails 
+ */
+uint8_t* File::GetImageDataRaw ()
+{
+   return GetRaw();
+}
+
 /**
  * \brief
  *          Read the pixels from disk (uncompress if necessary),
@@ -206,7 +243,7 @@ uint8_t* File::GetImageData()
  */
 size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
 {
-   if ( ! GetDecompressed() )
+   if ( ! GetRaw() )
    {
       // If the decompression failed nothing can be done.
       return 0;
@@ -227,53 +264,16 @@ size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
    }
 
    // Either no LUT conversion necessary or LUT conversion failed
-   if ( PixelReadConverter->GetDecompressedSize() > maxSize )
+   if ( PixelReadConverter->GetRawSize() > maxSize )
    {
       dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
                      "than caller's expected MaxSize");
       return 0;
    }
    memcpy( destination,
-           (void*)PixelReadConverter->GetDecompressed(),
-           PixelReadConverter->GetDecompressedSize() );
-   return PixelReadConverter->GetDecompressedSize();
-}
-
-/**
- * \brief   Allocates necessary memory, 
- *          Transforms YBR pixels (if any) into RGB pixels
- *          Transforms 3 planes R, G, B  (if any) into a single RGB Plane
- *          Copies the pixel data (image[s]/volume[s]) to newly allocated zone. 
- *          DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
- * @return  Pointer to newly allocated pixel data.
- * \        NULL if alloc fails 
- */
-uint8_t* File::GetImageDataRaw ()
-{
-   return GetDecompressed();
-}
-
-uint8_t* File::GetDecompressed()
-{
-   uint8_t* decompressed = PixelReadConverter->GetDecompressed();
-   if ( ! decompressed )
-   {
-      // The decompressed image migth not be loaded yet:
-      std::ifstream* fp = HeaderInternal->OpenFile();
-      PixelReadConverter->ReadAndDecompressPixelData( fp );
-      if(fp) 
-         HeaderInternal->CloseFile();
-
-      decompressed = PixelReadConverter->GetDecompressed();
-      if ( ! decompressed )
-      {
-         dbg.Verbose(0, "File::GetDecompressed: read/decompress of "
-                        "pixel data apparently went wrong.");
-         return 0;
-      }
-   }
-
-   return decompressed;
+           (void*)PixelReadConverter->GetRaw(),
+           PixelReadConverter->GetRawSize() );
+   return PixelReadConverter->GetRawSize();
 }
 
 /**
@@ -289,11 +289,72 @@ uint8_t* File::GetDecompressed()
  *
  * @return boolean
  */
-bool File::SetImageData(uint8_t* inData, size_t expectedSize)
+void File::SetImageData(uint8_t* inData, size_t expectedSize)
 {
-   PixelWriteConverter->SetUserData(inData,expectedSize);
+   SetUserData(inData,expectedSize);
+}
 
-   return true;
+/**
+ * \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_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
+ */
+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
+ */
+size_t File::GetUserDataSize()
+{
+   return PixelWriteConverter->GetUserDataSize();
+}
+
+/**
+ * \brief   Get the image datas from the file.
+ *          If a LUT is found, the datas are expanded to be RGB
+ */
+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
+ */
+size_t File::GetRGBDataSize()
+{
+   return PixelReadConverter->GetRGBSize();
+}
+
+/**
+ * \brief   Get the image datas from the file.
+ *          If a LUT is found, the datas are not expanded !
+ */
+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 !
+ */
+size_t File::GetRawDataSize()
+{
+   return PixelReadConverter->GetRawSize();
 }
 
 /**
@@ -318,8 +379,8 @@ bool File::WriteRawData(std::string const & fileName)
       fp1.write((char*)PixelWriteConverter->GetUserData(), PixelWriteConverter->GetUserDataSize());
    else if(PixelReadConverter->GetRGB())
       fp1.write((char*)PixelReadConverter->GetRGB(), PixelReadConverter->GetRGBSize());
-   else if(PixelReadConverter->GetDecompressed())
-      fp1.write((char*)PixelReadConverter->GetDecompressed(), PixelReadConverter->GetDecompressedSize());
+   else if(PixelReadConverter->GetRaw())
+      fp1.write((char*)PixelReadConverter->GetRaw(), PixelReadConverter->GetRawSize());
 
    fp1.close();
 
@@ -383,8 +444,25 @@ bool File::Write(std::string const& fileName)
 bool File::SetEntryByNumber(std::string const& content,
                             uint16_t group, uint16_t element)
 { 
-   HeaderInternal->SetEntryByNumber(content,group,element);
-   return true;
+   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;
 }
 
 /**
@@ -443,8 +521,8 @@ bool File::WriteBase (std::string const & fileName)
   
    switch(WriteMode)
    {
-      case WMODE_DECOMPRESSED :
-         SetWriteToDecompressed();
+      case WMODE_RAW :
+         SetWriteToRaw();
          break;
       case WMODE_RGB :
          SetWriteToRGB();
@@ -500,17 +578,21 @@ bool File::CheckWriteIntegrity()
 
       switch(WriteMode)
       {
-         case WMODE_DECOMPRESSED :
+         case WMODE_RAW :
             if( decSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect");
+               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (Raw)");
+               //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (Raw)\n"
+               //          << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
                return false;
             }
             break;
          case WMODE_RGB :
             if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect");
+               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (RGB)");
+               //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (RGB)\n"
+               //          << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
                return false;
             }
             break;
@@ -520,7 +602,7 @@ bool File::CheckWriteIntegrity()
    return true;
 }
 
-void File::SetWriteToDecompressed()
+void File::SetWriteToRaw()
 {
    if(HeaderInternal->GetNumberOfScalarComponents()==3 && !HeaderInternal->HasLUT())
    {
@@ -538,8 +620,8 @@ void File::SetWriteToDecompressed()
          photInt->SetValue("MONOCHROME1 ");
       }
 
-      PixelWriteConverter->SetReadData(PixelReadConverter->GetDecompressed(),
-                                       PixelReadConverter->GetDecompressedSize());
+      PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
+                                       PixelReadConverter->GetRawSize());
 
       BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
@@ -571,10 +653,10 @@ void File::SetWriteToRGB()
          PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
                                           PixelReadConverter->GetRGBSize());
       }
-      else // Decompressed data
+      else // Raw data
       {
-         PixelWriteConverter->SetReadData(PixelReadConverter->GetDecompressed(),
-                                          PixelReadConverter->GetDecompressedSize());
+         PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
+                                          PixelReadConverter->GetRawSize());
       }
 
       BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
@@ -616,7 +698,7 @@ void File::SetWriteToRGB()
    }
    else
    {
-      SetWriteToDecompressed();
+      SetWriteToRaw();
    }
 }
 
@@ -664,6 +746,8 @@ void File::SetWriteFileTypeToImplicitVR()
 
    ValEntry* tss = CopyValEntry(0x0002,0x0010);
    tss->SetValue(ts);
+
+   Archive->Push(tss);
 }
 
 void File::RestoreWriteFileType()
@@ -673,8 +757,10 @@ void File::RestoreWriteFileType()
 
 void File::SetWriteToLibido()
 {
-   ValEntry *oldRow = dynamic_cast<ValEntry *>(HeaderInternal->GetDocEntryByNumber(0x0028, 0x0010));
-   ValEntry *oldCol = dynamic_cast<ValEntry *>(HeaderInternal->GetDocEntryByNumber(0x0028, 0x0011));
+   ValEntry *oldRow = dynamic_cast<ValEntry *>
+                (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0010));
+   ValEntry *oldCol = dynamic_cast<ValEntry *>
+                (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0011));
    
    if( oldRow && oldCol )
    {
@@ -700,7 +786,8 @@ void File::SetWriteToLibido()
 
 void File::SetWriteToNoLibido()
 {
-   ValEntry *recCode = dynamic_cast<ValEntry *>(HeaderInternal->GetDocEntryByNumber(0x0008,0x0010));
+   ValEntry *recCode = dynamic_cast<ValEntry *>
+                (HeaderInternal->GetDocEntryByNumber(0x0008,0x0010));
    if( recCode )
    {
       if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
@@ -755,6 +842,49 @@ BinEntry* File::CopyBinEntry(uint16_t group,uint16_t element)
    return(newE);
 }
 
+//-----------------------------------------------------------------------------
+// Protected
+/**
+ * \brief Factorization for various forms of constructors.
+ */
+void File::Initialise()
+{
+   WriteMode = WMODE_RAW;
+   WriteType = ExplicitVR;
+
+   PixelReadConverter = new PixelReadConvert;
+   PixelWriteConverter = new PixelWriteConvert;
+   Archive = new DocEntryArchive( HeaderInternal );
+
+   if ( HeaderInternal->IsReadable() )
+   {
+      PixelReadConverter->GrabInformationsFromHeader( HeaderInternal );
+   }
+}
+
+uint8_t* File::GetRaw()
+{
+   uint8_t* raw = PixelReadConverter->GetRaw();
+   if ( ! raw )
+   {
+      // The Raw image migth not be loaded yet:
+      std::ifstream* fp = HeaderInternal->OpenFile();
+      PixelReadConverter->ReadAndDecompressPixelData( fp );
+      if(fp) 
+         HeaderInternal->CloseFile();
+
+      raw = PixelReadConverter->GetRaw();
+      if ( ! raw )
+      {
+         dbg.Verbose(0, "File::GetRaw: read/decompress of "
+                        "pixel data apparently went wrong.");
+         return 0;
+      }
+   }
+
+   return raw;
+}
+
 //-----------------------------------------------------------------------------
 // Private