]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
* src/gdcmFile.[h|cxx] : add the Print method
[gdcm.git] / src / gdcmFile.cxx
index 6d596da72c7d5447280c4e59770073f2c58703b0..336713c68cd5028d031927657ba75806ff3d1168 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 10:21:54 $
-  Version:   $Revision: 1.168 $
+  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
 #include "gdcmDebug.h"
 #include "gdcmUtil.h"
 #include "gdcmBinEntry.h"
+#include "gdcmHeader.h"
+#include "gdcmPixelReadConvert.h"
+#include "gdcmPixelWriteConvert.h"
+#include "gdcmDocEntryArchive.h"
+
 #include <fstream>
 
 namespace gdcm 
@@ -29,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)
@@ -71,26 +96,6 @@ File::File(std::string const & filename )
    Initialise();
 }
 
-/**
- * \brief Factorization for various forms of constructors.
- */
-void File::Initialise()
-{
-   WriteMode = WMODE_DECOMPRESSED;
-   WriteType = WTYPE_IMPL_VR;
-
-   PixelReadConverter = new PixelReadConvert;
-   Archive = new DocEntryArchive( HeaderInternal );
-
-   if ( HeaderInternal->IsReadable() )
-   {
-      PixelReadConverter->GrabInformationsFromHeader( HeaderInternal );
-   }
-
-   Pixel_Data = 0;
-   ImageDataSize = 0;
-}
-
 /**
  * \brief canonical destructor
  * \note  If the Header was created by the File constructor,
@@ -102,6 +107,10 @@ File::~File()
    {
       delete PixelReadConverter;
    }
+   if( PixelWriteConverter )
+   {
+      delete PixelWriteConverter;
+   }
    if( Archive )
    {
       delete Archive;
@@ -116,6 +125,12 @@ File::~File()
 
 //-----------------------------------------------------------------------------
 // Print
+void File::Print(std::ostream &os)
+{
+   HeaderInternal->SetPrintLevel(PrintLevel);
+   HeaderInternal->Print(os);
+   PixelReadConverter->Print(os);
+}
 
 //-----------------------------------------------------------------------------
 // Public
@@ -128,6 +143,11 @@ File::~File()
  */
 size_t File::GetImageDataSize()
 {
+   if ( PixelWriteConverter->GetUserData() )
+   {
+      return PixelWriteConverter->GetUserDataSize();
+   }
+
    return PixelReadConverter->GetRGBSize();
 }
 
@@ -140,7 +160,12 @@ size_t File::GetImageDataSize()
  */
 size_t File::GetImageDataRawSize()
 {
-   return PixelReadConverter->GetDecompressedSize();
+   if ( PixelWriteConverter->GetUserData() )
+   {
+      return PixelWriteConverter->GetUserDataSize();
+   }
+
+   return PixelReadConverter->GetRawSize();
 }
 
 /**
@@ -155,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;
@@ -167,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),
@@ -199,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;
@@ -220,57 +264,20 @@ 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();
 }
 
 /**
- * \brief   Points the internal Pixel_Data pointer to the callers inData
+ * \brief   Points the internal pointer to the callers inData
  *          image representation, BUT WITHOUT COPYING THE DATA.
  *          'image' Pixels are presented as C-like 2D arrays : line per line.
  *          'volume'Pixels are presented as C-like 3D arrays : plane per plane 
@@ -282,13 +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)
 {
-// FIXME : if already allocated, memory leak !
-   Pixel_Data     = inData;
-   ImageDataSize = expectedSize;
-// FIXME : 7fe0, 0010 IS NOT set ...
-   return true;
+   SetUserData(inData,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_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();
 }
 
 /**
@@ -308,7 +374,14 @@ bool File::WriteRawData(std::string const & fileName)
       dbg.Verbose(2, "Fail to open (write) file:", fileName.c_str());
       return false;
    }
-   fp1.write((char*)Pixel_Data, ImageDataSize);
+
+   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());
+
    fp1.close();
 
    return true;
@@ -365,16 +438,31 @@ bool File::WriteAcr (std::string const & fileName)
 
 bool File::Write(std::string const& fileName)
 {
-   switch(WriteType)
-   {
-      case WTYPE_IMPL_VR:
-         return WriteBase(fileName,ImplicitVR);
-      case WTYPE_EXPL_VR:
-         return WriteBase(fileName,ExplicitVR);
-      case WTYPE_ACR:
-         return WriteBase(fileName,ACR);
-   }
-   return(false);
+   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;
 }
 
 /**
@@ -395,9 +483,9 @@ uint8_t* File::GetLutRGBA()
  * @param  type file type (ExplicitVR, ImplicitVR, ...)
  * @return false if write fails
  */
-bool File::WriteBase (std::string const & fileName, FileType type)
+bool File::WriteBase (std::string const & fileName)
 {
-   switch(type)
+   switch(WriteType)
    {
       case ImplicitVR:
          SetWriteFileTypeToImplicitVR();
@@ -421,7 +509,7 @@ bool File::WriteBase (std::string const & fileName, FileType type)
    // just before writting ...
    /// \todo the best trick would be *change* the recognition code
    ///       but pb expected if user deals with, e.g. COMPLEX images
-   if( type == ACR_LIBIDO )
+   if( WriteType == ACR_LIBIDO )
    {
       SetWriteToLibido();
    }
@@ -433,8 +521,8 @@ bool File::WriteBase (std::string const & fileName, FileType type)
   
    switch(WriteMode)
    {
-      case WMODE_DECOMPRESSED :
-         SetWriteToDecompressed();
+      case WMODE_RAW :
+         SetWriteToRaw();
          break;
       case WMODE_RGB :
          SetWriteToRGB();
@@ -444,7 +532,7 @@ bool File::WriteBase (std::string const & fileName, FileType type)
    bool check = CheckWriteIntegrity();
    if(check)
    {
-      check = HeaderInternal->Write(fileName,type);
+      check = HeaderInternal->Write(fileName,WriteType);
    }
 
    RestoreWrite();
@@ -471,7 +559,7 @@ bool File::WriteBase (std::string const & fileName, FileType type)
  */
 bool File::CheckWriteIntegrity()
 {
-   if(Pixel_Data)
+   if(PixelWriteConverter->GetUserData())
    {
       int numberBitsAllocated = HeaderInternal->GetBitsAllocated();
       if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
@@ -490,19 +578,21 @@ bool File::CheckWriteIntegrity()
 
       switch(WriteMode)
       {
-         case WMODE_DECOMPRESSED :
-            if( decSize!=ImageDataSize )
+         case WMODE_RAW :
+            if( decSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect");
-               //std::cerr<<"Dec : "<<decSize<<" | "<<ImageDataSize<<std::endl;
+               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!=ImageDataSize )
+            if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
             {
-               dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect");
-               //std::cerr<<"RGB : "<<decSize<<" | "<<ImageDataSize<<std::endl;
+               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;
@@ -512,20 +602,7 @@ bool File::CheckWriteIntegrity()
    return true;
 }
 
-/*void File::SetWriteToNative()
-{
-   if(Pixel_Data)
-   {
-      BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
-      pixel->SetValue(GDCM_BINLOADED);
-      pixel->SetBinArea(Pixel_Data,false);
-      pixel->SetLength(ImageDataSize);
-
-      Archive->Push(pixel);
-   }
-}*/
-
-void File::SetWriteToDecompressed()
+void File::SetWriteToRaw()
 {
    if(HeaderInternal->GetNumberOfScalarComponents()==3 && !HeaderInternal->HasLUT())
    {
@@ -537,26 +614,19 @@ void File::SetWriteToDecompressed()
       if(HeaderInternal->HasLUT())
       {
          photInt->SetValue("PALETTE COLOR ");
-         photInt->SetLength(14);
       }
       else
       {
          photInt->SetValue("MONOCHROME1 ");
-         photInt->SetLength(12);
       }
 
+      PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
+                                       PixelReadConverter->GetRawSize());
+
       BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
       pixel->SetValue(GDCM_BINLOADED);
-      if(Pixel_Data)
-      {
-         pixel->SetBinArea(Pixel_Data,false);
-         pixel->SetLength(ImageDataSize);
-      }
-      else
-      {
-         pixel->SetBinArea(PixelReadConverter->GetDecompressed(),false);
-         pixel->SetLength(PixelReadConverter->GetDecompressedSize());
-      }
+      pixel->SetBinArea(PixelWriteConverter->GetData(),false);
+      pixel->SetLength(PixelWriteConverter->GetDataSize());
 
       Archive->Push(photInt);
       Archive->Push(pixel);
@@ -571,34 +641,29 @@ void File::SetWriteToRGB()
       
       ValEntry* spp = CopyValEntry(0x0028,0x0002);
       spp->SetValue("3 ");
-      spp->SetLength(2);
 
       ValEntry* planConfig = CopyValEntry(0x0028,0x0006);
       planConfig->SetValue("0 ");
-      planConfig->SetLength(2);
 
       ValEntry* photInt = CopyValEntry(0x0028,0x0004);
       photInt->SetValue("RGB ");
-      photInt->SetLength(4);
 
-      BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
-      pixel->SetValue(GDCM_BINLOADED);
-      if(Pixel_Data)
+      if(PixelReadConverter->GetRGB())
       {
-         pixel->SetBinArea(Pixel_Data,false);
-         pixel->SetLength(ImageDataSize);
+         PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
+                                          PixelReadConverter->GetRGBSize());
       }
-      else if(PixelReadConverter->GetRGB())
+      else // Raw data
       {
-         pixel->SetBinArea(PixelReadConverter->GetRGB(),false);
-         pixel->SetLength(PixelReadConverter->GetRGBSize());
-      }
-      else // Decompressed data
-      {
-         pixel->SetBinArea(PixelReadConverter->GetDecompressed(),false);
-         pixel->SetLength(PixelReadConverter->GetDecompressedSize());
+         PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
+                                          PixelReadConverter->GetRawSize());
       }
 
+      BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+      pixel->SetValue(GDCM_BINLOADED);
+      pixel->SetBinArea(PixelWriteConverter->GetData(),false);
+      pixel->SetLength(PixelWriteConverter->GetDataSize());
+
       Archive->Push(spp);
       Archive->Push(planConfig);
       Archive->Push(photInt);
@@ -619,15 +684,12 @@ void File::SetWriteToRGB()
       {
          ValEntry* bitsAlloc = CopyValEntry(0x0028,0x0100);
          bitsAlloc->SetValue("8 ");
-         bitsAlloc->SetLength(2);
 
          ValEntry* bitsStored = CopyValEntry(0x0028,0x0101);
          bitsStored->SetValue("8 ");
-         bitsStored->SetLength(2);
 
          ValEntry* highBit = CopyValEntry(0x0028,0x0102);
          highBit->SetValue("7 ");
-         highBit->SetLength(2);
 
          Archive->Push(bitsAlloc);
          Archive->Push(bitsStored);
@@ -636,7 +698,7 @@ void File::SetWriteToRGB()
    }
    else
    {
-      SetWriteToDecompressed();
+      SetWriteToRaw();
    }
 }
 
@@ -673,7 +735,6 @@ void File::SetWriteFileTypeToExplicitVR()
 
    ValEntry* tss = CopyValEntry(0x0002,0x0010);
    tss->SetValue(ts);
-   tss->SetLength(ts.length());
 
    Archive->Push(tss);
 }
@@ -685,7 +746,8 @@ void File::SetWriteFileTypeToImplicitVR()
 
    ValEntry* tss = CopyValEntry(0x0002,0x0010);
    tss->SetValue(ts);
-   tss->SetLength(ts.length());
+
+   Archive->Push(tss);
 }
 
 void File::RestoreWriteFileType()
@@ -695,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 )
    {
@@ -717,20 +781,19 @@ void File::SetWriteToLibido()
 
    ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
    libidoCode->SetValue("ACRNEMA_LIBIDO_1.1");
-   libidoCode->SetLength(10);
    Archive->Push(libidoCode);
 }
 
 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" )
       {
          ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
          libidoCode->SetValue("");
-         libidoCode->SetLength(0);
          Archive->Push(libidoCode);
       }
    }
@@ -779,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