File: itkCompareHistogramImageToImageMetric.h

package info (click to toggle)
insighttoolkit 3.6.0-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 94,956 kB
  • ctags: 74,981
  • sloc: cpp: 355,621; ansic: 195,070; fortran: 28,713; python: 3,802; tcl: 1,996; sh: 1,175; java: 583; makefile: 415; csh: 184; perl: 175
file content (179 lines) | stat: -rw-r--r-- 7,405 bytes parent folder | download
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCompareHistogramImageToImageMetric.h,v $
  Language:  C++
  Date:      $Date: 2004-12-21 22:47:26 $
  Version:   $Revision: 1.6 $

  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 __itkCompareHistogramImageToImageMetric_h
#define __itkCompareHistogramImageToImageMetric_h

#include "itkHistogramImageToImageMetric.h"

namespace itk
{
  /** \class CompareHistogramImageToImageMetric
    *  \brief Compares Histograms between two images to be registered to
    *   a Training Histogram.
    *
    *  This class is templated over the type of the fixed and moving
    *  images to be compared. 
    *
    *  This metric computes the similarity between the histogram produced
    *  by two images overlapping and a training histogram.
    *
    *  It is to be sub-classed by the method of comparing the
    *  histograms.
    *
    *  Generally, the histogram from the training data is to be
    *  computed in exactly the same way as the histogram from the
    *  images to be compared are computed. Thus, the user can set the
    *  interpolator, region, two training images and the transfrom and
    *  the training histogram will be formed. OR, the user can simply
    *  calculate the training histogram seperately and set it.
    *
    * \warning The Initialize function does nothing if the training
    * histogram already exists. Thus repeated calls to the Initialize
    * function do nothing after the first call. If you wish the
    * training histogram to be re-calculated, you should set it to 0.
    *
    *  \author Samson Timoner.
    *
    *  \ingroup RegistrationMetrics */
template <class TFixedImage, class TMovingImage>
class ITK_EXPORT CompareHistogramImageToImageMetric :
public HistogramImageToImageMetric<TFixedImage, TMovingImage>
{
 public:
  /** Standard class typedefs. */
  typedef CompareHistogramImageToImageMetric Self;
  typedef HistogramImageToImageMetric<TFixedImage, TMovingImage> Superclass;
  typedef SmartPointer<Self>                                     Pointer;
  typedef SmartPointer<const Self>                               ConstPointer;

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

  /** Types transferred from the base class */
  typedef typename Superclass::RealType                 RealType;
  typedef typename Superclass::TransformType            TransformType;
  typedef typename Superclass::TransformPointer         TransformPointer;
  typedef typename TransformType::ConstPointer          TransformConstPointer;

  typedef typename Superclass::TransformParametersType
    TransformParametersType;
  typedef typename Superclass::TransformJacobianType    TransformJacobianType;
  typedef typename Superclass::GradientPixelType        GradientPixelType;

  typedef typename Superclass::MeasureType              MeasureType;
  typedef typename Superclass::DerivativeType           DerivativeType;
  typedef typename Superclass::FixedImageType           FixedImageType;
  typedef typename Superclass::MovingImageType          MovingImageType;
  typedef typename Superclass::FixedImageConstPointer   FixedImageConstPointer;
  typedef typename Superclass::MovingImageConstPointer
    MovingImageConstPointer;

  typedef typename Superclass::HistogramType            HistogramType;
  typedef typename Superclass::HistogramSizeType        HistogramSizeType;
  typedef typename HistogramType::MeasurementVectorType
    HistogramMeasurementVectorType;
  typedef typename HistogramType::FrequencyType         HistogramFrequencyType;
  typedef typename HistogramType::Iterator              HistogramIteratorType;
  typedef typename HistogramType::Pointer               HistogramPointerType;

  typedef typename Superclass::InterpolatorType InterpolatorType;
  typedef typename Superclass::InterpolatorPointer 
    InterpolatorPointer;

  typedef typename Superclass::FixedImageRegionType 
    FixedImageRegionType;

  /** Set the histogram to be used in the metric calculation */
  itkSetMacro( TrainingHistogram, HistogramPointerType );

  /** Get the histogram to be used in the metric calculation */
  itkGetConstReferenceMacro( TrainingHistogram, HistogramPointerType );

  /** Set the Training Fixed Image.  */
  itkSetConstObjectMacro( TrainingFixedImage, FixedImageType );

  /** Get the Training Fixed Image. */
  itkGetConstObjectMacro( TrainingFixedImage, FixedImageType );

  /** Set the Training Moving Image.  */
  itkSetConstObjectMacro( TrainingMovingImage, MovingImageType );

  /** Get the Training Moving Image. */
  itkGetConstObjectMacro( TrainingMovingImage, MovingImageType );

  /** Set the Training Transform. */
  itkSetObjectMacro( TrainingTransform, TransformType );

  /** Get a pointer to the Transform.  */
  itkGetObjectMacro( TrainingTransform, TransformType );

  /** Set the Interpolator. */
  itkSetObjectMacro( TrainingInterpolator, InterpolatorType );

  /** Get a pointer to the Interpolator.  */
  itkGetObjectMacro( TrainingInterpolator, InterpolatorType );

  /** Set the region over which the training histogram will be computed */
  itkSetMacro( TrainingFixedImageRegion, FixedImageRegionType );

  /** Get the region over which the training histogram will be computed */
  itkGetConstReferenceMacro( TrainingFixedImageRegion, FixedImageRegionType );

  /** Return the number of parameters required by the Transform */
  unsigned int GetNumberOfParameters(void) const 
  { return this->GetTransform()->GetNumberOfParameters(); }
 
  /** Forms the histogram of the training images to prepare to evaluate the */
  /** metric. Must set all parameters first. */
  void Initialize() throw (ExceptionObject);

protected:
  /** Constructor is protected to ensure that \c New() function is used to
      create instances. */
  CompareHistogramImageToImageMetric();
  virtual ~CompareHistogramImageToImageMetric(){}
  void PrintSelf(std::ostream& os, Indent indent) const;

  /** Form the Histogram for the Training data */
  void FormTrainingHistogram() throw (ExceptionObject);

  /** Evaluates the comparison histogram metric. All sub-classes must 
      re-implement method. */
  virtual MeasureType EvaluateMeasure(HistogramType& histogram) const = 0;

private:
  // Purposely not implemented.
  CompareHistogramImageToImageMetric(Self const&);
  void operator=(Self const&); // Purposely not implemented.

  FixedImageConstPointer  m_TrainingFixedImage;
  MovingImageConstPointer m_TrainingMovingImage;
  TransformPointer        m_TrainingTransform;
  InterpolatorPointer     m_TrainingInterpolator;
  FixedImageRegionType    m_TrainingFixedImageRegion;
  HistogramPointerType    m_TrainingHistogram;

};

} // End namespace itk.

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCompareHistogramImageToImageMetric.txx"
#endif

#endif // __itkCompareHistogramImageToImageMetric_h