gdcmHeader.cxx

Go to the documentation of this file.

// gdcmHeader.cxx
//-----------------------------------------------------------------------------
#include "gdcmHeader.h"

#include <stdio.h>
#include <cerrno>
#include <cctype>    // for isalpha

#include "gdcmUtil.h"
#include "gdcmTS.h"


//-----------------------------------------------------------------------------
// Constructor / Destructor
gdcmHeader::gdcmHeader(const char *InFilename, 
                       bool exception_on_error,
                       bool enable_sequences, 
                       bool ignore_shadow):
   gdcmParser(InFilename,exception_on_error,enable_sequences,ignore_shadow)
{ 
   
   // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
   // We may encounter the 'RETired' (0x0028, 0x0200) tag
   // (Image Location") . This Element contains the number of
   // the group that contains the pixel data (hence the "Pixel Data"
   // is found by indirection through the "Image Location").
   // Inside the group pointed by "Image Location" the searched element
   // is conventionally the element 0x0010 (when the norm is respected).
   // When the "Image Location" is absent we default to group 0x7fe0.
   
   // This IS the right place for the code
 
      std::string ImageLocation = GetEntryByNumber(0x0028, 0x0200);
      if ( ImageLocation == GDCM_UNFOUND ) { // Image Location
         GrPixel = 0x7fe0;                   // default value
      } else {
         GrPixel = (guint16) atoi( ImageLocation.c_str() );
      }   
      if (GrPixel == 0xe07f) // sometimes Image Location value doesn't follow 
         GrPixel = 0x7fe0;   // the supposed processor endianity. 
                             // see gdcmData/cr172241.dcm      
      if (GrPixel != 0x7fe0) 
         // This is a kludge for old dirty Philips imager.
         NumPixel = 0x1010;
      else
         NumPixel = 0x0010;
         
      TagKey key = gdcmDictEntry::TranslateToKey(GrPixel, NumPixel);
      countGrPixel = GetEntry().count(key);
}

gdcmHeader::gdcmHeader(bool exception_on_error) :
   gdcmParser(exception_on_error)
{
}

gdcmHeader::~gdcmHeader (void) {
}

//-----------------------------------------------------------------------------
// Print

// see gdcmParser.cxx
//-----------------------------------------------------------------------------
// Public

bool gdcmHeader::IsReadable(void) {
   if(!gdcmParser::IsReadable()) {
      return(false);
   }
   std::string res = GetEntryByNumber(0x0028, 0x0005);
   if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 ) 
      return false; // Image Dimensions
   if ( !GetHeaderEntryByNumber(0x0028, 0x0100) )
      return false; // "Bits Allocated"
   if ( !GetHeaderEntryByNumber(0x0028, 0x0101) )
      return false; // "Bits Stored"
   if ( !GetHeaderEntryByNumber(0x0028, 0x0102) )
      return false; // "High Bit"
   if ( !GetHeaderEntryByNumber(0x0028, 0x0103) )
      return false; // "Pixel Representation" i.e. 'Sign'
   return true;
}

bool gdcmHeader::IsJPEGBaseLineProcess1TransferSyntax(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   std::string Transfer = Element->GetValue();
   if ( Transfer == "1.2.840.10008.1.2.4.50" )
      return true;
   return false;
}

bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);
   return ( Element->GetValue() == "1.2.840.10008.1.2.4.51" );
}

bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   std::string Transfer = Element->GetValue();
   if ( Transfer == "1.2.840.10008.1.2.4.52" )
      return true;
   return false;
}

bool gdcmHeader::IsJPEGSpectralSelectionProcess6_8TransferSyntax(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   std::string Transfer = Element->GetValue();
   if ( Transfer == "1.2.840.10008.1.2.4.53" )
      return true;
   return false;
}

bool gdcmHeader::IsRLELossLessTransferSyntax(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   std::string Transfer = Element->GetValue();
   if ( Transfer == "1.2.840.10008.1.2.5" ) {
      return true;
    }
   return false;
}

bool gdcmHeader::IsJPEGLossless(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
    // faire qq chose d'intelligent a la place de ça
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   const char * Transfert = Element->GetValue().c_str();
   if ( memcmp(Transfert+strlen(Transfert)-2 ,"70",2)==0) return true;
   if ( memcmp(Transfert+strlen(Transfert)-2 ,"55",2)==0) return true;
   if (Element->GetValue() == "1.2.840.10008.1.2.4.57")   return true;

   return false;
}

bool gdcmHeader::IsJPEG2000(void) {
   gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
   if ( !Element )
      return false;
   LoadHeaderEntrySafe(Element);

   std::string Transfer = Element->GetValue();
   if (    (Transfer == "1.2.840.10008.1.2.4.90") 
        || (Transfer == "1.2.840.10008.1.2.4.91") )
      return true;
   return false;
}

bool gdcmHeader::IsDicomV3(void) {
   // Checking if Transfert Syntax exists is enough
   // Anyway, it's to late check if the 'Preamble' was found ...
   // And ... would it be a rich idea to check ?
   // (some 'no Preamble' DICOM images exist !)
   return (GetHeaderEntryByNumber(0x0002, 0x0010) != NULL);
}

int gdcmHeader::GetXSize(void) {
   std::string StrSize;
   StrSize = GetEntryByNumber(0x0028,0x0011);
   if (StrSize == GDCM_UNFOUND)
      return 0;
   return atoi(StrSize.c_str());
}

int gdcmHeader::GetYSize(void) {
   std::string StrSize = GetEntryByNumber(0x0028,0x0010);
   if (StrSize != GDCM_UNFOUND)
      return atoi(StrSize.c_str());
   if ( IsDicomV3() )
      return 0;
   else
      // The Rows (0028,0010) entry was optional for ACR/NEMA. It might
      // hence be a signal (1d image). So we default to 1:
      return 1;
}

int gdcmHeader::GetZSize(void) {
   // Both  DicomV3 and ACR/Nema consider the "Number of Frames"
   // as the third dimension.
   std::string StrSize = GetEntryByNumber(0x0028,0x0008);
   if (StrSize != GDCM_UNFOUND)
      return atoi(StrSize.c_str());

   // We then consider the "Planes" entry as the third dimension 
   StrSize = GetEntryByNumber(0x0028,0x0012);
   if (StrSize != GDCM_UNFOUND)
      return atoi(StrSize.c_str());
   return 1;
}

int gdcmHeader::GetBitsStored(void) {  
   std::string StrSize = GetEntryByNumber(0x0028,0x0101);
   if (StrSize == GDCM_UNFOUND)
      return 0;  // It's supposed to be mandatory
                 // the caller will have to check
   return atoi(StrSize.c_str());
}

int gdcmHeader::GetBitsAllocated(void) {
   std::string StrSize = GetEntryByNumber(0x0028,0x0100);
   if (StrSize == GDCM_UNFOUND)
      return 0; // It's supposed to be mandatory
                // the caller will have to check
   return atoi(StrSize.c_str());
}

int gdcmHeader::GetSamplesPerPixel(void) {
   std::string StrSize = GetEntryByNumber(0x0028,0x0002);
   if (StrSize == GDCM_UNFOUND)
      return 1; // Well, it's supposed to be mandatory ...
                // but sometimes it's missing : *we* assume Gray pixels
   return atoi(StrSize.c_str());
}

int gdcmHeader::GetPlanarConfiguration(void) {
   std::string StrSize = GetEntryByNumber(0x0028,0x0006);
   if (StrSize == GDCM_UNFOUND)
      return 0;
   return atoi(StrSize.c_str());
}

int gdcmHeader::GetPixelSize(void) {
   std::string PixelType = GetPixelType();
   if (PixelType == "8U"  || PixelType == "8S")
      return 1;
   if (PixelType == "16U" || PixelType == "16S")
      return 2;
   if (PixelType == "32U" || PixelType == "32S")
      return 4;
   if (PixelType == "FD")
      return 8;         
   dbg.Verbose(0, "gdcmHeader::GetPixelSize: Unknown pixel type");
   return 0;
}

std::string gdcmHeader::GetPixelType(void) { 
   std::string BitsAlloc = GetEntryByNumber(0x0028, 0x0100); // Bits Allocated
   if (BitsAlloc == GDCM_UNFOUND) {
      dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Bits Allocated");
      BitsAlloc = std::string("16");
   }
   if (BitsAlloc == "64")            // )
      return ("FD");
   if (BitsAlloc == "12")            // It will be unpacked
      BitsAlloc = std::string("16");
   else if (BitsAlloc == "24")       // (in order no to be messed up
      BitsAlloc = std::string("8");  // by old RGB images)
     
   std::string Signed = GetEntryByNumber(0x0028, 0x0103); // "Pixel Representation"
   if (Signed == GDCM_UNFOUND) {
      dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Pixel Representation");
      BitsAlloc = std::string("0");
   }
   if (Signed == "0")
      Signed = std::string("U");
   else
      Signed = std::string("S");

   return( BitsAlloc + Signed);
}


size_t gdcmHeader::GetPixelOffset(void) { 
   //
   // If the element (0x0088,0x0200) 'icone image sequence' is found
   // (grPixel,numPixel) is stored twice : the first one for the icon
   // the second one for the image ...
   // pb : sometimes , (0x0088,0x0200) exists, but doesn't contain *anything*
   // see gdcmData/MxTwinLossLess.dcm ...

   //std::string icone = GetEntryByNumber(0x0088,0x0200); //icone image sequence
      
   IterHT it = GetHeaderEntrySameNumber(GrPixel,NumPixel);          
   TagKey key = gdcmDictEntry::TranslateToKey(GrPixel,NumPixel);
   gdcmHeaderEntry* PixelElement;
   if (countGrPixel == 1)   
      PixelElement = (it.first)->second;
   else {
      PixelElement = (++it.first)->second; // hope there are no more than 2 !
   } 
   if (PixelElement) {
      return PixelElement->GetOffset();
   } else {
/*      std::cout << "Big trouble : Pixel Element ("
                << std::hex << GrPixel<<","<< NumPixel<< ") NOT found"
                << std::endl;  */
      return 0;
   }     
}
// TODO : unify those two (previous one and next one)
size_t gdcmHeader::GetPixelAreaLength(void) { 
          
   IterHT it = GetHeaderEntrySameNumber(GrPixel,NumPixel);          
   TagKey key = gdcmDictEntry::TranslateToKey(GrPixel,NumPixel);
   gdcmHeaderEntry* PixelElement;
  
  if (countGrPixel==1)  
      PixelElement = (it.first)->second;
   else
      PixelElement = (++it.first)->second;

   if (PixelElement) {
      return PixelElement->GetLength();
   } else {
/*      std::cout << "Big trouble : Pixel Element ("
                << std::hex << GrPixel<<","<< NumPixel<< ") NOT found"
                << std::endl;*/
      return 0;
   }
}

bool gdcmHeader::HasLUT(void) {

   // Check the presence of the LUT Descriptors, and LUT Tables    
   // LutDescriptorRed    
   if ( !GetHeaderEntryByNumber(0x0028,0x1101) )
      return false;
   // LutDescriptorGreen 
   if ( !GetHeaderEntryByNumber(0x0028,0x1102) )
      return false;
   // LutDescriptorBlue 
   if ( !GetHeaderEntryByNumber(0x0028,0x1103) )
      return false;   
   // Red Palette Color Lookup Table Data
   if ( !GetHeaderEntryByNumber(0x0028,0x1201) )
      return false; 
   // Green Palette Color Lookup Table Data       
   if ( !GetHeaderEntryByNumber(0x0028,0x1202) )
      return false;
   // Blue Palette Color Lookup Table Data      
   if ( !GetHeaderEntryByNumber(0x0028,0x1203) )
      return false;   
   return true;
}

int gdcmHeader::GetLUTNbits(void) {
   std::vector<std::string> tokens;
   //int LutLength;
   //int LutDepth;
   int LutNbits;
   //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red = Lookup Table Desc-Blue
   // Consistency already checked in GetLUTLength
   std::string LutDescription = GetEntryByNumber(0x0028,0x1101);
   if (LutDescription == GDCM_UNFOUND)
      return 0;
   tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
   Tokenize (LutDescription, tokens, "\\");
   //LutLength=atoi(tokens[0].c_str());
   //LutDepth=atoi(tokens[1].c_str());
   LutNbits=atoi(tokens[2].c_str());
   tokens.clear();
   return LutNbits;
}

unsigned char * gdcmHeader::GetLUTRGBA(void) {
// Not so easy : see 
// http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables

//  if Photometric Interpretation # PALETTE COLOR, no LUT to be done
   if (GetEntryByNumber(0x0028,0x0004) != "PALETTE COLOR ") {
        return NULL;
   }  
   int lengthR, debR, nbitsR;
   int lengthG, debG, nbitsG;
   int lengthB, debB, nbitsB;
   
// Get info from Lut Descriptors
// (the 3 LUT descriptors may be different)    
   std::string LutDescriptionR = GetEntryByNumber(0x0028,0x1101);
   if (LutDescriptionR == GDCM_UNFOUND)
      return NULL;
   std::string LutDescriptionG = GetEntryByNumber(0x0028,0x1102);
   if (LutDescriptionG == GDCM_UNFOUND)
      return NULL;   
   std::string LutDescriptionB = GetEntryByNumber(0x0028,0x1103);
   if (LutDescriptionB == GDCM_UNFOUND)
      return NULL;
      
   std::vector<std::string> tokens;
      
   tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
   Tokenize (LutDescriptionR, tokens, "\\");
   lengthR=atoi(tokens[0].c_str()); // Red LUT length in Bytes
   debR   =atoi(tokens[1].c_str()); // subscript of the first Lut Value
   nbitsR =atoi(tokens[2].c_str()); // Lut item size (in Bits)
   tokens.clear();
   
   tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
   Tokenize (LutDescriptionG, tokens, "\\");
   lengthG=atoi(tokens[0].c_str()); // Green LUT length in Bytes
   debG   =atoi(tokens[1].c_str()); // subscript of the first Lut Value
   nbitsG =atoi(tokens[2].c_str()); // Lut item size (in Bits)
   tokens.clear();  
   
   tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
   Tokenize (LutDescriptionB, tokens, "\\");
   lengthB=atoi(tokens[0].c_str()); // Blue LUT length in Bytes
   debB   =atoi(tokens[1].c_str()); // subscript of the first Lut Value
   nbitsB =atoi(tokens[2].c_str()); // Lut item size (in Bits)
   tokens.clear();
 
   // Load LUTs into memory, (as they were stored on disk)
   unsigned char *lutR = (unsigned char *)
                         GetEntryVoidAreaByNumber(0x0028,0x1201);
   unsigned char *lutG = (unsigned char *)
                         GetEntryVoidAreaByNumber(0x0028,0x1202);
   unsigned char *lutB = (unsigned char *)
                         GetEntryVoidAreaByNumber(0x0028,0x1203); 
   
   if (!lutR || !lutG || !lutB ) {
        return NULL;
   } 
   // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT 
   
   unsigned char *LUTRGBA = (unsigned char *)calloc(1024,1); // 256 * 4 (R, G, B, Alpha) 
   if (!LUTRGBA) {
      return NULL;
   }
   memset(LUTRGBA, 0, 1024);
        // Bits Allocated
   int nb;
   std::string str_nb = GetEntryByNumber(0x0028,0x0100);
   if (str_nb == GDCM_UNFOUND ) {
      nb = 16;
   } else {
      nb = atoi(str_nb.c_str() );
   }  
   int mult;

   if (nbitsR==16 && nb==8) // when LUT item size is different than pixel size
      mult=2;               // high byte must be = low byte 
   else                     // See PS 3.3-2003 C.11.1.1.2 p 619
      mult=1; 
 
   // if we get a black image, let's just remove the '+1'
   // from 'i*mult+1' and check again 
   // if it works, we shall have to check the 3 Palettes
   // to see which byte is ==0 (first one, or second one)
   // and fix the code
   // We give up the checking to avoid some (useless ?)overhead 
   // (optimistic asumption)
   unsigned char *a;      
   int i;

   a = LUTRGBA+0;
   for(i=0;i<lengthR;i++) {
      *a = lutR[i*mult+1]; 
      a+=4;       
   }        
   a = LUTRGBA+1;
   for(i=0;i<lengthG;i++) {
      *a = lutG[i*mult+1]; 
      a+=4;       
   }  
   a = LUTRGBA+2;
   for(i=0;i<lengthB;i++) {
      *a = lutB[i*mult+1]; 
      a+=4;       
   }  
   a = LUTRGBA+3;
   for(i=0;i<256;i++) {
      *a = 1; // Alpha component
      a+=4; 
   } 
   
   //How to free the now useless LUTs?
   //free(LutR); free(LutB); free(LutG); // Seg Fault when used
   return(LUTRGBA);   
} 

std::string gdcmHeader::GetTransfertSyntaxName(void) { 
   // use the gdcmTS (TS : Transfert Syntax)
   std::string TransfertSyntax = GetEntryByNumber(0x0002,0x0010);
   if (TransfertSyntax == GDCM_UNFOUND) {
      dbg.Verbose(0, "gdcmHeader::GetTransfertSyntaxName: unfound Transfert Syntax (0002,0010)");
      return "Uncompressed ACR-NEMA";
   }
   // we do it only when we need it
   gdcmTS * ts = gdcmGlobal::GetTS();
   std::string tsName=ts->GetValue(TransfertSyntax);
   //delete ts; // Seg Fault when deleted ?!
   return tsName;
}

void gdcmHeader::SetImageDataSize(size_t ImageDataSize) {
   std::string content1;
   char car[20];
        
   // Assumes HeaderEntry (GrPixel, NumPixel) is unique ...   
   // TODO deal with multiplicity (see gdcmData/icone.dcm)      
   sprintf(car,"%d",ImageDataSize);
 
   gdcmHeaderEntry *a = GetHeaderEntryByNumber(GrPixel, NumPixel);
   a->SetLength(ImageDataSize);
                
   ImageDataSize+=8;
   sprintf(car,"%d",ImageDataSize);
   content1=car;        
   SetEntryByNumber(content1, GrPixel, NumPixel);
}


 bool gdcmHeader::operator<(gdcmHeader &header){
   std::string s1,s2;

   // Patient Name
   s1=this->GetEntryByNumber(0x0010,0x0010);
   s2=header.GetEntryByNumber(0x0010,0x0010);
   if(s1 < s2)
           return(true);
   else if(s1 > s2)
           return(false);
   else
   {
      // Patient ID
      s1=this->GetEntryByNumber(0x0010,0x0020);
      s2=header.GetEntryByNumber(0x0010,0x0020);
      if (s1 < s2)
              return(true);
      else if (s1 > s2)
         return(1);
      else
      {
              // Study Instance UID
         s1=this->GetEntryByNumber(0x0020,0x000d);
         s2=header.GetEntryByNumber(0x0020,0x000d);
         if (s1 < s2)
                 return(true);
         else if(s1 > s2)
                 return(false);
         else
         {
                 // Serie Instance UID          
            s1=this->GetEntryByNumber(0x0020,0x000e);
            s2=header.GetEntryByNumber(0x0020,0x000e);
            if (s1 < s2)
               return(true);
            else if(s1 > s2)
               return(false);
         }
      }
   }
   return(false);
}

//-----------------------------------------------------------------------------
// Protected

bool gdcmHeader::anonymizeHeader() {

  gdcmHeaderEntry *patientNameHE = GetHeaderEntryByNumber (0x0010, 0x0010);
 // gdcmHeaderEntry *patientIDHE   = GetHeaderEntryByNumber (0x0010, 0x0020); 
    
  ReplaceIfExistByNumber ("  ",0x0010, 0x2154); // Telephone   
  ReplaceIfExistByNumber ("  ",0x0010, 0x1040); // Adress
  ReplaceIfExistByNumber ("  ",0x0010, 0x0020); // Patient ID
  
  if (patientNameHE) {
     std::string StudyInstanceUID =  GetEntryByNumber (0x0020, 0x000d);
     if (StudyInstanceUID !=GDCM_UNFOUND)
        ReplaceOrCreateByNumber(StudyInstanceUID, 0x0010, 0x0010);
     else
        ReplaceOrCreateByNumber("anonymised", 0x0010, 0x0010);            
  }
  
  // Just for fun :-(
  // (if any) remove or replace 
  
//0008 0012 DA ID Instance Creation Date
//0008 0020 DA ID Study Date
//0008 0021 DA ID Series Date
//0008 0022 DA ID Acquisition Date
//0008 0023 DA ID Content Date
//0008 0024 DA ID Overlay Date
//0008 0025 DA ID Curve Date
//0008 002a DT ID Acquisition Datetime
//0018 9074 DT ACQ Frame Acquisition Datetime
//0018 9151 DT ACQ Frame Reference Datetime
//0018 a002 DT ACQ Contribution Date Time
//0020 3403 SH REL Modified Image Date (RET)
//0032 0032 DA SDY Study Verified Date
//0032 0034 DA SDY Study Read Date
//0032 1000 DA SDY Scheduled Study Start Date
//0032 1010 DA SDY Scheduled Study Stop Date
//0032 1040 DA SDY Study Arrival Date
//0032 1050 DA SDY Study Completion Date
//0038 001a DA VIS Scheduled Admission Date
//0038 001c DA VIS Scheduled Discharge Date
//0038 0020 DA VIS Admitting Date
//0038 0030 DA VIS Discharge Date
//0040 0002 DA PRC Scheduled Procedure Step Start Date
//0040 0004 DA PRC Scheduled Procedure Step End Date
//0040 0244 DA PRC Performed Procedure Step Start Date
//0040 0250 DA PRC Performed Procedure Step End Date
//0040 2004 DA PRC Issue Date of Imaging Service Request
//0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
//0040 4011 DT PRC Expected Completion Date and Time
//0040 a030 DT PRC Verification Date Time
//0040 a032 DT PRC Observation Date Time
//0040 a120 DT PRC DateTime
//0040 a121 DA PRC Date
//0040 a13a DT PRC Referenced Datetime
//0070 0082 DA ??? Presentation Creation Date
//0100 0420 DT ??? SOP Autorization Date and Time
//0400 0105 DT ??? Digital Signature DateTime
//2100 0040 DA PJ Creation Date
//3006 0008 DA SSET Structure Set Date
//3008 0024 DA ??? Treatment Control Point Date
//3008 0054 DA ??? First Treatment Date
//3008 0056 DA ??? Most Recent Treatment Date
//3008 0162 DA ??? Safe Position Exit Date
//3008 0166 DA ??? Safe Position Return Date
//3008 0250 DA ??? Treatment Date
//300a 0006 DA RT RT Plan Date
//300a 022c DA RT Air Kerma Rate Reference Date
//300e 0004 DA RT Review Date
 return true;  
 }
//-----------------------------------------------------------------------------
// Private

//-----------------------------------------------------------------------------

---