/usr/include/ITK-4.9/itkMixtureModelComponentBase.h is in libinsighttoolkit4-dev 4.9.0-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkMixtureModelComponentBase_h
#define itkMixtureModelComponentBase_h
#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"
#include "itkArray.h"
#include "itkObject.h"
#include "itkMembershipFunctionBase.h"
namespace itk
{
namespace Statistics
{
/** \class MixtureModelComponentBase
* \brief base class for distribution modules that supports analytical way
* to update the distribution parameters
*
* This class expects that its subclasses (distribution components) should
* have analytical expressions for updating its paraters using only
* the measurement vectors and their associated weights.
*
* This class can be considered as a macro class that encapsulates the
* storage for the weights, model (subclasses of MembershipFunctionBase),
* and model parameter estimators (implemenation of analytical expressions).
*
* Subclasses of this class should define their own distribution specific
* membership function. For example, GaussianMixtureModelComponent class
* defines and creates a GaussianDensityFunction object for that matter.
* Subclasses should also cast such membership function object to
* MembershipFunctionBase object. By doing that, users can get pointers
* to membership functions from different distributional model
*
* \sa ExpectationMaximizationMixtureModelEstimator
* \ingroup ITKStatistics
*/
template< typename TSample >
class MixtureModelComponentBase:
public Object
{
public:
/**Standard class typedefs. */
typedef MixtureModelComponentBase Self;
typedef Object Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/**Standard Macros */
itkTypeMacro(MixtureModelComponentBase, Object);
typedef typename TSample::MeasurementVectorType MeasurementVectorType;
typedef typename TSample::MeasurementVectorSizeType MeasurementVectorSizeType;
/** typedef for the MembershipFunctionBase */
typedef MembershipFunctionBase< MeasurementVectorType >
MembershipFunctionType;
/** typedef of strorage for the weights */
typedef Array< double > WeightArrayType;
typedef Array< double > ParametersType;
/** stores the sample pointer */
virtual void SetSample(const TSample *sample);
/** returns the sample pointer */
const TSample * GetSample() const;
/** returns the pointer to the membership function object.
* Subclasses of this class are responsible for creating the
* actual membership function objects and cast them to
* MembershipFunctionBase objects */
MembershipFunctionType * GetMembershipFunction();
void SetMinimalParametersChange(double change)
{
m_MinimalParametersChange = change;
}
double GetMinimalParametersChange()
{
return m_MinimalParametersChange;
}
virtual void SetParameters(const ParametersType & parameters);
virtual ParametersType GetFullParameters()
{
return m_Parameters;
}
/** sets the parameters modified tag. if one or more of the membership
* funtion's parameters are changed, then flag should be true */
void AreParametersModified(bool flag);
/** returns the value of parameter modified tag */
bool AreParametersModified();
/** sets the index-th weight with the "value" */
void SetWeight(unsigned int index, double value);
/** returns the index-th weight */
double GetWeight(unsigned int index) const;
/** returns the membership score of the "measurements" vector */
double Evaluate(MeasurementVectorType & measurements);
/** returns the pointer to the weights array */
itkGetConstReferenceMacro(Weights, WeightArrayType);
virtual void Update();
protected:
MixtureModelComponentBase();
virtual ~MixtureModelComponentBase();
virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** stores the pointer to the membership function.
* subclasses use this function to store their membership function
* object after dynamic creation */
void SetMembershipFunction(MembershipFunctionType *function);
virtual void GenerateData() = 0;
private:
/** target sample data pointer */
const TSample *m_Sample;
double m_MinimalParametersChange;
ParametersType m_Parameters;
/** SmartPointer to the memberhip function - usually density function */
MembershipFunctionType *m_MembershipFunction;
/** weights array */
WeightArrayType m_Weights;
/** indicative flag of membership function's parameter changes */
bool m_ParametersModified;
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMixtureModelComponentBase.hxx"
#endif
#endif
|