template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
class itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
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 for each of fixed and moving point sets. The transforms default to IdentityTransform types. 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 moving point-set in the moving domain. The fixed point set is transformed into the virtual domain by computing the inverse of the fixed transform, then transformed into the moving domain using the moving transform.
Since the PointSet class permits each Point to be associated with a PixelType, there are potential applications which could make use of this additional information. For example, the derived LabeledPointSetToPointSetMetric class uses the PixelType as a LabelEnum for estimating total metric values and gradients from the individual label-wise point subset metric and derivatives
If a virtual domain is not defined by the user, one of two things happens: 1) If the moving transform is a global type, then the virtual domain is left undefined and every point is considered to be within the virtual domain. 2) If the moving transform is a local-support type, then the virtual domain is taken during initialization from the moving transform displacement field, and all fixed points are verified to be within the virtual domain after transformation by the inverse fixed transform. Points outside the virtual domain are not used. See GetNumberOfValidPoints() to verify how many fixed points were used during evaluation.
See ObjectToObjectMetric documentation for more discussion on the virtual domain.
- Note
- When used with an RegistrationParameterScalesEstimator estimator, a VirtualDomainPointSet must be defined and assigned to the estimator, for use in shift estimation. The virtual domain point set can be retrieved from the metric using the GetVirtualTransformedPointSet() method.
Definition at line 72 of file itkPointSetToPointSetMetricWithIndexv4.h.
|
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | CoordRepType = typename PointType::CoordRepType |
| |
| using | DerivativeValueType = typename DerivativeType::ValueType |
| |
| using | DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType |
| |
| using | FixedPixelType = typename TFixedPointSet::PixelType |
| |
| using | FixedPointsContainer = typename TFixedPointSet::PointsContainer |
| |
| using | FixedPointSetType = TFixedPointSet |
| |
| using | FixedPointType = typename TFixedPointSet::PointType |
| |
| using | FixedTransformedPointSetType = PointSet< FixedPixelType, Self::PointDimension > |
| |
| using | LocalDerivativeType = FixedArray< DerivativeValueType, Self::PointDimension > |
| |
| using | MovingPixelType = typename TMovingPointSet::PixelType |
| |
| using | MovingPointsContainer = typename TMovingPointSet::PointsContainer |
| |
| using | MovingPointSetType = TMovingPointSet |
| |
| using | MovingPointType = typename TMovingPointSet::PointType |
| |
| using | MovingTransformedPointSetType = PointSet< MovingPixelType, Self::PointDimension > |
| |
| using | NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType |
| |
| using | ObjectType = typename Superclass::ObjectType |
| |
| using | PixelType = FixedPixelType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | PointIdentifier = typename PointsContainer::ElementIdentifier |
| |
| using | PointsConstIterator = typename PointsContainer::ConstIterator |
| |
| using | PointsContainer = FixedPointsContainer |
| |
| using | PointsLocatorType = PointsLocator< PointsContainer > |
| |
| using | PointType = FixedPointType |
| |
| using | Self = PointSetToPointSetMetricWithIndexv4 |
| |
| using | Superclass = ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType > |
| |
| using | VirtualImageType = typename Superclass::VirtualImageType |
| |
| using | VirtualOriginType = typename Superclass::VirtualPointType |
| |
| using | VirtualRadiusType = typename Superclass::VirtualSizeType |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | CoordinateRepresentationType = TInternalComputationValueType |
| |
| using | DimensionType = SizeValueType |
| |
| using | FixedInputPointType = typename FixedTransformType::InputPointType |
| |
| using | FixedOutputPointType = typename FixedTransformType::OutputPointType |
| |
| using | FixedTransformJacobianType = typename FixedTransformType::JacobianType |
| |
| using | FixedTransformParametersType = typename FixedTransformType::ParametersType |
| |
| using | FixedTransformPointer = typename FixedTransformType::Pointer |
| |
| using | FixedTransformType = Transform< TInternalComputationValueType, Image< TInternalComputationValueType, TFixedPointSet::PointDimension > ::ImageDimension, TFixedDimension > |
| |
| using | InternalComputationValueType = TInternalComputationValueType |
| |
| using | JacobianType = typename FixedTransformType::JacobianType |
| |
| using | MetricCategoryType = typename Superclass::MetricCategoryEnum |
| |
| using | MovingDisplacementFieldTransformType = DisplacementFieldTransform< CoordinateRepresentationType, Self::MovingDimension > |
| |
| using | MovingInputPointType = typename MovingTransformType::InputPointType |
| |
| using | MovingOutputPointType = typename MovingTransformType::OutputPointType |
| |
| using | MovingTransformJacobianType = typename MovingTransformType::JacobianType |
| |
| using | MovingTransformParametersType = typename MovingTransformType::ParametersType |
| |
| using | MovingTransformPointer = typename MovingTransformType::Pointer |
| |
| using | MovingTransformType = Transform< TInternalComputationValueType, Image< TInternalComputationValueType, TFixedPointSet::PointDimension > ::ImageDimension, TMovingDimension > |
| |
| using | ObjectType = typename Superclass::Object |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = ObjectToObjectMetric |
| |
| using | Superclass = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType > |
| |
| using | VirtualDirectionType = typename VirtualImageType::DirectionType |
| |
| using | VirtualImageConstPointer = typename VirtualImageType::ConstPointer |
| |
| using | VirtualImagePointer = typename VirtualImageType::Pointer |
| |
| using | VirtualImageType = Image< TInternalComputationValueType, TFixedPointSet::PointDimension > |
| |
| using | VirtualIndexType = typename VirtualImageType::IndexType |
| |
| using | VirtualOriginType = typename VirtualImageType::PointType |
| |
| using | VirtualPixelType = typename VirtualImageType::PixelType |
| |
| using | VirtualPointSetPointer = typename VirtualPointSetType::Pointer |
| |
| using | VirtualPointSetType = PointSet< VirtualPixelType, Self::VirtualDimension > |
| |
| using | VirtualPointType = typename VirtualImageType::PointType |
| |
| using | VirtualRadiusType = typename VirtualImageType::SizeType |
| |
| using | VirtualRegionType = typename VirtualImageType::RegionType |
| |
| using | VirtualSizeType = typename VirtualRegionType::SizeType |
| |
| using | VirtualSpacingType = typename VirtualImageType::SpacingType |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | CoordinateRepresentationType = TInternalComputationValueType |
| |
| using | DerivativeValueType = typename DerivativeType::ValueType |
| |
| using | GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource |
| |
| using | MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory |
| |
| using | NumberOfParametersType = unsigned int |
| |
| using | ObjectConstPointer = typename ObjectType::ConstPointer |
| |
| using | ObjectType = Object |
| |
| using | ParametersValueType = TInternalComputationValueType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = ObjectToObjectMetricBaseTemplate |
| |
| using | Superclass = SingleValuedCostFunctionv4Template< TInternalComputationValueType > |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | DerivativeType = Array< TInternalComputationValueType > |
| |
| using | MeasureType = TInternalComputationValueType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = SingleValuedCostFunctionv4Template |
| |
| using | Superclass = CostFunctionTemplate< TInternalComputationValueType > |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | ParametersType = OptimizerParameters< TInternalComputationValueType > |
| |
| using | ParametersValueType = TInternalComputationValueType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = CostFunctionTemplate |
| |
| using | Superclass = Object |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = Object |
| |
| using | Superclass = LightObject |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = LightObject |
| |
|
| void | GetDerivative (DerivativeType &) const override |
| |
| virtual FixedTransformedPointSetType * | GetModifiableFixedTransformedPointSet () |
| |
| virtual MovingTransformedPointSetType * | GetModifiableMovingTransformedPointSet () |
| |
| const char * | GetNameOfClass () const override |
| |
| SizeValueType | GetNumberOfComponents () const |
| |
| MeasureType | GetValue () const override |
| |
| void | GetValueAndDerivative (MeasureType &, DerivativeType &) const override |
| |
| const VirtualPointSetType * | GetVirtualTransformedPointSet () const |
| |
| void | Initialize () override |
| |
| bool | SupportsArbitraryVirtualDomainSamples () const override |
| |
|
| void | SetFixedObject (const ObjectType *object) override |
| |
|
| void | SetMovingObject (const ObjectType *object) override |
| |
|
| virtual void | SetFixedPointSet (const FixedPointSetType *_arg) |
| |
| virtual const FixedPointSetType * | GetFixedPointSet () const |
| |
|
| virtual void | SetMovingPointSet (const MovingPointSetType *_arg) |
| |
| virtual const MovingPointSetType * | GetMovingPointSet () const |
| |
|
| virtual void | SetStoreDerivativeAsSparseFieldForLocalSupportTransforms (bool _arg) |
| |
| virtual bool | GetStoreDerivativeAsSparseFieldForLocalSupportTransforms () const |
| |
| virtual void | StoreDerivativeAsSparseFieldForLocalSupportTransformsOn () |
| |
|
| virtual void | SetCalculateValueAndDerivativeInTangentSpace (bool _arg) |
| |
| virtual bool | GetCalculateValueAndDerivativeInTangentSpace () const |
| |
| virtual void | CalculateValueAndDerivativeInTangentSpaceOn () |
| |
| OffsetValueType | ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const |
| |
| OffsetValueType | ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const |
| |
| MetricCategoryType | GetMetricCategory () const override |
| |
| virtual FixedTransformType * | GetModifiableFixedTransform () |
| |
| virtual MovingTransformType * | GetModifiableMovingTransform () |
| |
| virtual VirtualImageType * | GetModifiableVirtualImage () |
| |
| const char * | GetNameOfClass () const override |
| |
| NumberOfParametersType | GetNumberOfLocalParameters () const override |
| |
| NumberOfParametersType | GetNumberOfParameters () const override |
| |
| virtual SizeValueType | GetNumberOfValidPoints () const |
| |
| const ParametersType & | GetParameters () const override |
| |
| const MovingTransformType * | GetTransform () |
| |
| VirtualDirectionType | GetVirtualDirection () const |
| |
| virtual const TimeStamp & | GetVirtualDomainTimeStamp () const |
| |
| VirtualOriginType | GetVirtualOrigin () const |
| |
| const VirtualRegionType & | GetVirtualRegion () const |
| |
| VirtualSpacingType | GetVirtualSpacing () const |
| |
| bool | HasLocalSupport () const override |
| |
| void | Initialize () override |
| |
| virtual void | SetFixedTransform (FixedTransformType *_arg) |
| |
| virtual void | SetMovingTransform (MovingTransformType *_arg) |
| |
| void | SetParameters (ParametersType ¶ms) override |
| |
| void | SetTransform (MovingTransformType *transform) |
| |
| void | SetVirtualDomain (const VirtualSpacingType &spacing, const VirtualOriginType &origin, const VirtualDirectionType &direction, const VirtualRegionType ®ion) |
| |
| void | SetVirtualDomainFromImage (const VirtualImageType *virtualImage) |
| |
| void | UpdateTransformParameters (const DerivativeType &derivative, TInternalComputationValueType factor) override |
| |
| bool | IsInsideVirtualDomain (const VirtualPointType &point) const |
| |
| bool | IsInsideVirtualDomain (const VirtualIndexType &index) const |
| |
| MeasureType | GetCurrentValue () const |
| |
| virtual GradientSourceEnum | GetGradientSource () const |
| |
| bool | GetGradientSourceIncludesFixed () const |
| |
| bool | GetGradientSourceIncludesMoving () const |
| |
| virtual void | SetGradientSource (GradientSourceEnum _arg) |
| |
| virtual const ObjectType * | GetFixedObject () const |
| |
| virtual const ObjectType * | GetMovingObject () const |
| |
| 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 |
| |
| Pointer | Clone () const |
| |
| virtual void | Delete () |
| |
| virtual int | GetReferenceCount () const |
| |
| void | Print (std::ostream &os, Indent indent=0) const |
| |
|
| virtual SizeValueType | CalculateNumberOfValidFixedPoints () const |
| |
| void | CalculateValueAndDerivative (MeasureType &calculatedValue, DerivativeType &derivative, bool calculateValue) const |
| |
| virtual LocalDerivativeType | GetLocalNeighborhoodDerivativeWithIndex (const PointIdentifier &, const PointType &, const PixelType &pixel) const |
| |
| virtual void | GetLocalNeighborhoodValueAndDerivativeWithIndex (const PointIdentifier &, const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel) const =0 |
| |
| virtual MeasureType | GetLocalNeighborhoodValueWithIndex (const PointIdentifier &, const PointType &, const PixelType &pixel) const =0 |
| |
| MetricCategoryType | GetMetricCategory () const override |
| |
| virtual void | InitializeForIteration () const |
| |
| virtual void | InitializePointSets () const |
| |
| void | InitializePointsLocators () const |
| |
| | PointSetToPointSetMetricWithIndexv4 () |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| virtual bool | RequiresFixedPointsLocator () const |
| |
| virtual bool | RequiresMovingPointsLocator () const |
| |
| void | StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const |
| |
| void | TransformFixedAndCreateVirtualPointSet () const |
| |
| void | TransformMovingPointSet () const |
| |
| | ~PointSetToPointSetMetricWithIndexv4 () override=default |
| |
| const MovingDisplacementFieldTransformType * | GetMovingDisplacementFieldTransform () const |
| |
| | ObjectToObjectMetric () |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| bool | TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const |
| |
| void | TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const |
| |
| virtual void | VerifyDisplacementFieldSizeAndPhysicalSpace () |
| |
| bool | VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const |
| |
| | ~ObjectToObjectMetric () override=default |
| |
| | ObjectToObjectMetricBaseTemplate () |
| |
| | ~ObjectToObjectMetricBaseTemplate () override=default |
| |
| | SingleValuedCostFunctionv4Template ()=default |
| |
| | ~SingleValuedCostFunctionv4Template () override=default |
| |
| | CostFunctionTemplate ()=default |
| |
| | ~CostFunctionTemplate () override=default |
| |
| | Object () |
| |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| |
| virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
| |
| | ~Object () override |
| |
| 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 () |
| |
Inheritance diagram for itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >:
1.8.16