net.imglib2.realtransform.inverse

Class RealTransformFiniteDerivatives

java.lang.Object

net.imglib2.realtransform.inverse.AbstractDifferentiableRealTransform

net.imglib2.realtransform.inverse.RealTransformFiniteDerivatives

All Implemented Interfaces:

DifferentiableRealTransform, RealTransform

public class RealTransformFiniteDerivatives
extends AbstractDifferentiableRealTransform

Use finite differences to estimate the jacobian of an arbitrary RealTransform.

Author:

John Bogovic

Field Summary

Fields

Modifier and Type	Field and Description
protected AffineTransform	jacobian
protected double	step
protected RealTransform	transform

Constructor Summary

Constructors

Constructor and Description
RealTransformFiniteDerivatives(RealTransform transform)

Method Summary

Modifier and Type	Method and Description
void	apply(double[] source, double[] target) Apply the RealTransform to a source vector to obtain a target vector.
void	apply(net.imglib2.RealLocalizable source, net.imglib2.RealPositionable target) Apply the RealTransform to a source RealLocalizable to obtain a target RealPositionable.
RealTransformFiniteDerivatives	copy() Create a deep copy of this RealTransform.
AffineTransform	jacobian(double[] x) Estimates the jacobian matrix at x of the wrapped RealTransform.
int	numSourceDimensions() Returns n, the minimal number of dimension of the source vector.
int	numTargetDimensions() Returns m, the minimal dimension of the target vector.
void	setStep(double step)

Methods inherited from class net.imglib2.realtransform.inverse.AbstractDifferentiableRealTransform

directionToward, directionToward, matrixTranspose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.realtransform.RealTransform

apply, apply, applyDimension, applyDimension, applyDimension, boundingInterval, isIdentity

Field Detail

transform

protected final RealTransform transform

jacobian

protected final AffineTransform jacobian

step

protected double step

Constructor Detail

RealTransformFiniteDerivatives

public RealTransformFiniteDerivatives(RealTransform transform)

Method Detail

setStep

public void setStep(double step)

numSourceDimensions

public int numSourceDimensions()

Description copied from interface: RealTransform

Returns n, the minimal number of dimension of the source vector.

Returns:

the dimension of the source vector.

numTargetDimensions

public int numTargetDimensions()

Description copied from interface: RealTransform

Returns m, the minimal dimension of the target vector.

Returns:

the dimension of the target vector.

apply

public void apply(double[] source,
                  double[] target)

Description copied from interface: RealTransform

Apply the RealTransform to a source vector to obtain a target vector.

Parameters:

source - source coordinates, length must be >= RealTransform.numSourceDimensions()

target - set this to the target coordinates, length must be >= RealTransform.numTargetDimensions()

apply

public void apply(net.imglib2.RealLocalizable source,
                  net.imglib2.RealPositionable target)

Description copied from interface: RealTransform

Apply the RealTransform to a source RealLocalizable to obtain a target RealPositionable.

Parameters:

source - source coordinates, numDimensions() must be >= RealTransform.numSourceDimensions()

target - set this to the target coordinates, numDimensions() must be >= RealTransform.numTargetDimensions()

copy

public RealTransformFiniteDerivatives copy()

Description copied from interface: RealTransform

Create a deep copy of this RealTransform.

Deep copying is required to make sure that stateful RealTransforms can be duplicated for concurrent code.

Returns:

deep copy

jacobian

public AffineTransform jacobian(double[] x)

Estimates the jacobian matrix at x of the wrapped RealTransform. Returns an AffineTransform so that matrix operations are convenient.

Specified by:

jacobian in interface DifferentiableRealTransform

Specified by:

jacobian in class AbstractDifferentiableRealTransform

Parameters:

x - the point at which to estimate the jacobian

Returns:

the jacobian