/usr/include/InsightToolkit/Review/Statistics/itkDistanceMetric.h is in libinsighttoolkit3-dev 3.20.1-1.
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 | /*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkDistanceMetric.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 __itkDistanceMetric_h
#define __itkDistanceMetric_h
#include "itkArray.h"
#include "itkFunctionBase.h"
#include "itkMeasurementVectorTraits.h"
namespace itk {
namespace Statistics {
/** \class DistanceMetric
* \brief this class declares common interfaces
* for distance functions.
*
* As a function derived from FunctionBase, users use Evaluate method to get
* result.
*
* To use this function users should first set the origin by calling
* SetOrigin() function, then call Evaluate() method with a point to get the
* distance between the origin point and the evaluation point.
*
* \sa EuclideanSquareDistanceMetric
* \sa EuclideanDistanceMetric
* \sa ManhattanDistanceMetric
*
*/
template< class TVector >
class ITK_EXPORT DistanceMetric : public FunctionBase< TVector, double >
{
public:
/** Standard typedefs */
typedef DistanceMetric Self;
typedef FunctionBase< TVector, double > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** declare the MeasurementVector type */
typedef TVector MeasurementVectorType;
/** declare Measurement vector component type */
/** Type used to represent the number of components oft he MeasurementVectorType */
typedef unsigned int MeasurementVectorSizeType;
/** Run-time type information (and related methods). */
itkTypeMacro(DistanceMetric, FunctionBase);
typedef Array< double > OriginType;
/** Sets the origin point that will be used for the single point version
* Evaluate() function. This function is necessary part of implementing the
* Evaluate() interface. The argument of SetOrigin() must be of type
* DistanceMetric::OriginType, which in most cases will be different from the
* TVector type. This is necessary because often times the origin would be a
* mean, or a vector representative of a collection of vectors. */
void SetOrigin(const OriginType& x);
itkGetConstReferenceMacro(Origin, OriginType);
/** Gets the distance between the origin point and x. This function
* work with SetOrigin() function. */
virtual double Evaluate(const MeasurementVectorType &x) const = 0;
/** Gets the distance between x1 and x2. This method is used by
* KdTreeKMeans estimators. When the estimator is refactored,
* this method should be removed. Distance between two measurement
* vectors can be computed by setting one of them as an origin of
* the distane and using the Evaluate method with a single argument */
virtual double Evaluate(const MeasurementVectorType &x1,
const MeasurementVectorType &x2) const = 0;
/** Set method for the length of the measurement vector */
virtual void SetMeasurementVectorSize( MeasurementVectorSizeType s )
{
// Test whether the vector type is resizable or not
MeasurementVectorType m;
if( MeasurementVectorTraits::IsResizable( m ) )
{
// then this is a resizable vector type
//
// if the new size is the same as the previou size, just return
if( s == this->m_MeasurementVectorSize )
{
return;
}
else
{
this->m_MeasurementVectorSize = s;
this->Modified();
}
}
else
{
// If this is a non-resizable vector type
MeasurementVectorType m3;
MeasurementVectorSizeType defaultLength = MeasurementVectorTraits::GetLength( m3 );
// and the new length is different from the default one, then throw an exception
if( defaultLength != s )
{
itkExceptionMacro("Attempting to change the measurement \
vector size of a non-resizable vector type");
}
}
}
/** Get method for the length of the measurement vector */
itkGetConstMacro( MeasurementVectorSize, MeasurementVectorSizeType );
protected:
DistanceMetric();
virtual ~DistanceMetric() {}
void PrintSelf(std::ostream& os, Indent indent) const;
private:
OriginType m_Origin;
/** Number of components in the MeasurementVectorType */
MeasurementVectorSizeType m_MeasurementVectorSize;
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkDistanceMetric.txx"
#endif
#endif
|