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
|
/*=========================================================================
*
* 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.
*
*=========================================================================*/
#ifndef elxAdvancedNormalizedCorrelationMetric_h
#define elxAdvancedNormalizedCorrelationMetric_h
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkAdvancedNormalizedCorrelationImageToImageMetric.h"
namespace elastix
{
/**
* \class AdvancedNormalizedCorrelationMetric
* \brief An metric based on the itk::AdvancedNormalizedCorrelationImageToImageMetric.
*
* The parameters used in this class are:
* \parameter Metric: Select this metric as follows:\n
* <tt>(Metric "AdvancedNormalizedCorrelation")</tt>
*
* \note The parameter "SubtractMean" is obsolete, and will be ignored. The current elastix version just has the default
* behavior of elastix <= version 5.1.0: For this parameter, the default value was true. This means that the sample mean
* is subtracted from the sample values in the cross correlation formula. This typically results in narrower valleys in
* the cost function.
*
* \ingroup Metrics
*
*/
template <class TElastix>
class ITK_TEMPLATE_EXPORT AdvancedNormalizedCorrelationMetric
: public itk::AdvancedNormalizedCorrelationImageToImageMetric<typename MetricBase<TElastix>::FixedImageType,
typename MetricBase<TElastix>::MovingImageType>
, public MetricBase<TElastix>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(AdvancedNormalizedCorrelationMetric);
/** Standard ITK-stuff. */
using Self = AdvancedNormalizedCorrelationMetric;
using Superclass1 =
itk::AdvancedNormalizedCorrelationImageToImageMetric<typename MetricBase<TElastix>::FixedImageType,
typename MetricBase<TElastix>::MovingImageType>;
using Superclass2 = MetricBase<TElastix>;
using Pointer = itk::SmartPointer<Self>;
using ConstPointer = itk::SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(AdvancedNormalizedCorrelationMetric, itk::AdvancedNormalizedCorrelationImageToImageMetric);
/** Name of this class.
* Use this name in the parameter file to select this specific metric. \n
* example: <tt>(Metric "AdvancedNormalizedCorrelation")</tt>\n
*/
elxClassNameMacro("AdvancedNormalizedCorrelation");
/** Typedefs from the superclass. */
using typename Superclass1::CoordinateRepresentationType;
using typename Superclass1::MovingImageType;
using typename Superclass1::MovingImagePixelType;
using typename Superclass1::MovingImageConstPointer;
using typename Superclass1::FixedImageType;
using typename Superclass1::FixedImageConstPointer;
using typename Superclass1::FixedImageRegionType;
using typename Superclass1::TransformType;
using typename Superclass1::TransformPointer;
using typename Superclass1::InputPointType;
using typename Superclass1::OutputPointType;
using typename Superclass1::TransformParametersType;
using typename Superclass1::TransformJacobianType;
using typename Superclass1::InterpolatorType;
using typename Superclass1::InterpolatorPointer;
using typename Superclass1::RealType;
using typename Superclass1::GradientPixelType;
using typename Superclass1::GradientImageType;
using typename Superclass1::GradientImagePointer;
using typename Superclass1::FixedImageMaskType;
using typename Superclass1::FixedImageMaskPointer;
using typename Superclass1::MovingImageMaskType;
using typename Superclass1::MovingImageMaskPointer;
using typename Superclass1::MeasureType;
using typename Superclass1::DerivativeType;
using typename Superclass1::ParametersType;
using typename Superclass1::FixedImagePixelType;
using typename Superclass1::MovingImageRegionType;
using typename Superclass1::ImageSamplerType;
using typename Superclass1::ImageSamplerPointer;
using typename Superclass1::ImageSampleContainerType;
using typename Superclass1::ImageSampleContainerPointer;
using typename Superclass1::FixedImageLimiterType;
using typename Superclass1::MovingImageLimiterType;
using typename Superclass1::FixedImageLimiterOutputType;
using typename Superclass1::MovingImageLimiterOutputType;
using typename Superclass1::MovingImageDerivativeScalesType;
/** The fixed image dimension. */
itkStaticConstMacro(FixedImageDimension, unsigned int, FixedImageType::ImageDimension);
/** The moving image dimension. */
itkStaticConstMacro(MovingImageDimension, unsigned int, MovingImageType::ImageDimension);
/** Typedef's inherited from Elastix. */
using typename Superclass2::ElastixType;
using typename Superclass2::RegistrationType;
using ITKBaseType = typename Superclass2::ITKBaseType;
/** Execute stuff before each new pyramid resolution:
* \li Set the flag to subtract the mean.
* \li Set the CheckNumberOfSamples setting.
*/
void
BeforeEachResolution() override;
/** Sets up a timer to measure the initialization time and
* calls the Superclass' implementation.
*/
void
Initialize() override;
protected:
/** The constructor. */
AdvancedNormalizedCorrelationMetric() = default;
/** The destructor. */
~AdvancedNormalizedCorrelationMetric() override = default;
private:
elxOverrideGetSelfMacro;
};
} // end namespace elastix
#ifndef ITK_MANUAL_INSTANTIATION
# include "elxAdvancedNormalizedCorrelationMetric.hxx"
#endif
#endif // end #ifndef elxAdvancedNormalizedCorrelationMetric_h
|