]> Creatis software - gdcm.git/blobdiff - src/gdcmTS.cxx
fix mistyping
[gdcm.git] / src / gdcmTS.cxx
index b8a3da10795b541e10e880650d5e8c4b3331ba96..93e9ef3b1b3bf317f9c81b9441db48799e1e9c93 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTS.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/02 15:07:41 $
-  Version:   $Revision: 1.41 $
+  Date:      $Date: 2009/03/04 08:57:42 $
+  Version:   $Revision: 1.56 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <fstream>
 #include <string>
 #include <iostream>
+#include <ctype.h> // for isdigit
 
 // TODO
-// a lot of troubles expected with TS : 1.2.840.113619.5.2
+// 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
+// G.E. deliberately violated a lot of Dicom rules are
+// (probabely to avoid other people to read their images)
+// Just try and error on new images :
+// PrintFile debug filein=...
+// and fix the bugs
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
+/// \brief Transfer Syntaxes gdcm deals with (internal use only)
 static const char *SpecialStrings[] =  {
   // Implicit VR Little Endian
   "1.2.840.10008.1.2",
-  // Implicit VR Big Endian DLX (G.E Private)
+  // Implicit VR Big Endian (G.E Private)
   "1.2.840.113619.5.2",
   // Explicit VR Little Endian
   "1.2.840.10008.1.2.1",
@@ -57,7 +63,8 @@ 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",
@@ -69,22 +76,33 @@ static const char *SpecialStrings[] =  {
   "1.2.840.10008.1.2.4.91",
   // RLE Lossless
   "1.2.840.10008.1.2.5",
+  // MPEG2 Main Profile @ Main Level
+  "1.2.840.10008.1.2.4.100",
+  
+  // The following are *not* t.s. but SOP uid
+  // Ultrasound Image Storage (Retired)
+  "1.2.840.10008.5.1.4.1.1.6",
+     
   // Unknown
-  "Unknown Transfer Syntax"
+  "Unknown Transfer Syntax", // Pretty sure we never use this case...
+  NULL // Compilers have no obligation to finish by NULL, do it ourself
 };
 
 //-----------------------------------------------------------------------------
+/// \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() 
 {
+
    std::string filename = DictSet::BuildDictPath() + DICT_TS;
    std::ifstream from(filename.c_str());
-   if( !from )
+   if ( !from )
    {
-      gdcmVerboseMacro("Can't open dictionary" << filename.c_str());
+      gdcmWarningMacro("Can't open dictionary" << filename.c_str());
       FillDefaultTSDict( TsMap );
    }
    else
@@ -98,11 +116,12 @@ TS::TS()
          from >> std::ws;
          std::getline(from, name);
 
-         if(key != "")
+         if (key != "")
          {
             TsMap[key] = name;
          }
       }
+
       from.close();
    }
 }
@@ -114,14 +133,18 @@ TS::~TS()
 
 //-----------------------------------------------------------------------------
 // Public
+
+/// \brief returns occurence number of the given key
 int TS::Count(TSKey const &key) 
 {
    return TsMap.count(key);
 }
 
+/// \brief returns the human readable value of a Transfer Syntax string 
 TSAtr const &TS::GetValue(TSKey const &key) 
 {
-   // First thing clean up the string sometime the transfer syntax is padded with spaces
+   // First thing clean up the string 
+   // (sometimes the transfer syntax is padded with spaces)
    std::string copy = key;
    while ( copy.size() && !isdigit((unsigned char)copy[copy.size()-1]) )
    {
@@ -138,8 +161,8 @@ TSAtr const &TS::GetValue(TSKey const &key)
 /**
  * \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.
+ * @return  True when key is an actual 'Transfer Syntax'. 
+ *          False in all other cases.
  */
 bool TS::IsTransferSyntax(TSKey const &key)
 {
@@ -150,14 +173,14 @@ bool TS::IsTransferSyntax(TSKey const &key)
 /**
  * \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.
+ * @return  True when Run Length Encoding Lossless found. 
+ *          False in all other cases.
  */
 bool TS::IsRLELossless(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
-   if( IsTransferSyntax(key) )
+   if ( IsTransferSyntax(key) )
    {
       if ( key == SpecialStrings[RLELossless] )
       {
@@ -170,14 +193,14 @@ bool TS::IsRLELossless(TSKey const &key)
 /**
  * \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.
+ * @return  True when 'classical' Lossless found. 
+ *          False in all other cases.
  */
 bool TS::IsJPEGLossless(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
-   if( IsTransferSyntax(key) )
+   if ( IsTransferSyntax(key) )
    {
       if ( key == SpecialStrings[JPEGFullProgressionProcess10_12]
         || key == SpecialStrings[JPEGLosslessProcess14]
@@ -192,14 +215,14 @@ bool TS::IsJPEGLossless(TSKey const &key)
 /**
  * \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.
+ * @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 ( IsTransferSyntax(key) )
    {
       if ( key == SpecialStrings[JPEGBaselineProcess1]
         || key == SpecialStrings[JPEGExtendedProcess2_4]
@@ -215,14 +238,14 @@ bool TS::IsJPEGLossy(TSKey const &key)
 /**
  * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEG2000 one
- * @return  True when JPEG2000 (Lossly or LossLess) found. False in all
- *          other cases.
+ * @return  True when JPEG2000 (Lossly or LossLess) found. 
+ *          False in all other cases.
  */
 bool TS::IsJPEG2000(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
-   if( IsTransferSyntax(key) )
+   if ( IsTransferSyntax(key) )
    {
       if ( key == SpecialStrings[JPEG2000Lossless]
         || key == SpecialStrings[JPEG2000] )
@@ -242,10 +265,12 @@ bool TS::IsJPEG(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
-   if( IsTransferSyntax(key) )
+   if ( IsTransferSyntax(key) )
    {
       if ( IsJPEGLossy( key )
         || IsJPEGLossless( key )
+        || IsJPEG2000( key )
+        || IsJPEGLS( key )
          )
       {
          r = true;
@@ -263,7 +288,7 @@ bool TS::IsJPEGLS(TSKey const &key)
 {
    bool r = false;
    // First check this is an actual transfer syntax
-   if( IsTransferSyntax(key) )
+   if ( IsTransferSyntax(key) )
    {
       if ( key == SpecialStrings[JPEGLSLossless]
         || key == SpecialStrings[JPEGLSNearLossless] ) 
@@ -274,6 +299,48 @@ bool TS::IsJPEGLS(TSKey const &key)
    return r;
 }
 
+/**
+ * \brief   Determines if the Transfer Syntax corresponds to any form
+ *          of MPEG encoded Pixel data.
+ * @return  True when any form of MPEG found. False otherwise.
+ */
+bool TS::IsMPEG(TSKey const &key)
+{
+   bool r = false;
+   // First check this is an actual transfer syntax
+   if ( IsTransferSyntax(key) )
+   {
+      if ( key == SpecialStrings[MPEG2MainProfile] ) 
+      {
+         r = true;
+      }
+   }
+   return r;
+}
+
+/**
+ * \brief   Determines if the SOP id corresponds to any form
+ *          of UltrasoundImageStorage_Retired.
+ * @return  True when Ultrasound Image Storage Retired. False otherwise.
+ */
+bool TS::IsUltrasoundImageStorage_Retired(TSKey const &key)
+{
+   bool r = false;
+   // First check this is an actual SOP id
+   if ( IsTransferSyntax(key) )
+   {
+      if ( key == SpecialStrings[UltrasoundImageStorage_Retired] ) 
+      {
+         r = true;
+      }
+   }
+   return r;
+}
+/**
+ * \brief   GetSpecialTransferSyntax ??
+ * @param  key TSKey const &key ??
+ * @return  TS::SpecialType ??.
+ */
 TS::SpecialType TS::GetSpecialTransferSyntax(TSKey const &key)
 {
    for (int i = 0; SpecialStrings[i] != NULL; i++)
@@ -283,11 +350,15 @@ TS::SpecialType TS::GetSpecialTransferSyntax(TSKey const &key)
          return SpecialType(i);
       }
    }
-
    return UnknownTS;
 }
 
-const char* TS::GetSpecialTransferSyntax(SpecialType t)
+/**
+ * \brief   GetSpecialTransferSyntax ??
+ * @param  t SpecialType t ??
+ * @return  char* TS : SpecialStrings[t] ??.
+ */
+const char *TS::GetSpecialTransferSyntax(SpecialType t)
 {
    return SpecialStrings[t];
 }
@@ -304,7 +375,7 @@ const char* TS::GetSpecialTransferSyntax(SpecialType t)
  * \brief   Print all 
  * @param   os The output stream to be written to.
  */
-void TS::Print(std::ostream &os
+void TS::Print(std::ostream &os,std::string const &)
 {
    std::ostringstream s;