ITK
6.0.0
Insight Toolkit
|
#include <itkImageToSpatialObjectMetric.h>
Computes similarity between a moving spatial object and an Image to be registered.
The ImageToSpatialObjectMetric is different from the rest of the registration framework in ITK regarding the interpretation of the Transform with respect to the Fixed and Moving objects. In most of the ITK registration framework, the Transform computed by the optimizer is the one that maps points from the space of the Fixed object into the space of the Moving object. This direction of the transform is the one that makes easier to resample the Moving object into the space of the Fixed object.
In the particular case of ImageToSpatialObject registration, the Transform to be computed is the one mapping points from the SpatialObject into the Image. This allows the SpatialObject to drive the location and geometry of the measurements made in the image - thereby if the spatial object is sparse and/or contains varying geometric features, the metric applied to measure how well that object matches with the image can be rapidly computed only at the sparse locations and using measures that match the local geometry that should be at those locations in the image. This is particularly useful for fast intra-operative registration when the pre-operative data is used to define a SpatialObject and can anticipate how that object will appear in the intra-operative images.
A full discussion of the Transform directions in the ITK registration framework can be found in the ITK Software Guide.
Definition at line 60 of file itkImageToSpatialObjectMetric.h.
Public Member Functions | |
virtual const ParametersType & | GetLastTransformParameters () const |
virtual InterpolatorType * | GetModifiableInterpolator () |
const char * | GetNameOfClass () const override |
unsigned int | GetNumberOfParameters () const override |
void | GetValueAndDerivative (const ParametersType ¶meters, MeasureType &Value, DerivativeType &Derivative) const override=0 |
virtual void | Initialize () |
virtual void | SetInterpolator (InterpolatorType *_arg) |
virtual void | SetTransform (TransformType *_arg) |
virtual void | SetFixedImage (const FixedImageType *_arg) |
virtual const FixedImageType * | GetFixedImage () const |
virtual void | SetMovingSpatialObject (const MovingSpatialObjectType *_arg) |
virtual const MovingSpatialObjectType * | GetMovingSpatialObject () const |
Public Member Functions inherited from itk::SingleValuedCostFunction | |
virtual void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const =0 |
virtual MeasureType | GetValue (const ParametersType ¶meters) 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 |
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 void | Delete () |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = FixedImageType::ImageDimension |
static constexpr unsigned int | ObjectDimension = MovingSpatialObjectType::ObjectDimension |
Protected Member Functions | |
ImageToSpatialObjectMetric () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~ImageToSpatialObjectMetric () override=default | |
Protected Member Functions inherited from itk::SingleValuedCostFunction | |
SingleValuedCostFunction ()=default | |
~SingleValuedCostFunction () override | |
Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType > | |
CostFunctionTemplate ()=default | |
~CostFunctionTemplate () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
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 | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
FixedImageConstPointer | m_FixedImage {} |
InterpolatorPointer | m_Interpolator {} |
ParametersType | m_LastTransformParameters {} |
MeasureType | m_MatchMeasure { 0 } |
DerivativeType | m_MatchMeasureDerivatives {} |
MovingSpatialObjectConstPointer | m_MovingSpatialObject {} |
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::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ConstPointer = SmartPointer<const Self> |
Definition at line 68 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::CoordinateRepresentationType = Superclass::ParametersValueType |
Type used for representing point components
Definition at line 77 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::DerivativeType = Superclass::DerivativeType |
Type of the derivative of the match measure
Definition at line 106 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageConstPointer = typename FixedImageType::ConstPointer |
Const pointer type for the FixedImage
Definition at line 115 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImagePointer = typename FixedImageType::Pointer |
Pointer type for the FixedImage
Definition at line 109 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageType = TFixedImage |
Type of the fixed image
Definition at line 71 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InputPointType = typename TransformType::InputPointType |
Definition at line 89 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorPointer = typename InterpolatorType::Pointer |
Definition at line 97 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorType = LinearInterpolateImageFunction<TFixedImage, CoordinateRepresentationType> |
Type of the Interpolator Base class
Definition at line 95 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MeasureType = Superclass::MeasureType |
Type of the match measure
Definition at line 103 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer |
Const pointer type for the MovingSpatialObject
Definition at line 118 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectPointer = typename MovingSpatialObjectType::Pointer |
Pointer type for the MovingSpatialObject
Definition at line 112 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectType = TMovingSpatialObject |
Type of the MovingSpatialObject
Definition at line 74 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::OutputPointType = typename TransformType::OutputPointType |
Definition at line 90 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ParametersType = Superclass::ParametersType |
ParametersType type alias. It defines a position in the optimization search space.
Definition at line 122 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Pointer = SmartPointer<Self> |
Definition at line 67 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Self = ImageToSpatialObjectMetric |
Definition at line 65 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Superclass = SingleValuedCostFunction |
Definition at line 66 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformJacobianType = typename TransformType::JacobianType |
Definition at line 92 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformParametersType = typename TransformType::ParametersType |
Definition at line 91 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformPointer = typename TransformType::Pointer |
Definition at line 88 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformType = Transform<CoordinateRepresentationType, Self::ObjectDimension, Self::ImageDimension> |
Type of the Transform Base class
Definition at line 86 of file itkImageToSpatialObjectMetric.h.
using itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::VectorType = vnl_vector_fixed<double, Self::ObjectDimension> |
Typedef of the vector type to return derivatives
Definition at line 100 of file itkImageToSpatialObjectMetric.h.
|
protected |
|
overrideprotecteddefault |
|
virtual |
Get/Set the FixedImage.
|
virtual |
Get the last transformation parameters visited by the optimizer. This function overload the superclass's one.
|
virtual |
Get the Interpolator.
|
virtual |
Get/Set the MovingSpatialObject
|
overridevirtual |
Reimplemented from itk::SingleValuedCostFunction.
|
overridevirtual |
Return the number of parameters required by the Transform.
Implements itk::CostFunctionTemplate< TInternalComputationValueType >.
|
overridepure virtual |
Get Value and Derivatives for MultipleValuedOptimizers
Reimplemented from itk::SingleValuedCostFunction.
|
virtual |
Initialize the metric.
|
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::CostFunctionTemplate< TInternalComputationValueType >.
|
virtual |
Get/Set the FixedImage.
|
virtual |
Connect the Interpolator.
|
virtual |
Get/Set the MovingSpatialObject
|
virtual |
Set/Get the Transform.
|
staticconstexpr |
Image dimension enumeration.
Definition at line 80 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 177 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 174 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 178 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 171 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 172 of file itkImageToSpatialObjectMetric.h.
|
protected |
Definition at line 176 of file itkImageToSpatialObjectMetric.h.
|
mutableprotected |
Definition at line 173 of file itkImageToSpatialObjectMetric.h.
|
staticconstexpr |
Object dimension enumeration.
Definition at line 83 of file itkImageToSpatialObjectMetric.h.