]> Creatis software - gdcm.git/blobdiff - src/gdcmFileHelper.cxx
User may now use
[gdcm.git] / src / gdcmFileHelper.cxx
index c99d06471a0fd7fbc9e47e25453425c8c2df7ef0..0bf7bf7d11f499ad4859da40f8853edfe54b1e18 100644 (file)
@@ -4,8 +4,8 @@
   Module:    $RCSfile: gdcmFileHelper.cxx,v $
   Language:  C++
 
-  Date:      $Date: 2005/05/27 10:51:00 $
-  Version:   $Revision: 1.42 $
+  Date:      $Date: 2005/07/23 01:59:21 $
+  Version:   $Revision: 1.50 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -145,25 +145,6 @@ FileHelper::FileHelper(File *header)
    Initialize();
 }
 
-/**
- * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- *        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
- * \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).   
- * @param filename file to be opened for parsing
- */
-FileHelper::FileHelper(std::string const &filename )
-{
-   FileInternal = new File( filename );
-   SelfHeader = true;
-   Initialize();
-}
 
 /**
  * \brief canonical destructor
@@ -172,20 +153,20 @@ FileHelper::FileHelper(std::string const &filename )
  */
 FileHelper::~FileHelper()
 { 
-   if( PixelReadConverter )
+   if ( PixelReadConverter )
    {
       delete PixelReadConverter;
    }
-   if( PixelWriteConverter )
+   if ( PixelWriteConverter )
    {
       delete PixelWriteConverter;
    }
-   if( Archive )
+   if ( Archive )
    {
       delete Archive;
    }
 
-   if( SelfHeader )
+   if ( SelfHeader )
    {
       delete FileInternal;
    }
@@ -194,6 +175,39 @@ FileHelper::~FileHelper()
 
 //-----------------------------------------------------------------------------
 // Public
+
+/**
+ * \brief Sets the LoadMode of the internal gdcm::File as a boolean string. 
+ *        NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
+ *... (nothing more, right now)
+ *        WARNING : before using NO_SHADOW, be sure *all* your files
+ *        contain accurate values in the 0x0000 element (if any) 
+ *        of *each* Shadow Group. The parser will fail if the size is wrong !
+ * @param   loadMode Load mode to be used    
+ */
+void FileHelper::SetLoadMode(int loadMode) 
+{ 
+   GetFile()->SetLoadMode( loadMode ); 
+}
+/**
+ * \brief Sets the LoadMode of the internal gdcm::File
+ * @param  fileName name of the file to be open  
+ */
+void FileHelper::SetFileName(std::string const &fileName)
+{
+   FileInternal->SetFileName( fileName );
+}
+
+/**
+ * \brief   Loader  
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
+bool FileHelper::Load()
+{ 
+   return FileInternal->Load();
+}
+
 /**
  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
  *          through it's (group, element) and modifies it's content with
@@ -500,9 +514,27 @@ size_t FileHelper::GetRawDataSize()
  */
 uint8_t* FileHelper::GetLutRGBA()
 {
+   if ( PixelReadConverter->GetLutRGBA() ==0 )
+      PixelReadConverter->BuildLUTRGBA();
    return PixelReadConverter->GetLutRGBA();
 }
 
+/**
+ * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Number
+ */
+int FileHelper::GetLutItemNumber()
+{
+   return PixelReadConverter->GetLutItemNumber();
+}
+
+/**
+ * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Size
+ */
+int FileHelper::GetLutItemSize()
+{
+   return PixelReadConverter->GetLutItemSize();
+}
+
 /**
  * \brief Writes on disk A SINGLE Dicom file
  *        NO test is performed on  processor "Endiannity".
@@ -520,7 +552,7 @@ bool FileHelper::WriteRawData(std::string const &fileName)
       return false;
    }
 
-   if( PixelWriteConverter->GetUserData() )
+   if ( PixelWriteConverter->GetUserData() )
    {
       fp1.write( (char *)PixelWriteConverter->GetUserData(), 
                  PixelWriteConverter->GetUserDataSize() );
@@ -637,7 +669,7 @@ bool FileHelper::Write(std::string const &fileName)
    /// \todo the best trick would be *change* the recognition code
    ///       but pb expected if user deals with, e.g. COMPLEX images
    
-   if( WriteType == ACR_LIBIDO )
+   if ( WriteType == ACR_LIBIDO )
    {
       SetWriteToLibido();
    }
@@ -658,7 +690,7 @@ bool FileHelper::Write(std::string const &fileName)
    }
 
    bool check = CheckWriteIntegrity(); // verifies length
-   if(check)
+   if (check)
    {
       check = FileInternal->Write(fileName,WriteType);
    }
@@ -690,7 +722,7 @@ bool FileHelper::Write(std::string const &fileName)
  */
 bool FileHelper::CheckWriteIntegrity()
 {
-   if(PixelWriteConverter->GetUserData())
+   if ( PixelWriteConverter->GetUserData() )
    {
       int numberBitsAllocated = FileInternal->GetBitsAllocated();
       if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
@@ -707,13 +739,13 @@ bool FileHelper::CheckWriteIntegrity()
                      * FileInternal->GetSamplesPerPixel()
                      * ( numberBitsAllocated / 8 );
       size_t rgbSize = decSize;
-      if( FileInternal->HasLUT() )
+      if ( FileInternal->HasLUT() )
          rgbSize = decSize * 3;
 
       switch(WriteMode)
       {
          case WMODE_RAW :
-            if( decSize!=PixelWriteConverter->GetUserDataSize() )
+            if ( decSize!=PixelWriteConverter->GetUserDataSize() )
             {
                gdcmWarningMacro( "Data size (Raw) is incorrect. Should be " 
                            << decSize << " / Found :" 
@@ -722,7 +754,7 @@ bool FileHelper::CheckWriteIntegrity()
             }
             break;
          case WMODE_RGB :
-            if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
+            if ( rgbSize!=PixelWriteConverter->GetUserDataSize() )
             {
                gdcmWarningMacro( "Data size (RGB) is incorrect. Should be " 
                           << decSize << " / Found " 
@@ -742,15 +774,15 @@ bool FileHelper::CheckWriteIntegrity()
  */ 
 void FileHelper::SetWriteToRaw()
 {
-   if( FileInternal->GetNumberOfScalarComponents() == 3 
-    && !FileInternal->HasLUT())
+   if ( FileInternal->GetNumberOfScalarComponents() == 3 
+    && !FileInternal->HasLUT() )
    {
       SetWriteToRGB();
    } 
    else
    {
       ValEntry *photInt = CopyValEntry(0x0028,0x0004);
-      if(FileInternal->HasLUT())
+      if (FileInternal->HasLUT() )
       {
          photInt->SetValue("PALETTE COLOR ");
       }
@@ -763,9 +795,9 @@ void FileHelper::SetWriteToRaw()
                                        PixelReadConverter->GetRawSize());
 
       std::string vr = "OB";
-      if( FileInternal->GetBitsAllocated()>8 )
+      if ( FileInternal->GetBitsAllocated()>8 )
          vr = "OW";
-      if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files 
+      if ( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files 
          vr = "OB";
       BinEntry *pixel = 
          CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
@@ -787,7 +819,7 @@ void FileHelper::SetWriteToRaw()
  */ 
 void FileHelper::SetWriteToRGB()
 {
-   if(FileInternal->GetNumberOfScalarComponents()==3)
+   if ( FileInternal->GetNumberOfScalarComponents()==3 )
    {
       PixelReadConverter->BuildRGBImage();
       
@@ -800,7 +832,7 @@ void FileHelper::SetWriteToRGB()
       ValEntry *photInt = CopyValEntry(0x0028,0x0004);
       photInt->SetValue("RGB ");
 
-      if(PixelReadConverter->GetRGB())
+      if ( PixelReadConverter->GetRGB() )
       {
          PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
                                           PixelReadConverter->GetRGBSize());
@@ -812,9 +844,9 @@ void FileHelper::SetWriteToRGB()
       }
 
       std::string vr = "OB";
-      if( FileInternal->GetBitsAllocated()>8 )
+      if ( FileInternal->GetBitsAllocated()>8 )
          vr = "OW";
-      if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files 
+      if ( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files 
          vr = "OB";
       BinEntry *pixel = 
          CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
@@ -835,10 +867,13 @@ void FileHelper::SetWriteToRGB()
       Archive->Push(0x0028,0x1202);
       Archive->Push(0x0028,0x1203);
 
+      // push out Palette Color Lookup Table UID, if any
+      Archive->Push(0x0028,0x1199);
+
       // For old '24 Bits' ACR-NEMA
       // Thus, we have a RGB image and the bits allocated = 24 and 
       // samples per pixels = 1 (in the read file)
-      if(FileInternal->GetBitsAllocated()==24
+      if ( FileInternal->GetBitsAllocated()==24 
       {
          ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
          bitsAlloc->SetValue("8 ");
@@ -883,6 +918,10 @@ void FileHelper::RestoreWrite()
    Archive->Restore(0x0028,0x1202);
    Archive->Restore(0x0028,0x1203);
 
+   // For the Palette Color Lookup Table UID
+   Archive->Restore(0x0028,0x1203); 
+
+
    // group 0002 may be pushed out for ACR-NEMA writting purposes 
    Archive->Restore(0x0002,0x0000);
    Archive->Restore(0x0002,0x0001);
@@ -963,7 +1002,7 @@ void FileHelper::SetWriteToLibido()
    ValEntry *oldCol = dynamic_cast<ValEntry *>
                 (FileInternal->GetDocEntry(0x0028, 0x0011));
    
-   if( oldRow && oldCol )
+   if ( oldRow && oldCol )
    {
       std::string rows, columns; 
 
@@ -992,9 +1031,9 @@ void FileHelper::SetWriteToNoLibido()
 {
    ValEntry *recCode = dynamic_cast<ValEntry *>
                 (FileInternal->GetDocEntry(0x0008,0x0010));
-   if( recCode )
+   if ( recCode )
    {
-      if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
+      if ( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
       {
          ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
          libidoCode->SetValue("");
@@ -1030,7 +1069,7 @@ ValEntry *FileHelper::CopyValEntry(uint16_t group, uint16_t elem)
    DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
    ValEntry *newE;
 
-   if( oldE )
+   if ( oldE )
    {
       newE = new ValEntry(oldE->GetDictEntry());
       newE->Copy(oldE);
@@ -1057,11 +1096,11 @@ BinEntry *FileHelper::CopyBinEntry(uint16_t group, uint16_t elem,
    DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
    BinEntry *newE;
 
-   if( oldE ) 
-      if( oldE->GetVR()!=vr )
+   if ( oldE ) 
+      if ( oldE->GetVR()!=vr )
          oldE = NULL;
 
-   if( oldE )
+   if ( oldE )
    {
       newE = new BinEntry(oldE->GetDictEntry());
       newE->Copy(oldE);
@@ -1149,7 +1188,7 @@ void FileHelper::CheckMandatoryElements()
 
    // 'Implementation Version Name'
       ValEntry *e_0002_0013 = CopyValEntry(0x0002,0x0013);
-      e_0002_0013->SetValue("GDCM 1.0");
+      e_0002_0013->SetValue("GDCM 1.1");
       Archive->Push(e_0002_0013);
 
    //'Source Application Entity Title' Not Mandatory
@@ -1474,7 +1513,7 @@ uint8_t *FileHelper::GetRaw()
       // The Raw image migth not be loaded yet:
       std::ifstream *fp = FileInternal->OpenFile();
       PixelReadConverter->ReadAndDecompressPixelData( fp );
-      if(fp
+      if ( fp 
          FileInternal->CloseFile();
 
       raw = PixelReadConverter->GetRaw();
@@ -1502,5 +1541,30 @@ void FileHelper::Print(std::ostream &os, std::string const &)
    PixelReadConverter->Print(os);
 }
 
+#ifndef GDCM_LEGACY_REMOVE
+/**
+ * \brief 
+ *        Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
+ *        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
+ * \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).   
+ * @param filename file to be opened for parsing
+ * @deprecated  use SetFilename() + Load() methods
+ */
+FileHelper::FileHelper(std::string const &filename )
+{
+   FileInternal = new File( );
+   FileInternal->SetFileName( filename );
+   FileInternal->Load();
+   SelfHeader = true;
+   Initialize();
+}
+#endif
 //-----------------------------------------------------------------------------
 } // end namespace gdcm