File: itkGoodnessOfFitFunctionBase.h

package info (click to toggle)
insighttoolkit 3.18.0-5
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 110,432 kB
  • ctags: 74,559
  • sloc: cpp: 412,627; ansic: 196,210; fortran: 28,000; python: 3,852; tcl: 2,005; sh: 1,186; java: 583; makefile: 458; csh: 220; perl: 193; xml: 20
file content (130 lines) | stat: -rwxr-xr-x 4,022 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
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGoodnessOfFitFunctionBase.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 15:23:49 $
  Version:   $Revision: 1.7 $

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

#include "itkSampleAlgorithmBase.h"
#include "itkFunctionBase.h"
#include "itkGoodnessOfFitComponentBase.h"

namespace itk { 
namespace Statistics {

/** \class GoodnessOfFitFunctionBase
 *  \brief base class for classes calculates different types of goodness-of-fit 
 *  statistics
 *
 * Goodness-of-fit function quantifies discrepancy between the given model 
 * with the observation by summarizing the difference between the expected frequency
 * and the observed frequency.
 *
 * \sa GoodnessOfFitMixtureModelCostFunction, GoodnessOfFitComponentBase
 */

template< class TInputHistogram >
class GoodnessOfFitFunctionBase 
  : public SampleAlgorithmBase< TInputHistogram > 
{
public:
  /** Standard class typedefs */
  typedef GoodnessOfFitFunctionBase              Self;
  typedef SampleAlgorithmBase< TInputHistogram > Superclass;
  typedef SmartPointer< Self >                   Pointer;
  typedef SmartPointer< const Self >             ConstPointer;
  
  /** Run-time type information (and related methods). */
  itkTypeMacro(GoodnessOfFitFunctionBase, 
               SampleAlgorithimBase);
  
  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** typedefs from Superclass */
  itkStaticConstMacro(MeasurementVectorSize, unsigned int, 
                      TInputHistogram::MeasurementVectorSize);

  typedef typename TInputHistogram::MeasurementType       MeasurementType;
  typedef typename TInputHistogram::MeasurementVectorType MeasurementVectorType;
  typedef TInputHistogram                                 InputHistogramType;

  /** Sets the observed histogram input */
  void SetObservedHistogram(InputHistogramType* histogram);

  /** Gets the observed histogram */
  InputHistogramType* GetObservedHistogram() 
    { return m_ObservedHistogram; }

  /** Sets the expected histogram input */
  void SetExpectedHistogram(InputHistogramType* histogram);

  /** Gets the expected histogram input */
  InputHistogramType* GetExpectedHistogram() 
    { return m_ExpectedHistogram; }

  /** Sets the flag that tells if a subclass needs
   * the expected histogram for goodness-of-fit statistics
   * calculation. This flag should be set only by a subclass */
  itkGetMacro(UseExpectedHistogram, bool);

  void SetTotalObservedScale(double* scale)
    { 
    if ( m_TotalObservedScale != scale )
      {
      m_TotalObservedScale = scale;
      this->Modified();
      }
    }

  typedef double OutputType;

  OutputType& GetOutput()
    { return m_Output; }

protected:
  GoodnessOfFitFunctionBase();
  virtual ~GoodnessOfFitFunctionBase(){};
  void PrintSelf(std::ostream& os, Indent indent) const;  

  itkSetMacro(UseExpectedHistogram, bool);
  
  virtual void GenerateData() {}

  itkGetConstReferenceMacro(Epsilon,float);
  itkGetConstReferenceMacro(LogEpsilon,float);

private:
  float m_Epsilon;
  float m_LogEpsilon;

  bool m_UseExpectedHistogram;

  InputHistogramType* m_ObservedHistogram;
  InputHistogramType* m_ExpectedHistogram;
  
  double*    m_TotalObservedScale;
  OutputType m_Output;

}; // end of class

} // end of namespace Statistics 
} // end of namespace itk

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

#endif