1 /*# ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
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
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.
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
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 # ------------------------------------------------------------------------ */
28 * \author Eduardo Davila and Claire Mouton.
29 * \brief Class bbtk::ThresholdImageView.
30 * \date September 2012
33 #include "ColorLayerImageView.h"
35 #include <vtkImageReslice.h>
36 #include <vtkLookupTable.h>
37 #include <vtkImageData.h>
42 //=========================================================================
43 //=========================================================================
44 //=========================================================================
45 //=========================================================================
46 ColorLayerImageView::ColorLayerImageView( )
53 //=========================================================================
54 ColorLayerImageView::~ColorLayerImageView()
57 //=========================================================================
60 //----------------------------------------------------------------------------
61 void ColorLayerImageView::SetSliceFixDynamic(bool fix_dynamic)
63 _fix_dynamic = fix_dynamic;
66 //----------------------------------------------------------------------------
67 void ColorLayerImageView::SetX2(int x2)
72 //----------------------------------------------------------------------------
73 void ColorLayerImageView::SetY2(int y2)
79 //----------------------------------------------------------------------------
80 void ColorLayerImageView::SetZ2(int z2)
85 //----------------------------------------------------------------------------
86 int ColorLayerImageView::GetX() // virtual
89 if (_fix_dynamic==false)
95 result = LayerImageBase::GetX();
101 //----------------------------------------------------------------------------
102 int ColorLayerImageView::GetY() // virtual
105 if (_fix_dynamic==false)
111 result = LayerImageBase::GetY();
117 //----------------------------------------------------------------------------
118 int ColorLayerImageView::GetZ() // virtual
121 if (_fix_dynamic==false)
127 result = LayerImageBase::GetZ();
133 //----------------------------------------------------------------------------
134 void ColorLayerImageView::SetBaseColors(std::vector<double> & base_color)
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)
140 _base_color = base_color;
141 } else if (base_color.size() != 0) // Otherwise, an exception should be thrown.
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;
148 //----------------------------------------------------------------------------
149 void ColorLayerImageView::SetBaseTransparence(std::vector<double> & base_transparence)
151 _transparence_level_boundary = base_transparence;
155 //----------------------------------------------------------------------------
156 double ColorLayerImageView::GetBaseColors(unsigned int index)
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.
163 std::cout << "CM ColorLayerImageView::GetBaseColors : ERROR!!! The index " << index << "is out of the base color vector range." << std ::endl;
168 //----------------------------------------------------------------------------
169 void ColorLayerImageView::SetGreyLevelBoundaries(std::vector<double> & grey_level_boundary)
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)
174 sort ( grey_level_boundary.begin(), grey_level_boundary.end() );
175 _grey_level_boundary = grey_level_boundary;
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;
182 //----------------------------------------------------------------------------
183 double ColorLayerImageView::GetGreyLevelBoundaries(unsigned int index)
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.
190 std::cout << "CM ColorLayerImageView::GetGreyLevelBoundaries : ERROR!!! The index " << index << "is out of the grey level boundaries vector range." << std ::endl;
195 //----------------------------------------------------------------------------
196 void ColorLayerImageView::SetPlainOrGradientColor(bool color_type)
198 _color_type = color_type;
201 //----------------------------------------------------------------------------
202 int ColorLayerImageView::GetBaseColorNb()
204 return _base_color.size()/3;
207 //----------------------------------------------------------------------------
208 void ColorLayerImageView::SetDefaultGreyLevelBoundary()
210 // CM Sets the default behaviour concerning the lookup table keeping the base colors already set.
211 _grey_level_boundary.clear();
213 // This avoids a potential division by 0 through delta during the lookup table configuration.
221 // Grey level extrema are set by default to the image grey level extrema.
222 double minTot = _range[0];
223 double maxTot = _range[1];
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 ++)
231 _grey_level_boundary.push_back(minTot + i * delta);
234 delta = (maxTot - minTot)/(GetBaseColorNb()-1);
235 for (i = 0; i < GetBaseColorNb() ; i ++)
237 _grey_level_boundary.push_back(minTot + i * delta);
243 //----------------------------------------------------------------------------
244 void ColorLayerImageView::SetDefaultBaseColorAndGreyLevelBoundary()
246 // CM Sets the default behaviour concerning the lookup table.
247 _grey_level_boundary.clear();
249 // Base colors are set to blue, yellow and red.
251 _base_color.push_back(0.0);
252 _base_color.push_back(0.0);
253 _base_color.push_back(0.5);
255 _base_color.push_back(0.0);
256 _base_color.push_back(0.0);
257 _base_color.push_back(1.0);
259 _base_color.push_back(0.0);
260 _base_color.push_back(1.0);
261 _base_color.push_back(1.0);
263 _base_color.push_back(1.0);
264 _base_color.push_back(1.0);
265 _base_color.push_back(0.0);
267 _base_color.push_back(1.0);
268 _base_color.push_back(0.0);
269 _base_color.push_back(0.0);
271 _base_color.push_back(0.5);
272 _base_color.push_back(0.0);
273 _base_color.push_back(0.0);
276 // This avoids a potential division by 0 through delta during the lookup table configuration.
282 // double minTot = floor (_range[0]);
283 // double maxTot = ceil (_range[1]);
284 double minTot = _range[0];
285 double maxTot = _range[1];
287 double delta = (maxTot - minTot)/8.0;
288 // By default, the histogram is split into three areas of equal width.
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);
301 //----------------------------------------------------------------------------
302 void ColorLayerImageView::ConfigLookupTable() // virtual
306 // Grey level extrema retrieved from the image grey level extrema.
308 // GetImage()->GetScalarRange(_range);
309 GetImageScalarRange();
310 double minRange = _range[0];
311 double maxRange = _range[1];
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)
318 SetDefaultBaseColorAndGreyLevelBoundary();
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() )
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();
328 // ------------------ End Of Setting Default Values
330 int iTransparence,transparenceSize = _transparence_level_boundary.size();
331 for (iTransparence=transparenceSize ; iTransparence < GetBaseColorNb(); iTransparence++ )
333 _transparence_level_boundary.push_back(1);
336 // ------------------ Defining the Threshold Table
337 vtkLookupTable* thresholdTable = GetThresholdTable();
339 double thresholdTable_range[2];
340 double r1,r2,g1,g2,b1,b2,t1,t2;
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) );
347 thresholdTable_range[1]= GetGreyLevelBoundaries( _grey_level_boundary.size()-1 );
348 thresholdTable_range[0]= GetGreyLevelBoundaries(0);
350 thresholdTable->SetTableRange(thresholdTable_range);
351 thresholdTable->SetAlphaRange( 0,1 );
352 thresholdTable->SetValueRange( 0,1 );
354 thresholdTable->SetSaturationRange( 0,0 );
355 thresholdTable->SetRampToLinear( );
357 maxColorsThresholdTable = 1000;
358 thresholdTable->SetNumberOfTableValues( maxColorsThresholdTable );
359 thresholdTable->SetNanColor(0,0,0,0);
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.
366 // _color_type true, i.e. plain colors.
367 // Sets the plain color for each grey level interval.
368 if (_color_type) // Plain
370 if ( minRange<GetGreyLevelBoundaries(0) )
373 end = GrayLevel_TO_colorTableIndex( GetGreyLevelBoundaries(0) );
374 FillColorTable(start,end, 0,0,0, 0,0,0, 0,0);
377 if ( maxRange>GetGreyLevelBoundaries( _grey_level_boundary.size()-1 ) )
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);
383 for (int iColor = 0; iColor < GetBaseColorNb(); iColor++)
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);
394 } else { // _color_type false, i.e. gradient color
395 if (GetBaseColorNb() > 1)
397 for (int iColor = 0; iColor < GetBaseColorNb()-1; iColor++)
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 );
412 } // End Of if (!_color_type)
414 double minRangeForColorBar, maxRangeForColorBar;
415 GetRangeForColorBar( minRangeForColorBar, maxRangeForColorBar );
416 thresholdTable->SetRange( minRangeForColorBar, maxRangeForColorBar );
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);
423 thresholdTable->Build( );
428 //----------------------------------------------------------------------------
429 int ColorLayerImageView::GrayLevel_TO_colorTableIndex( double VALUE )
431 GetImage()->Update();
434 // GetImage()->GetScalarRange(_range);
435 GetImageScalarRange();
437 double minRange = _range[0];
438 double maxRange = _range[1];
439 return maxColorsThresholdTable * (VALUE-minRange) / (maxRange-minRange);
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)
445 vtkLookupTable* thresholdTable = GetThresholdTable();
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++)
454 thresholdTable->SetTableValue( iTable+start , r1+dr*iTable, g1+dg*iTable, b1+db*iTable,t1+dt*iTable);