ITK  6.0.0
Insight Toolkit
itkKappaStatisticImageToImageMetric.h
Go to the documentation of this file.
1/*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18#ifndef itkKappaStatisticImageToImageMetric_h
19#define itkKappaStatisticImageToImageMetric_h
20
22
23namespace itk
24{
53template <typename TFixedImage, typename TMovingImage>
54class ITK_TEMPLATE_EXPORT KappaStatisticImageToImageMetric : public ImageToImageMetric<TFixedImage, TMovingImage>
55{
56public:
57 ITK_DISALLOW_COPY_AND_MOVE(KappaStatisticImageToImageMetric);
58
64
66 itkNewMacro(Self);
67
69 itkOverrideGetNameOfClassMacro(KappaStatisticImageToImageMetric);
70
72 using typename Superclass::RealType;
73 using typename Superclass::TransformType;
74 using typename Superclass::TransformPointer;
75 using typename Superclass::TransformParametersType;
76 using typename Superclass::TransformJacobianType;
77 using typename Superclass::GradientImageType;
78 using typename Superclass::GradientPixelType;
79 using typename Superclass::InputPointType;
80 using typename Superclass::OutputPointType;
81
82 using typename Superclass::MeasureType;
83 using typename Superclass::DerivativeType;
84 using typename Superclass::FixedImageType;
85 using typename Superclass::MovingImageType;
86 using typename Superclass::FixedImageConstPointer;
87 using typename Superclass::MovingImageConstPointer;
88 using typename Superclass::FixedImageRegionType;
89
91 void
92 ComputeGradient() override;
93
95 void
96 GetDerivative(const TransformParametersType &, DerivativeType & derivative) const override;
97
104 GetValue(const TransformParametersType & parameters) const override;
105
108 void
110 MeasureType & Value,
111 DerivativeType & Derivative) const override;
112
115 itkSetMacro(ForegroundValue, RealType);
116 itkGetConstMacro(ForegroundValue, RealType);
123 itkSetMacro(Complement, bool);
124 itkBooleanMacro(Complement);
125 itkGetConstMacro(Complement, bool);
128protected:
131 void
132 PrintSelf(std::ostream & os, Indent indent) const override;
133
134private:
135 RealType m_ForegroundValue{};
136 bool m_Complement{ false };
137};
138} // end namespace itk
139
140#ifndef ITK_MANUAL_INSTANTIATION
141# include "itkKappaStatisticImageToImageMetric.hxx"
142#endif
143
144#endif
Array class with size defined at construction time.
Definition: itkArray.h:48
Computes similarity between regions of two images.
typename NumericTraits< MovingImagePixelType >::RealType RealType
typename TransformType::ParametersType TransformParametersType
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Computes similarity between two binary objects to be registered.
void GetValueAndDerivative(const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
~KappaStatisticImageToImageMetric() override=default
void PrintSelf(std::ostream &os, Indent indent) const override
void GetDerivative(const TransformParametersType &, DerivativeType &derivative) const override
MeasureType GetValue(const TransformParametersType &parameters) const override
Light weight base class for most itk classes.
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....