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   if (base_color.size() != 0 && base_color.size() % 3 == 0)
 138     _base_color = base_color;
 139   // Otherwise, an exception should be thrown.
 140   else if (base_color.size() != 0)
 141     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;
 142 }
 143
 144
 145 //----------------------------------------------------------------------------
 146 void ColorLayerImageView::SetBaseTransparence(std::vector<double> & base_transparence)
 147 {
 148   _transparence_level_boundary = base_transparence;
 149 }
 150
 151
 152 //----------------------------------------------------------------------------
 153 double ColorLayerImageView::GetBaseColors(unsigned int index)
 154 {
 155   if (_base_color.size() > index)
 156     return _base_color.at(index);
 157   // An exception should be thrown if the index does not exist in the color vector.
 158   else
 159     {
 160       std::cout << "CM ColorLayerImageView::GetBaseColors : ERROR!!! The index " << index << "is out of the base color vector range." << std ::endl;
 161       return -1.0;
 162     }
 163 }
 164
 165 //----------------------------------------------------------------------------
 166 void ColorLayerImageView::SetGreyLevelBoundaries(std::vector<double> & grey_level_boundary)
 167 {
 168   // The size must be greater than or equal to 2 (at least min and max must exist).
 169   if ( grey_level_boundary.size() >= 2)
 170     {
 171       sort ( grey_level_boundary.begin(), grey_level_boundary.end() );
 172       _grey_level_boundary = grey_level_boundary;
 173     }
 174   // Otherwise, an exception should be thrown.
 175   else if (grey_level_boundary.size() != 0)
 176     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;
 177 }
 178
 179 //----------------------------------------------------------------------------
 180 double ColorLayerImageView::GetGreyLevelBoundaries(unsigned int index)
 181 {
 182   if (_grey_level_boundary.size() > index)
 183     return _grey_level_boundary.at(index);
 184   // An exception should be thrown if the index does not exist in the grey level boundary vector.
 185   else
 186     {
 187       std::cout << "CM ColorLayerImageView::GetGreyLevelBoundaries : ERROR!!! The index " << index << "is out of the grey level boundaries vector range." << std ::endl;
 188       return -1.0;
 189     }
 190 }
 191
 192 //----------------------------------------------------------------------------
 193 void ColorLayerImageView::SetPlainOrGradientColor(bool color_type)
 194 {
 195   _color_type = color_type;
 196 }
 197
 198 //----------------------------------------------------------------------------
 199 int ColorLayerImageView::GetBaseColorNb()
 200 {
 201   return _base_color.size()/3;
 202 }
 203
 204 //----------------------------------------------------------------------------
 205 void ColorLayerImageView::SetDefaultGreyLevelBoundary()
 206 {
 207   // CM Sets the default behaviour concerning the lookup table keeping the base colors already set.
 208   _grey_level_boundary.clear();
 209
 210   // This avoids a potential division by 0 through delta during the lookup table configuration.
 211   if (_range[1]==0)
 212     {
 213       _range[1]=255;
 214     }
 215
 216   // Grey level extrema are set by default to the image grey level extrema.
 217   double minTot = _range[0];
 218   double maxTot = _range[1];
 219
 220   _grey_level_boundary.push_back(minTot);
 221
 222   // By default, the histogram is split into BaseColorNb areas of equal width.
 223   double delta = (maxTot - minTot)/GetBaseColorNb();
 224   for (int i = 1; i <= GetBaseColorNb() ; i ++)
 225   {
 226                 _grey_level_boundary.push_back(minTot + i * delta);
 227   } // for
 228 }
 229
 230 //----------------------------------------------------------------------------
 231 void ColorLayerImageView::SetDefaultBaseColorAndGreyLevelBoundary()
 232 {
 233   // CM Sets the default behaviour concerning the lookup table.
 234   _grey_level_boundary.clear();
 235   _base_color.clear();
 236   // Base colors are set to blue, yellow and red.
 237   // Blue.
 238   _base_color.push_back(0.0);
 239   _base_color.push_back(0.0);
 240   _base_color.push_back(1.0);
 241   // Yellow.
 242   _base_color.push_back(1.0);
 243   _base_color.push_back(1.0);
 244   _base_color.push_back(0.0);
 245   // Red.
 246   _base_color.push_back(1.0);
 247   _base_color.push_back(0.0);
 248   _base_color.push_back(0.0);
 249
 250   // This avoids a potential division by 0 through delta during the lookup table configuration.
 251   if (_range[1]==0)
 252     {
 253       _range[1]=255;
 254     }
 255
 256   double minTot = floor (_range[0]);
 257   double maxTot = ceil (_range[1]);
 258
 259   _grey_level_boundary.push_back(minTot);
 260
 261   // By default, the histogram is split into three areas of equal width.
 262   double delta = (maxTot - minTot)/3.0;
 263   _grey_level_boundary.push_back(minTot + delta);
 264   _grey_level_boundary.push_back(minTot + 2*delta);
 265
 266   _grey_level_boundary.push_back(maxTot);
 267 }
 268
 269 //----------------------------------------------------------------------------
 270 void ColorLayerImageView::ConfigLookupTable()  // virtual
 271 {
 272   // CM 2014
 273   // EED         28/01/2015
 274
 275   // Grey level extrema retrieved from the image grey level extrema.
 276
 277   GetImage()->GetScalarRange(_range);
 278   double minRange = _range[0];
 279   double maxRange = _range[1];
 280
 281   // ------------------ Setting Default Values
 282   // Checks the size consistency of vectors _base_color and _grey_level_boundary.
 283   // In case of inconsistency, an exception should be thrown. Instead, the default values are set.
 284   if (GetBaseColorNb() == 0)
 285         {
 286                 SetDefaultBaseColorAndGreyLevelBoundary();
 287         }
 288    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.
 289       if (GetBaseColorNb() != ((int)_grey_level_boundary.size() - 1) )
 290       {
 291                         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;
 292                         std::cout << "CM The default values for the base colors and the grey level boundaries will be set." << std::endl;
 293                         SetDefaultGreyLevelBoundary();
 294       }
 295    }
 296   // ------------------ End Of Setting Default Values
 297
 298         int iTransparence,transparenceSize = _transparence_level_boundary.size();
 299         for (iTransparence= transparenceSize ; iTransparence < GetBaseColorNb(); iTransparence++ )
 300         {
 301       _transparence_level_boundary.push_back(1);
 302         }
 303
 304   // ------------------ Defining the Threshold Table
 305   vtkLookupTable* thresholdTable = GetThresholdTable();
 306   double thresholdTable_range[2];
 307   double r1,r2,g1,g2,b1,b2,t1,t2;
 308   int start,end;
 309
 310   // CM Number of table values consistent with the effective number of values (see loop below).
 311   thresholdTable_range[1]= std::max(     GetGreyLevelBoundaries( _grey_level_boundary.size()-1 )      ,     ceil(_range[1])      );
 312   thresholdTable_range[0]= std::min(     GetGreyLevelBoundaries(0)                                    ,     floor(_range[0])     );
 313
 314   thresholdTable->SetTableRange(thresholdTable_range);
 315   thresholdTable->SetAlphaRange(0, 1);
 316   thresholdTable->SetValueRange(0, 1);
 317
 318   thresholdTable->SetSaturationRange(0, 0);
 319   thresholdTable->SetRampToLinear( );
 320
 321   maxColorsThresholdTable = 1000;
 322   thresholdTable->SetNumberOfTableValues( maxColorsThresholdTable );
 323
 324
 325   // Defines the lookup table.
 326   // If the image has a degradation in one (or both) extremum (lower or higher),
 327   // sets the corresponding grey levels as transparent white in the lookup table.
 328
 329   // _color_type true, i.e. plain colors.
 330   // Sets the plain color for each grey level interval.
 331   if (_color_type)
 332   {
 333
 334      if ( minRange<GetGreyLevelBoundaries(0) )
 335           {
 336                         start = 0;
 337                         end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(0) );
 338                         FillColorTable(start,end, 0,0,0, 0,0,0, 0,0);
 339      }
 340
 341      if ( maxRange>GetGreyLevelBoundaries(  _grey_level_boundary.size()-1   ) )
 342           {
 343                         start = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries( _grey_level_boundary.size()-1 ) );
 344                         end     = GrayLevel_TO_colorTableIndex( maxRange );
 345                         FillColorTable(start,end, 0,0,0, 0,0,0, 0,0);
 346      }
 347
 348       for (int iColor = 0; iColor < GetBaseColorNb(); iColor++)
 349                 {
 350                         r1              = GetBaseColors(iColor*3+0);
 351                         g1              = GetBaseColors(iColor*3+1);
 352                         b1              = GetBaseColors(iColor*3+2);
 353                         start = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor) );
 354                         end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor+1) );
 355          t1     = _transparence_level_boundary[iColor];
 356                         t2              = _transparence_level_boundary[iColor+1];
 357                         FillColorTable(start,end, r1,g1,b1,r1,g1,b1,t1,t2);
 358                 } // for i
 359         } // End Of if (_color_type)
 360
 361   // _color_type false, i.e. gradient color
 362   else
 363   {
 364 //EED 28/01/2015
 365       if (GetBaseColorNb() > 1)
 366                 {
 367                         for (int iColor = 0; iColor < GetBaseColorNb(); iColor++)
 368                    {
 369                                 if (iColor==0)
 370                                 {
 371                                         r1              = 0;
 372                                         g1              = 0;
 373                                         b1              = 0;
 374                                         r1              = GetBaseColors((iColor-1)*3+0);
 375                                         g1              = GetBaseColors((iColor-1)*3+1);
 376                                         b1              = GetBaseColors((iColor-1)*3+2);
 377                                 } else {
 378                                         r1              = GetBaseColors((iColor-1)*3+0);
 379                                         g1              = GetBaseColors((iColor-1)*3+1);
 380                                         b1              = GetBaseColors((iColor-1)*3+2);
 381                                 } // if iColor == 0
 382
 383                                 r2              = GetBaseColors(iColor*3+0);
 384                                 g2              = GetBaseColors(iColor*3+1);
 385                                 b2              = GetBaseColors(iColor*3+2);
 386                                 start = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor) );
 387                                 end     = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(iColor+1) );
 388                  t1     = _transparence_level_boundary[iColor];
 389                                 t2              = _transparence_level_boundary[iColor+1];
 390                                 FillColorTable( start,end, r1,g1,b1, r2,g2,b2, t1,t1 );
 391                         }// for
 392                 } //if
 393   } //  End Of if (!_color_type)
 394
 395   thresholdTable->SetRange( minRange, maxRange );
 396   thresholdTable->SetValueRange( 0.0, 1.0 );
 397
 398   thresholdTable->Build( );
 399
 400   //EO CM EED
 401 }
 402
 403 //----------------------------------------------------------------------------
 404 int ColorLayerImageView::GrayLevel_TO_colorTableIndex( double VALUE )
 405 {
 406   GetImage()->GetScalarRange(_range);
 407   double minRange = _range[0];
 408   double maxRange = _range[1];
 409   return  maxColorsThresholdTable * (VALUE-minRange) / (maxRange-minRange);
 410 }
 411
 412 //----------------------------------------------------------------------------
 413 void ColorLayerImageView::FillColorTable(int start, int end, double r1, double g1, double b1, double r2, double g2, double b2, double t1, double t2)
 414 {
 415    vtkLookupTable* thresholdTable = GetThresholdTable();
 416         int      iTable;
 417         double delta    = end-start;
 418         double dr               = (r2-r1)/delta;
 419         double dg               = (g2-g1)/delta;
 420         double db               = (b2-b1)/delta;
 421    double dt      = (t2-t1)/delta;
 422         for (iTable=0; iTable<=delta; iTable++)
 423         {
 424                 thresholdTable->SetTableValue(  iTable+start , r1+dr*iTable, g1+dg*iTable, b1+db*iTable,t1+dt*iTable);
 425         } // for iTable
 426
 427 //      if (start==0) thresholdTable->SetTableValue(  start , r1, g1, b1,0);   // The first color in the table is transparent
 428
 429 }
 430
 431 // EOF
 432