]> Creatis software - gdcm.git/blobdiff - src/gdcmTS.cxx
* Builder/ : add something to facilitate the RPM creation of gdcm
[gdcm.git] / src / gdcmTS.cxx
index f0f2049c98b396da2975088157dc1df339c6db42..598c92dbfdd97e2a05102cbf6052db878abc4056 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTS.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 16:44:43 $
-  Version:   $Revision: 1.35 $
+  Date:      $Date: 2005/02/11 15:22:18 $
+  Version:   $Revision: 1.43 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 // TODO
 // a lot of troubles expected with TS : 1.2.840.113619.5.2
 // Implicit VR - Big Endian
-// see : http://www.gemedicalsystemseurope.com/euen/it_solutions/pdf/lsqxi_rev2.pdf
+// http://www.gemedicalsystemseurope.com/euen/it_solutions/pdf/lsqxi_rev2.pdf
 // 
 
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
+/// \brief Transfer Syntaxes gdcm deals with (internal use onky)
 static const char *SpecialStrings[] =  {
   // Implicit VR Little Endian
   "1.2.840.10008.1.2",
@@ -57,8 +58,13 @@ static const char *SpecialStrings[] =  {
   "1.2.840.10008.1.2.4.55",
   // JPEG Lossless, Non-Hierarchical (Process 14)
   "1.2.840.10008.1.2.4.57",
-  // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14, [Selection Value 1])
+  // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14,
+  //                                                       [Selection Value 1])
   "1.2.840.10008.1.2.4.70",
+  // JPEG-LS Lossless Image Compression
+  "1.2.840.10008.1.2.4.80",
+  // JPEG-LS Lossy (Near-Lossless) Image Compression
+  "1.2.840.10008.1.2.4.81",
   // JPEG 2000 Lossless
   "1.2.840.10008.1.2.4.90",
   // JPEG 2000
@@ -69,7 +75,11 @@ static const char *SpecialStrings[] =  {
   "Unknown Transfer Syntax"
 };
 
+//-----------------------------------------------------------------------------
+/// \brief auto generated function, to fill up the Dicom Dictionnary,
+///       if relevant file is not found on user's disk
 void FillDefaultTSDict(TSHT &ts);
+
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 TS::TS() 
@@ -78,7 +88,7 @@ TS::TS()
    std::ifstream from(filename.c_str());
    if( !from )
    {
-      gdcmVerboseMacro("Can't open dictionary" << filename.c_str());
+      gdcmWarningMacro("Can't open dictionary" << filename.c_str());
       FillDefaultTSDict( TsMap );
    }
    else
@@ -101,53 +111,56 @@ TS::TS()
    }
 }
 
-//-----------------------------------------------------------------------------
 TS::~TS() 
 {
    TsMap.clear();
 }
 
-//-----------------------------------------------------------------------------
-// Print
-/**
- * \ingroup VR
- * \brief   Print all 
- * @param   os The output stream to be written to.
- */
-void TS::Print(std::ostream &os) 
-{
-   std::ostringstream s;
-
-   for (TSHT::const_iterator it = TsMap.begin(); it != TsMap.end(); ++it)
-   {
-      s << "TS : " << it->first << " = " << it->second << std::endl;
-   }
-   os << s.str();
-}
-
 //-----------------------------------------------------------------------------
 // Public
+
+/// \brief returns occurence number of the given key
 int TS::Count(TSKey const &key) 
 {
    return TsMap.count(key);
 }
 
-TSAtr const & TS::GetValue(TSKey const &key) 
+/// \brief returns the human reabable value of a Transfer Synatx string 
+TSAtr const &TS::GetValue(TSKey const &key) 
 {
-   TSHT::const_iterator it = TsMap.find(key);
+   // First thing clean up the string 
+   // (sometime the transfer syntax is padded with spaces)
+   std::string copy = key;
+   while ( copy.size() && !isdigit((unsigned char)copy[copy.size()-1]) )
+   {
+      copy.erase(copy.size()-1, 1);
+   }
+
+   TSHT::const_iterator it = TsMap.find(copy);
    if (it == TsMap.end())
    {
       return GDCM_UNFOUND;
    }
    return it->second;
 }
-
+/**
+ * \brief   Determines if the key passed corresponds to a 'Transfer Syntax'
+ *          as defined in DICOM (and stored in gdcm::TS class)
+ * @return  True when key is an actual 'Transfer Syntax'. False in all
+ *          other cases.
+ */
 bool TS::IsTransferSyntax(TSKey const &key)
 {
    TSHT::const_iterator it = TsMap.find(key);
    return it != TsMap.end();
 }
 
+/**
+ * \brief   Determines if the Transfer Syntax was already encountered
+ *          and if it corresponds to a Run Length Encoding Lossless one
+ * @return  True when Run Length Encoding Lossless found. False in all
+ *          other cases.
+ */
 bool TS::IsRLELossless(TSKey const &key)
 {
    bool r = false;
@@ -162,6 +175,12 @@ bool TS::IsRLELossless(TSKey const &key)
    return r;
 }
 
+/**
+ * \brief   Determines if the Transfer Syntax was already encountered
+ *          and if it corresponds to a 'classical' JPEG Lossless one
+ * @return  True when 'classical' Lossless found. False in all
+ *          other cases.
+ */
 bool TS::IsJPEGLossless(TSKey const &key)
 {
    bool r = false;
@@ -178,6 +197,29 @@ bool TS::IsJPEGLossless(TSKey const &key)
    return r;
 }
 
+/**
+ * \brief   Determines if the Transfer Syntax was already encountered
+ *          and if it corresponds to a 'classical' JPEG Lossy one
+ * @return  True when 'classical' Lossy found. False in all
+ *          other cases.
+ */
+bool TS::IsJPEGLossy(TSKey const &key)
+{
+   bool r = false;
+   // First check this is an actual transfer syntax
+   if( IsTransferSyntax(key) )
+   {
+      if ( key == SpecialStrings[JPEGBaselineProcess1]
+        || key == SpecialStrings[JPEGExtendedProcess2_4]
+        || key == SpecialStrings[JPEGExtendedProcess3_5]
+        || key == SpecialStrings[JPEGSpectralSelectionProcess6_8] )
+      {
+         r = true;
+      }
+   }
+   return r;
+}
+
 /**
  * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEG2000 one
@@ -200,8 +242,8 @@ bool TS::IsJPEG2000(TSKey const &key)
 }
 
 /**
- * \brief   Determines if the Transfer Syntax corresponds to any form
- *          of Jpeg encoded Pixel data.
+ * \brief   Determines if the Transfer Syntax corresponds to 
+ *          'classical' Jpeg Lossless or Jpeg lossy.
  * @return  True when any form of JPEG found. False otherwise.
  */
 bool TS::IsJPEG(TSKey const &key)
@@ -210,12 +252,9 @@ bool TS::IsJPEG(TSKey const &key)
    // First check this is an actual transfer syntax
    if( IsTransferSyntax(key) )
    {
-      if ( key == SpecialStrings[JPEGBaselineProcess1]
-        || key == SpecialStrings[JPEGExtendedProcess2_4]
-        || key == SpecialStrings[JPEGExtendedProcess3_5]
-        || key == SpecialStrings[JPEGSpectralSelectionProcess6_8]
-        || IsJPEGLossless( key ) 
-        || IsJPEG2000( key ) )
+      if ( IsJPEGLossy( key )
+        || IsJPEGLossless( key )
+         )
       {
          r = true;
       }
@@ -224,18 +263,18 @@ bool TS::IsJPEG(TSKey const &key)
 }
 
 /**
- * \brief   Determines if the Transfer Syntax corresponds to encapsulated
- *          of encoded Pixel Data (as opposed to native).
- * @return  True when encapsulated. False when native.
+ * \brief   Determines if the Transfer Syntax corresponds to any form
+ *          of Jpeg-LS encoded Pixel data.
+ * @return  True when any form of JPEG-LS found. False otherwise.
  */
-bool TS::IsEncapsulate(TSKey const &key)
+bool TS::IsJPEGLS(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
    if( IsTransferSyntax(key) )
    {
-      if ( key == SpecialStrings[RLELossless]
-        || IsJPEG(key) )
+      if ( key == SpecialStrings[JPEGLSLossless]
+        || key == SpecialStrings[JPEGLSNearLossless] ) 
       {
          r = true;
       }
@@ -268,5 +307,21 @@ const char* TS::GetSpecialTransferSyntax(SpecialType t)
 // Private
 
 //-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   Print all 
+ * @param   os The output stream to be written to.
+ */
+void TS::Print(std::ostream &os) 
+{
+   std::ostringstream s;
 
+   for (TSHT::const_iterator it = TsMap.begin(); it != TsMap.end(); ++it)
+   {
+      s << "TS : " << it->first << " = " << it->second << std::endl;
+   }
+   os << s.str();
+}
+
+//-----------------------------------------------------------------------------
 } // end namespace gdcm