File: itkColormapFunctor.h

package info (click to toggle)
insighttoolkit 3.20.1%2Bgit20120521-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 80,652 kB
  • sloc: cpp: 458,133; ansic: 196,223; fortran: 28,000; python: 3,839; tcl: 1,811; sh: 1,184; java: 583; makefile: 430; csh: 220; perl: 193; xml: 20
file content (153 lines) | stat: -rw-r--r-- 5,132 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    itkColormapFunctor.h
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkColormapFunctor_h
#define __itkColormapFunctor_h

#include "itkLightObject.h"
#include "itkNumericTraits.h"
#include "itkRGBPixel.h"

namespace itk {

namespace Functor {

/**
 * \class ColormapFunctor
 * \brief Function object which maps a scalar value into an RGB colormap value.
 *
 * 
 * \author Nicholas Tustison, Hui Zhang, Gaetan Lehmann, Paul Yushkevich and ̈James C. Gee
 * 
 * This code was contributed in the Insight Journal paper:
 *
 * "Meeting Andy Warhol Somewhere Over the Rainbow: RGB Colormapping and ITK"
 * http://www.insight-journal.org/browse/publication/285
 * http://hdl.handle.net/1926/1452
 *
 */
template< class TScalar, class TRGBPixel >
class ITK_EXPORT ColormapFunctor : public Object
{
public:

  typedef ColormapFunctor                          Self;
  typedef Object                                   Superclass;
  typedef SmartPointer<Self>                       Pointer;
  typedef SmartPointer<const Self>                 ConstPointer;

  /** Run-time type information (and related methods). */
  itkTypeMacro(ColormapFunctor, Object);

  typedef TRGBPixel                                     RGBPixelType;
  typedef typename TRGBPixel::ComponentType             RGBComponentType;
  typedef TScalar                                       ScalarType;
  typedef typename NumericTraits<ScalarType>::RealType  RealType;

  itkSetMacro( MinimumRGBComponentValue, RGBComponentType );
  itkGetConstMacro( MinimumRGBComponentValue, RGBComponentType );

  itkSetMacro( MaximumRGBComponentValue, RGBComponentType );
  itkGetConstMacro( MaximumRGBComponentValue, RGBComponentType );

  itkSetMacro( MinimumInputValue, ScalarType );
  itkGetConstMacro( MinimumInputValue, ScalarType );

  itkSetMacro( MaximumInputValue, ScalarType );
  itkGetConstMacro( MaximumInputValue, ScalarType );

  virtual bool operator!=( const ColormapFunctor & ) const
    {
    return false;
    }
  virtual bool operator==( const ColormapFunctor & other ) const
    {
    return !(*this != other);
    }

  virtual RGBPixelType operator()( const ScalarType & ) const = 0;

protected:
  ColormapFunctor()
    {
    this->m_MinimumInputValue = NumericTraits<TScalar>::min();
    this->m_MaximumInputValue = NumericTraits<TScalar>::max();
    this->m_MinimumRGBComponentValue = NumericTraits<RGBComponentType>::min();
    this->m_MaximumRGBComponentValue = NumericTraits<RGBComponentType>::max();
    }

  ~ColormapFunctor() {};


  /**
   * Map [min, max] input values to [0, 1].
   */
  RealType RescaleInputValue( ScalarType v ) const
    {
    RealType d = static_cast<RealType>( this->m_MaximumInputValue - this->m_MinimumInputValue );
    RealType value = ( static_cast<RealType>( v )
      - static_cast<RealType>( this->m_MinimumInputValue ) ) / d;
    value = vnl_math_max( 0.0, value );
    value = vnl_math_min( 1.0, value );
    return value;
    }

  /**
   * Map [0, 1] value to [min, max] rgb component values.
   */
  RGBComponentType RescaleRGBComponentValue( RealType v ) const
    {
    RealType d = static_cast<RealType>( m_MaximumRGBComponentValue - m_MinimumRGBComponentValue );
    const RGBComponentType rescaled = 
      static_cast<RGBComponentType>( d * v ) + this->m_MinimumRGBComponentValue;
    return rescaled;
    }

  void PrintSelf(std::ostream& os, Indent indent) const
    {
    Superclass::PrintSelf(os, indent);

    os << indent << "Minimum RGB Component Value: "
       << static_cast<typename NumericTraits<RGBComponentType>::PrintType>(
         this->GetMinimumRGBComponentValue()) << std::endl;
    os << indent << "Maximum RGB Component Value: "
       << static_cast<typename NumericTraits<RGBComponentType>::PrintType>(
         this->GetMaximumRGBComponentValue()) << std::endl;
    os << indent << "Minimum Input Value: "
       << static_cast<typename NumericTraits<ScalarType>::PrintType>(
         this->GetMinimumInputValue()) << std::endl;
    os << indent << "Maximum Input Value: "
       << static_cast<typename NumericTraits<ScalarType>::PrintType>(
         this->GetMaximumInputValue()) << std::endl;
    }

private:
  ColormapFunctor(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  ScalarType            m_MinimumInputValue;
  ScalarType            m_MaximumInputValue;

  RGBComponentType      m_MinimumRGBComponentValue;
  RGBComponentType      m_MaximumRGBComponentValue;

};

} // end namespace functor

} // end namespace itk

#endif