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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* 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.
*
*=========================================================================*/
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkSingleValuedPointSetToPointSetMetric.h,v $
Date: $Date: 2009-01-26 21:45:56 $
Version: $Revision: 1.2 $
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 itkSingleValuedPointSetToPointSetMetric_h
#define itkSingleValuedPointSetToPointSetMetric_h
#include "itkImageBase.h"
#include "itkAdvancedTransform.h"
#include "itkSingleValuedCostFunction.h"
#include "itkMacro.h"
#include "itkImageMaskSpatialObject.h"
#include "itkPointSet.h"
namespace itk
{
/** \class SingleValuedPointSetToPointSetMetric
* \brief Computes similarity between two point sets.
*
* This Class is templated over the type of the two point-sets. It
* expects a Transform to be plugged in. This particular
* class is the base class for a hierarchy of point-set to point-set metrics.
*
* This class computes a value that measures the similarity between the fixed point-set
* and the transformed moving point-set.
*
* \ingroup RegistrationMetrics
*
*/
template <class TFixedPointSet, class TMovingPointSet>
class ITK_TEMPLATE_EXPORT SingleValuedPointSetToPointSetMetric : public SingleValuedCostFunction
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SingleValuedPointSetToPointSetMetric);
/** Standard class typedefs. */
using Self = SingleValuedPointSetToPointSetMetric;
using Superclass = SingleValuedCostFunction;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Type used for representing point components */
using CoordinateRepresentationType = Superclass::ParametersValueType;
/** Run-time type information (and related methods). */
itkTypeMacro(SingleValuedPointSetToPointSetMetric, SingleValuedCostFunction);
/** Typedefs. */
using FixedPointSetType = TFixedPointSet;
using FixedPointSetPixelType = typename FixedPointSetType::PixelType;
using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer;
using MovingPointSetType = TMovingPointSet;
using MovingPointSetPixelType = typename MovingPointSetType::PixelType;
using MovingPointSetConstPointer = typename MovingPointSetType::ConstPointer;
using PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator;
using PointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator;
/** Constants for the pointset dimensions. */
itkStaticConstMacro(FixedPointSetDimension, unsigned int, TFixedPointSet::PointDimension);
itkStaticConstMacro(MovingPointSetDimension, unsigned int, TMovingPointSet::PointDimension);
/** More typedefs. */
using TransformType =
AdvancedTransform<CoordinateRepresentationType, Self::FixedPointSetDimension, Self::MovingPointSetDimension>;
using TransformPointer = typename TransformType::Pointer;
using InputPointType = typename TransformType::InputPointType;
using OutputPointType = typename TransformType::OutputPointType;
using TransformParametersType = typename TransformType::ParametersType;
using TransformJacobianType = typename TransformType::JacobianType;
using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedPointSetDimension>;
using FixedImageMaskPointer = typename FixedImageMaskType::Pointer;
using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer;
using MovingImageMaskType = ImageMaskSpatialObject<Self::MovingPointSetDimension>;
using MovingImageMaskPointer = typename MovingImageMaskType::Pointer;
using MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer;
/** Type of the measure. */
using Superclass::MeasureType;
using Superclass::DerivativeType;
using DerivativeValueType = typename DerivativeType::ValueType;
using Superclass::ParametersType;
/** Typedefs for support of sparse Jacobians and compact support of transformations. */
using NonZeroJacobianIndicesType = typename TransformType::NonZeroJacobianIndicesType;
/** Connect the fixed pointset. */
itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);
/** Get the fixed pointset. */
itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);
/** Connect the moving pointset. */
itkSetConstObjectMacro(MovingPointSet, MovingPointSetType);
/** Get the moving pointset. */
itkGetConstObjectMacro(MovingPointSet, MovingPointSetType);
/** Connect the Transform. */
itkSetObjectMacro(Transform, TransformType);
/** Get a pointer to the Transform. */
itkGetConstObjectMacro(Transform, TransformType);
/** Set the parameters defining the Transform. */
void
SetTransformParameters(const ParametersType & parameters) const;
/** Return the number of parameters required by the transform. */
unsigned int
GetNumberOfParameters() const override
{
return this->m_Transform->GetNumberOfParameters();
}
/** Initialize the Metric by making sure that all the components are
* present and plugged together correctly.
*/
virtual void
Initialize();
/** Set the fixed mask. */
// \todo: currently not used
itkSetConstObjectMacro(FixedImageMask, FixedImageMaskType);
/** Get the fixed mask. */
itkGetConstObjectMacro(FixedImageMask, FixedImageMaskType);
/** Set the moving mask. */
itkSetConstObjectMacro(MovingImageMask, MovingImageMaskType);
/** Get the moving mask. */
itkGetConstObjectMacro(MovingImageMask, MovingImageMaskType);
/** Contains calls from GetValueAndDerivative that are thread-unsafe. */
virtual void
BeforeThreadedGetValueAndDerivative(const TransformParametersType & parameters) const;
/** Switch the function BeforeThreadedGetValueAndDerivative on or off. */
itkSetMacro(UseMetricSingleThreaded, bool);
itkGetConstReferenceMacro(UseMetricSingleThreaded, bool);
itkBooleanMacro(UseMetricSingleThreaded);
protected:
SingleValuedPointSetToPointSetMetric() = default;
~SingleValuedPointSetToPointSetMetric() override = default;
/** PrintSelf. */
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Member variables. */
FixedPointSetConstPointer m_FixedPointSet{ nullptr };
MovingPointSetConstPointer m_MovingPointSet{ nullptr };
FixedImageMaskConstPointer m_FixedImageMask{ nullptr };
MovingImageMaskConstPointer m_MovingImageMask{ nullptr };
mutable TransformPointer m_Transform{ nullptr };
mutable unsigned int m_NumberOfPointsCounted{ 0 };
/** Variables for multi-threading. */
bool m_UseMetricSingleThreaded{ true };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkSingleValuedPointSetToPointSetMetric.hxx"
#endif
#endif
|