ITK
6.0.0
Insight Toolkit
|
#include <itkPointSetToImageMetric.h>
Computes similarity between a point set and an image.
This Class is templated over the type of the input point-set and image. It expects a Transform and an Interpolator to be plugged in. This particular class is the base class for a hierarchy of similarity metrics.
This class computes a value that measures the similarity between the values associated with points in the point set and the transformed Moving image. The Interpolator is used to compute intensity values on non-grid positions resulting from mapping points through the Transform.
Definition at line 48 of file itkPointSetToImageMetric.h.
Public Member Functions | |
virtual GradientImageType * | GetModifiableGradientImage () |
virtual InterpolatorType * | GetModifiableInterpolator () |
virtual TransformType * | GetModifiableTransform () |
const char * | GetNameOfClass () const override |
unsigned int | GetNumberOfParameters () const override |
virtual const SizeValueType & | GetNumberOfPixelsCounted () const |
virtual void | Initialize () |
virtual void | SetInterpolator (InterpolatorType *_arg) |
virtual void | SetTransform (TransformType *_arg) |
void | SetTransformParameters (const ParametersType ¶meters) const |
virtual void | SetFixedPointSet (const FixedPointSetType *_arg) |
virtual const FixedPointSetType * | GetFixedPointSet () const |
virtual void | SetMovingImage (const MovingImageType *_arg) |
virtual const MovingImageType * | GetMovingImage () const |
virtual void | SetComputeGradient (bool _arg) |
virtual const bool & | GetComputeGradient () const |
Public Member Functions inherited from itk::SingleValuedCostFunction | |
virtual void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const =0 |
const char * | GetNameOfClass () const override |
virtual MeasureType | GetValue (const ParametersType ¶meters) const =0 |
virtual void | GetValueAndDerivative (const ParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const |
Public Member Functions inherited from itk::CostFunctionTemplate< double > | |
const char * | GetNameOfClass () const override |
virtual unsigned int | GetNumberOfParameters () const=0 |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
const char * | GetNameOfClass () const override |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Attributes | |
static constexpr unsigned int | FixedPointSetDimension = TFixedPointSet::PointDimension |
static constexpr unsigned int | MovingImageDimension = TMovingImage::ImageDimension |
Protected Member Functions | |
PointSetToImageMetric () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~PointSetToImageMetric () override=default | |
Protected Member Functions inherited from itk::SingleValuedCostFunction | |
SingleValuedCostFunction ()=default | |
~SingleValuedCostFunction () override | |
Protected Member Functions inherited from itk::CostFunctionTemplate< double > | |
CostFunctionTemplate ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~CostFunctionTemplate () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
bool | m_ComputeGradient {} |
FixedPointSetConstPointer | m_FixedPointSet {} |
GradientImagePointer | m_GradientImage {} |
InterpolatorPointer | m_Interpolator {} |
MovingImageConstPointer | m_MovingImage {} |
SizeValueType | m_NumberOfPixelsCounted {} |
TransformPointer | m_Transform {} |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 57 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::CoordinateRepresentationType = Superclass::ParametersValueType |
Type used for representing point components
Definition at line 60 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::DerivativeType = Superclass::DerivativeType |
Type of the derivative.
Definition at line 109 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer |
Definition at line 72 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetType = TFixedPointSet |
Type of the fixed Image.
Definition at line 71 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterPointer = typename GradientImageFilterType::Pointer |
Definition at line 101 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterType = GradientRecursiveGaussianImageFilter<MovingImageType, GradientImageType> |
Definition at line 99 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImagePointer = SmartPointer<GradientImageType> |
Definition at line 98 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageType = Image<GradientPixelType, Self::MovingImageDimension> |
Definition at line 97 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientPixelType = CovariantVector<RealType, Self::MovingImageDimension> |
Definition at line 96 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InputPointType = typename TransformType::InputPointType |
Definition at line 86 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorPointer = typename InterpolatorType::Pointer |
Definition at line 103 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorType = InterpolateImageFunction<MovingImageType, CoordinateRepresentationType> |
Type of the Interpolator Base class
Definition at line 92 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MeasureType = Superclass::MeasureType |
Type of the measure.
Definition at line 106 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageConstPointer = typename MovingImageType::ConstPointer |
Definition at line 68 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImagePixelType = typename TMovingImage::PixelType |
Definition at line 67 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageType = TMovingImage |
Type of the moving Image.
Definition at line 66 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::OutputPointType = typename TransformType::OutputPointType |
Definition at line 87 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::ParametersType = Superclass::ParametersType |
Type of the parameters.
Definition at line 112 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::PointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator |
Definition at line 79 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Pointer = SmartPointer<Self> |
Definition at line 56 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator |
Definition at line 78 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::RealType = typename NumericTraits<MovingImagePixelType>::RealType |
Gaussian filter to compute the gradient of the Moving Image
Definition at line 95 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Self = PointSetToImageMetric |
Standard class type aliases.
Definition at line 54 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Superclass = SingleValuedCostFunction |
Definition at line 55 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformJacobianType = typename TransformType::JacobianType |
Definition at line 89 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformParametersType = typename TransformType::ParametersType |
Definition at line 88 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformPointer = typename TransformType::Pointer |
Definition at line 85 of file itkPointSetToImageMetric.h.
using itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformType = Transform<CoordinateRepresentationType, Self::MovingImageDimension, Self::FixedPointSetDimension> |
Type of the Transform Base class
Definition at line 82 of file itkPointSetToImageMetric.h.
|
protected |
|
overrideprotecteddefault |
|
virtual |
Set/Get the flag for computing the image gradient. When ON the metric derivative is computed using the Jacobian of the transformation and the image gradient. When OFF the metric derivative is computed by finite differences. Mode ON results in higher speed at the price of large memory footprint. Mode OFF results in small memory footprint at the price of large computation time
|
virtual |
Get/Set the Fixed Image.
|
virtual |
Get Gradient Image.
|
virtual |
Get a pointer to the Interpolator.
|
virtual |
Get a pointer to the Transform.
|
virtual |
Get/Set the Moving Image.
|
overridevirtual |
Reimplemented from itk::SingleValuedCostFunction.
|
inlineoverridevirtual |
Get the number of parameters required by the Transform.
Implements itk::CostFunctionTemplate< double >.
Definition at line 159 of file itkPointSetToImageMetric.h.
|
virtual |
Get the number of pixels considered in the computation.
|
virtual |
Initialize the Metric by making sure that all the components are present and plugged together correctly.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::Object.
|
virtual |
Set/Get the flag for computing the image gradient. When ON the metric derivative is computed using the Jacobian of the transformation and the image gradient. When OFF the metric derivative is computed by finite differences. Mode ON results in higher speed at the price of large memory footprint. Mode OFF results in small memory footprint at the price of large computation time
|
virtual |
Get/Set the Fixed Image.
|
virtual |
Connect the Interpolator.
|
virtual |
Get/Set the Moving Image.
|
virtual |
Connect the Transform.
void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetTransformParameters | ( | const ParametersType & | parameters | ) | const |
Set the parameters defining the Transform.
|
staticconstexpr |
Definition at line 76 of file itkPointSetToImageMetric.h.
|
protected |
Definition at line 184 of file itkPointSetToImageMetric.h.
|
protected |
Definition at line 176 of file itkPointSetToImageMetric.h.
|
protected |
Definition at line 186 of file itkPointSetToImageMetric.h.
|
protected |
Definition at line 182 of file itkPointSetToImageMetric.h.
|
protected |
Definition at line 178 of file itkPointSetToImageMetric.h.
|
mutableprotected |
Definition at line 174 of file itkPointSetToImageMetric.h.
|
mutableprotected |
Definition at line 180 of file itkPointSetToImageMetric.h.
|
staticconstexpr |
Constants for the image dimensions
Definition at line 75 of file itkPointSetToImageMetric.h.