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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkNormalizedCorrelationPointSetToImageMetric_h
#define itkNormalizedCorrelationPointSetToImageMetric_h
#include "itkPointSetToImageMetric.h"
#include "itkCovariantVector.h"
#include "itkPoint.h"
namespace itk
{
/** \class NormalizedCorrelationPointSetToImageMetric
* \brief Computes similarity between pixel values of a point set and
* intensity values of an image.
*
* This metric computes the correlation between point values in the fixed
* point-set and pixel values in the moving image. The correlation is
* normalized by the autocorrelation values of both the point-set and the
* moving image. The spatial correspondence between the point-set and the image
* is established through a Transform. Pixel values are taken from the fixed
* point-set. Their positions are mapped to the moving image and result in
* general in non-grid position on it. Values at these non-grid position of
* the moving image are interpolated using a user-selected Interpolator.
*
* \ingroup RegistrationMetrics
* \ingroup ITKRegistrationCommon
*/
template <typename TFixedPointSet, typename TMovingImage>
class ITK_TEMPLATE_EXPORT NormalizedCorrelationPointSetToImageMetric
: public PointSetToImageMetric<TFixedPointSet, TMovingImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(NormalizedCorrelationPointSetToImageMetric);
/** Standard class type aliases. */
using Self = NormalizedCorrelationPointSetToImageMetric;
using Superclass = PointSetToImageMetric<TFixedPointSet, TMovingImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(NormalizedCorrelationPointSetToImageMetric);
/** Types transferred from the base class */
using typename Superclass::RealType;
using typename Superclass::TransformType;
using typename Superclass::TransformPointer;
using typename Superclass::TransformParametersType;
using typename Superclass::TransformJacobianType;
using typename Superclass::GradientPixelType;
using typename Superclass::MeasureType;
using typename Superclass::DerivativeType;
using typename Superclass::FixedPointSetType;
using typename Superclass::MovingImageType;
using typename Superclass::FixedPointSetConstPointer;
using typename Superclass::MovingImageConstPointer;
using typename Superclass::PointIterator;
using typename Superclass::PointDataIterator;
using typename Superclass::InputPointType;
using typename Superclass::OutputPointType;
/** Get the derivatives of the match measure. */
void
GetDerivative(const TransformParametersType & parameters, DerivativeType & derivative) const override;
/** Get the value for single valued optimizers. */
MeasureType
GetValue(const TransformParametersType & parameters) const override;
/** Get value and derivatives for multiple valued optimizers. */
void
GetValueAndDerivative(const TransformParametersType & parameters,
MeasureType & value,
DerivativeType & derivative) const override;
/** Set/Get SubtractMean boolean. If true, the sample mean is subtracted
* from the sample values in the cross-correlation formula and
* typically results in narrower valleys in the cost function.
* Default value is false. */
itkSetMacro(SubtractMean, bool);
itkGetConstReferenceMacro(SubtractMean, bool);
itkBooleanMacro(SubtractMean);
protected:
NormalizedCorrelationPointSetToImageMetric();
~NormalizedCorrelationPointSetToImageMetric() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
bool m_SubtractMean{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkNormalizedCorrelationPointSetToImageMetric.hxx"
#endif
#endif
|