lib/maracasVisuLib/src/interface/wxWindows/widgets/ThresholdImageView/ColorLayerImageView.cxx

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26 /**
  27  *  \file
  28  *  \author Eduardo Davila and Claire Mouton.
  29  *  \brief Class bbtk::ThresholdImageView.
  30  *  \date September 2012
  31  */
  32
  33 #include "ColorLayerImageView.h"
  34
  35 #include <vtkImageReslice.h>
  36 #include <vtkLookupTable.h>
  37 #include <vtkImageData.h>
  38
  39 #include <algorithm>
  40
  41
  42 //=========================================================================
  43 //=========================================================================
  44 //=========================================================================
  45 //=========================================================================
  46 ColorLayerImageView::ColorLayerImageView( )
  47 {
  48   _z2                                   =       0;
  49   _fix_dynamic          =       true;
  50   _color_type           =       false;
  51 }
  52
  53 //=========================================================================
  54 ColorLayerImageView::~ColorLayerImageView()
  55 {
  56 }
  57 //=========================================================================
  58
  59
  60 //----------------------------------------------------------------------------
  61 void ColorLayerImageView::SetSliceFixDynamic(bool fix_dynamic)
  62 {
  63   _fix_dynamic = fix_dynamic;
  64 }
  65
  66 //----------------------------------------------------------------------------
  67 void ColorLayerImageView::SetX2(int x2)
  68 {
  69   _x2 = x2;
  70 }
  71
  72 //----------------------------------------------------------------------------
  73 void ColorLayerImageView::SetY2(int y2)
  74 {
  75   _y2 = y2;
  76 }
  77
  78
  79 //----------------------------------------------------------------------------
  80 void ColorLayerImageView::SetZ2(int z2)
  81 {
  82   _z2 = z2;
  83 }
  84
  85 //----------------------------------------------------------------------------
  86 int ColorLayerImageView::GetX() // virtual
  87 {
  88   int result=0;
  89   if (_fix_dynamic==false)
  90     {
  91       result = _x2;
  92     }
  93   else
  94     {
  95       result = LayerImageBase::GetX();
  96     }
  97
  98   return result;
  99 }
 100
 101 //----------------------------------------------------------------------------
 102 int ColorLayerImageView::GetY() // virtual
 103 {
 104   int result=0;
 105   if (_fix_dynamic==false)
 106     {
 107       result = _y2;
 108     }
 109   else
 110     {
 111       result = LayerImageBase::GetY();
 112     }
 113
 114   return result;
 115 }
 116
 117 //----------------------------------------------------------------------------
 118 int ColorLayerImageView::GetZ() // virtual
 119 {
 120   int result=0;
 121   if (_fix_dynamic==false)
 122     {
 123       result = _z2;
 124     }
 125   else
 126     {
 127       result = LayerImageBase::GetZ();
 128     }
 129
 130   return result;
 131 }
 132
 133 //----------------------------------------------------------------------------
 134 void ColorLayerImageView::SetBaseColors(std::vector<double> & base_color)
 135 {
 136   // The base color vector must be of a size multiple of 3, not null.
 137 //EED  if ((base_color.size() != 0) && (base_color.size() % 3 == 0))
 138   if ( base_color.size() % 3 == 0)
 139         {
 140         _base_color = base_color;
 141         } else if (base_color.size() != 0)  // Otherwise, an exception should be thrown.
 142         {
 143         std::cout << "CM ColorLayerImageView::SetBaseColors : ERROR!!! The base color vector has an inconsistent size. It must be of a size multiple of 3, different from 0, but its size is: "<< base_color.size() << ". Therefore, the default values will be used as base colors." << std::endl;
 144         }
 145 }
 146
 147
 148 //----------------------------------------------------------------------------
 149 void ColorLayerImageView::SetBaseTransparence(std::vector<double> & base_transparence)
 150 {
 151   _transparence_level_boundary = base_transparence;
 152 }
 153
 154
 155 //----------------------------------------------------------------------------
 156 double ColorLayerImageView::GetBaseColors(unsigned int index)
 157 {
 158   if (_base_color.size() > index)
 159     return _base_color.at(index);
 160   // An exception should be thrown if the index does not exist in the color vector.
 161   else
 162     {
 163       std::cout << "CM ColorLayerImageView::GetBaseColors : ERROR!!! The index " << index << "is out of the base color vector range." << std ::endl;
 164       return -1.0;
 165     }
 166 }
 167
 168 //----------------------------------------------------------------------------
 169 void ColorLayerImageView::SetGreyLevelBoundaries(std::vector<double> & grey_level_boundary)
 170 {
 171   // The size must be greater than or equal to 2 (at least min and max must exist).
 172   if ( grey_level_boundary.size() >= 2)
 173     {
 174       sort ( grey_level_boundary.begin(), grey_level_boundary.end() );
 175       _grey_level_boundary = grey_level_boundary;
 176     }
 177   // Otherwise, an exception should be thrown.
 178   else if (grey_level_boundary.size() != 0)
 179     std::cout << "CM ColorLayerImageView::SetGreyLevelBoundaries : ERROR!!! The grey level boundaries vector has an inconsistent size. It must be of a size greater than or equal to 2 (at least min and max must exist), but its size is: " << grey_level_boundary.size() << ". Therefore, the histogram will be equally split." << std::endl;
 180 }
 181
 182 //----------------------------------------------------------------------------
 183 double ColorLayerImageView::GetGreyLevelBoundaries(unsigned int index)
 184 {
 185   if (_grey_level_boundary.size() > index)
 186     return _grey_level_boundary.at(index);
 187   // An exception should be thrown if the index does not exist in the grey level boundary vector.
 188   else
 189     {
 190       std::cout << "CM ColorLayerImageView::GetGreyLevelBoundaries : ERROR!!! The index " << index << "is out of the grey level boundaries vector range." << std ::endl;
 191       return -1.0;
 192     }
 193 }
 194
 195 //----------------------------------------------------------------------------
 196 void ColorLayerImageView::SetPlainOrGradientColor(bool color_type)
 197 {
 198   _color_type = color_type;
 199 }
 200
 201 //----------------------------------------------------------------------------
 202 int ColorLayerImageView::GetBaseColorNb()
 203 {
 204   return _base_color.size()/3;
 205 }
 206
 207 //----------------------------------------------------------------------------
 208 void ColorLayerImageView::SetDefaultGreyLevelBoundary()
 209 {
 210   // CM Sets the default behaviour concerning the lookup table keeping the base colors already set.
 211   _grey_level_boundary.clear();
 212
 213   // This avoids a potential division by 0 through delta during the lookup table configuration.
 214   if (_range[1]==0)
 215     {
 216       _range[1]=255;
 217     }
 218
 219         int i;
 220         double delta;
 221         // Grey level extrema are set by default to the image grey level extrema.
 222         double minTot = _range[0];
 223         double maxTot = _range[1];
 224
 225         if (_color_type)
 226         {
 227            delta = (maxTot - minTot)/GetBaseColorNb();
 228                 // By default, the histogram is split into BaseColorNb areas of equal width.
 229                 for (i = 0; i <= GetBaseColorNb() ; i ++)
 230                 {
 231                         _grey_level_boundary.push_back(minTot + i * delta);
 232                 } // for
 233         } else {
 234            delta = (maxTot - minTot)/(GetBaseColorNb()-1);
 235                 for (i = 0; i < GetBaseColorNb() ; i ++)
 236                 {
 237                         _grey_level_boundary.push_back(minTot + i * delta);
 238                 } // for
 239         } // if
 240
 241 }
 242
 243 //----------------------------------------------------------------------------
 244 void ColorLayerImageView::SetDefaultBaseColorAndGreyLevelBoundary()
 245 {
 246   // CM Sets the default behaviour concerning the lookup table.
 247   _grey_level_boundary.clear();
 248   _base_color.clear();
 249   // Base colors are set to blue, yellow and red.
 250   // Blue.
 251   _base_color.push_back(0.0);
 252   _base_color.push_back(0.0);
 253   _base_color.push_back(0.5);
 254
 255   _base_color.push_back(0.0);
 256   _base_color.push_back(0.0);
 257   _base_color.push_back(1.0);
 258
 259   _base_color.push_back(0.0);
 260   _base_color.push_back(1.0);
 261   _base_color.push_back(1.0);
 262
 263   _base_color.push_back(1.0);
 264   _base_color.push_back(1.0);
 265   _base_color.push_back(0.0);
 266
 267   _base_color.push_back(1.0);
 268   _base_color.push_back(0.0);
 269   _base_color.push_back(0.0);
 270
 271   _base_color.push_back(0.5);
 272   _base_color.push_back(0.0);
 273   _base_color.push_back(0.0);
 274
 275
 276   // This avoids a potential division by 0 through delta during the lookup table configuration.
 277   if (_range[1]==0)
 278     {
 279       _range[1]=255;
 280     }
 281
 282 //  double minTot = floor (_range[0]);
 283 //  double maxTot = ceil (_range[1]);
 284   double minTot = _range[0];
 285   double maxTot = _range[1];
 286
 287   double delta = (maxTot - minTot)/8.0;
 288   // By default, the histogram is split into three areas of equal width.
 289
 290   _grey_level_boundary.push_back(minTot + delta*0);
 291   _grey_level_boundary.push_back(minTot + delta*1);
 292 //  _grey_level_boundary.push_back(minTot + delta*2);
 293   _grey_level_boundary.push_back(minTot + delta*3);
 294 //  _grey_level_boundary.push_back(minTot + delta*4);
 295   _grey_level_boundary.push_back(minTot + delta*5);
 296  // _grey_level_boundary.push_back(minTot + delta*6);
 297   _grey_level_boundary.push_back(minTot + delta*7);
 298   _grey_level_boundary.push_back(minTot + delta*8);
 299 }
 300
 301 //----------------------------------------------------------------------------
 302 void ColorLayerImageView::ConfigLookupTable()  // virtual
 303 {
 304   // CM 2014
 305   // EED         28/01/2015
 306   // Grey level extrema retrieved from the image grey level extrema.
 307 //EED 20 oct 2015
 308 //  GetImage()->GetScalarRange(_range);
 309   GetImageScalarRange();
 310   double minRange = _range[0];
 311   double maxRange = _range[1];
 312
 313   // ------------------ Setting Default Values
 314   // Checks the size consistency of vectors _base_color and _grey_level_boundary.
 315   // In case of inconsistency, an exception should be thrown. Instead, the default values are set.
 316   if (GetBaseColorNb() == 0)
 317         {
 318                 SetDefaultBaseColorAndGreyLevelBoundary();
 319         }
 320    else {  // If at least one color has been set, set the grey level boundaries to build an equipartition of the image grey levels, keeping the base colors defined.
 321       if (GetBaseColorNb() != (int)_grey_level_boundary.size() )
 322       {
 323                         std::cout << "CM ColorLayerImageView::ConfigLookupTable : ERROR!!! Inconsistency between the sizes of vectors _base_color and _grey_level_boundary. _base_color.size()/3 (=" <<_base_color.size()/3 << ") should be equal to _grey_level_boundary.size() - 1 (=" << _grey_level_boundary.size() - 1 << ")." << std::endl;
 324                         std::cout << "CM The default values for the base colors and the grey level boundaries will be set." << std::endl;
 325                         SetDefaultGreyLevelBoundary();
 326       }
 327    }
 328   // ------------------ End Of Setting Default Values
 329
 330         int iTransparence,transparenceSize = _transparence_level_boundary.size();
 331         for (iTransparence=transparenceSize ; iTransparence < GetBaseColorNb(); iTransparence++ )
 332         {
 333       _transparence_level_boundary.push_back(1);
 334         }
 335
 336   // ------------------ Defining the Threshold Table
 337   vtkLookupTable* thresholdTable = GetThresholdTable();
 338
 339   double thresholdTable_range[2];
 340   double r1,r2,g1,g2,b1,b2,t1,t2;
 341   int start,end;
 342
 343   // CM Number of table values consistent with the effective number of values (see loop below).
 344   thresholdTable_range[1]= std::max( GetGreyLevelBoundaries( _grey_level_boundary.size()-1 ) , ceil(maxRange) );
 345   thresholdTable_range[0]= std::min( GetGreyLevelBoundaries(0), floor(minRange) );
 346
 347   thresholdTable_range[1]= GetGreyLevelBoundaries( _grey_level_boundary.size()-1 );
 348   thresholdTable_range[0]= GetGreyLevelBoundaries(0);
 349
 350   thresholdTable->SetTableRange(thresholdTable_range);
 351   thresholdTable->SetAlphaRange( 0,1 );
 352   thresholdTable->SetValueRange( 0,1 );
 353
 354   thresholdTable->SetSaturationRange( 0,0 );
 355   thresholdTable->SetRampToLinear( );
 356
 357   maxColorsThresholdTable = 1000;
 358   thresholdTable->SetNumberOfTableValues( maxColorsThresholdTable );
 359   thresholdTable->SetNanColor(0,0,0,0);
 360
 361
 362   // Defines the lookup table.
 363   // If the image has a degradation in one (or both) extremum (lower or higher),
 364   // sets the corresponding grey levels as transparent white in the lookup table.
 365
 366   // _color_type true, i.e. plain colors.
 367   // Sets the plain color for each grey level interval.
 368   if (_color_type)  // Plain
 369   {
 370      if ( minRange<GetGreyLevelBoundaries(0) )
 371           {
 372                         start   = 0;
 373                         end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(0) );
 374                         FillColorTable(start,end, 0,0,0, 0,0,0, 0,0);
 375      }
 376
 377      if ( maxRange>GetGreyLevelBoundaries(  _grey_level_boundary.size()-1   ) )
 378           {
 379                         start   = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries( _grey_level_boundary.size()-1 ) );
 380                         end     = GrayLevel_TO_colorTableIndex( maxRange );
 381                         FillColorTable(start,end, 0,0,0, 0,0,0, 0,0);
 382      }
 383       for (int iColor = 0; iColor < GetBaseColorNb(); iColor++)
 384                 {
 385                         r1              = GetBaseColors(iColor*3+0);
 386                         g1              = GetBaseColors(iColor*3+1);
 387                         b1              = GetBaseColors(iColor*3+2);
 388                         start   = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor) );
 389                         end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor+1) );
 390                 t1              = _transparence_level_boundary[iColor];
 391 //                      t2              = _transparence_level_boundary[iColor+1];
 392                         FillColorTable(start,end, r1,g1,b1,r1,g1,b1,t1,t1);
 393                 } // for i
 394         }    else  {  // _color_type false, i.e. gradient color
 395       if (GetBaseColorNb() > 1)
 396                 {
 397                         for (int iColor = 0; iColor < GetBaseColorNb()-1; iColor++)
 398                    {
 399                                 r1              = GetBaseColors( (iColor+0)*3+0 );
 400                                 g1              = GetBaseColors( (iColor+0)*3+1 );
 401                                 b1              = GetBaseColors( (iColor+0)*3+2 );
 402                                 r2              = GetBaseColors( (iColor+1)*3+0);
 403                                 g2              = GetBaseColors( (iColor+1)*3+1);
 404                                 b2              = GetBaseColors( (iColor+1)*3+2);
 405                                 start   = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor) );
 406                                 end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor+1) );
 407                         t1              = _transparence_level_boundary[iColor];
 408                                 t2              = _transparence_level_boundary[iColor+1];
 409                                 FillColorTable( start,end, r1,g1,b1, r2,g2,b2, t1,t2 );
 410                         }// for
 411                 } //if
 412   } //  End Of if (!_color_type)
 413
 414   double minRangeForColorBar, maxRangeForColorBar;
 415   GetRangeForColorBar( minRangeForColorBar, maxRangeForColorBar );
 416   thresholdTable->SetRange( minRangeForColorBar, maxRangeForColorBar );
 417
 418 //  thresholdTable->SetTableRange( minRange, maxRange );
 419 //  thresholdTable->SetValueRange( 0.0, 1.0 );
 420 //  thresholdTable->SetAboveRangeColor(0,0,0,0);
 421 //  thresholdTable->SetBelowRangeColor(0,0,0,0);
 422
 423   thresholdTable->Build( );
 424
 425   //EO CM EED
 426 }
 427
 428 //----------------------------------------------------------------------------
 429 int ColorLayerImageView::GrayLevel_TO_colorTableIndex( double VALUE )
 430 {
 431   GetImage()->Update();
 432
 433 //EED 20 oct 2015
 434 //  GetImage()->GetScalarRange(_range);
 435   GetImageScalarRange();
 436
 437   double minRange = _range[0];
 438   double maxRange = _range[1];
 439   return  maxColorsThresholdTable * (VALUE-minRange) / (maxRange-minRange);
 440 }
 441
 442 //----------------------------------------------------------------------------
 443 void ColorLayerImageView::FillColorTable(int start, int end, double r1, double g1, double b1, double r2, double g2, double b2, double t1, double t2)
 444 {
 445    vtkLookupTable* thresholdTable = GetThresholdTable();
 446         int     iTable;
 447         double  delta   = end-start;
 448         double  dr              = (r2-r1)/delta;
 449         double  dg              = (g2-g1)/delta;
 450         double  db              = (b2-b1)/delta;
 451         double  dt      = (t2-t1)/delta;
 452         for (iTable=0; iTable<=delta; iTable++)
 453         {
 454                 thresholdTable->SetTableValue(  iTable+start , r1+dr*iTable, g1+dg*iTable, b1+db*iTable,t1+dt*iTable);
 455         } // for iTable
 456
 457
 458 }
 459
 460 // EOF
 461