InverseRealTransformGradientDescent (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.realtransform.inverse.InverseRealTransformGradientDescent

All Implemented Interfaces:: RealTransform

public class InverseRealTransformGradientDescent
extends Object
implements RealTransform

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description

InverseRealTransformGradientDescent(int ndims, DifferentiableRealTransform xfm)

Constructors
Constructor and Description
`InverseRealTransformGradientDescent(int ndims, DifferentiableRealTransform xfm)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`apply(double[] s, double[] t)` Apply the `RealTransform` to a source vector to obtain a target vector.
`void`	`apply(float[] src, float[] tgt)` Deprecated.
`void`	`apply(RealLocalizable src, RealPositionable tgt)` Apply the `RealTransform` to a source `RealLocalizable` to obtain a target `RealPositionable`.
`boolean`	`armijoCondition(double c, double t)` Returns true if the armijo condition is satisfied.
`double`	`backtrackingLineSearch(double t0)` Uses Backtracking Line search to determine a step size.
`double`	`backtrackingLineSearch(double c, double beta, int maxtries, double t0)` Uses Backtracking Line search to determine a step size.
`RealTransform`	`copy()` Create a deep copy of this `RealTransform`.
`double[]`	`getDirection()`
`double`	`getError()`
`double[]`	`getErrorVector()`
`double[]`	`getEstimate()`
`double`	`inverseTol(double[] target, double[] guess, double tolerance, int maxIters)`
`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`	`regularizeJacobian()` Changes jacobian (J) to be: ( 1-eps ) * J + ( eps ) * I note jacRegMatrix = eps * I
`void`	`setBeta(double beta)`
`void`	`setC(double c)`
`void`	`setEstimate(double[] est)`
`void`	`setEstimateXfm(double[] est)`
`void`	`setFixZ(boolean fixZ)`
`void`	`setGuess(double[] guess)`
`void`	`setJacobianEstimateStep(double jacStep)`
`void`	`setJacobianRegularizationEps(double e)`
`void`	`setMaxIters(int maxIters)`
`void`	`setMaxStep(double maxStep)`
`void`	`setMinStep(double minStep)`
`void`	`setStepSize(double stepSize)`
`void`	`setStepSizeMaxTries(int stepSizeMaxTries)`
`void`	`setTarget(double[] tgt)`
`void`	`setTolerance(double tol)`
`double`	`squaredError(double[] x)`
`static double`	`sumSquaredErrors(double[] y, double[] x)`
`void`	`updateError()`
`void`	`updateEstimate(double stepSize)`

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
isIdentity

- Field Detail
  - logger
```
protected static org.slf4j.Logger logger
```
- Constructor Detail
  - InverseRealTransformGradientDescent
```
public InverseRealTransformGradientDescent(int ndims,
                                           DifferentiableRealTransform xfm)
```
- Method Detail
  - setBeta
```
public void setBeta(double beta)
```
  - setC
```
public void setC(double c)
```
  - setTolerance
```
public void setTolerance(double tol)
```
  - setMaxIters
```
public void setMaxIters(int maxIters)
```
  - setFixZ
```
public void setFixZ(boolean fixZ)
```
  - setStepSize
```
public void setStepSize(double stepSize)
```
  - setMinStep
```
public void setMinStep(double minStep)
```
  - setMaxStep
```
public void setMaxStep(double maxStep)
```
  - setJacobianEstimateStep
```
public void setJacobianEstimateStep(double jacStep)
```
  - setJacobianRegularizationEps
```
public void setJacobianRegularizationEps(double e)
```
  - setStepSizeMaxTries
```
public void setStepSizeMaxTries(int stepSizeMaxTries)
```
  - setTarget
```
public void setTarget(double[] tgt)
```
  - getErrorVector
```
public double[] getErrorVector()
```
  - getDirection
```
public double[] getDirection()
```
  - setEstimate
```
public void setEstimate(double[] est)
```
  - setEstimateXfm
```
public void setEstimateXfm(double[] est)
```
  - getEstimate
```
public double[] getEstimate()
```
  - getError
```
public double getError()
```
  - numSourceDimensions
```
public int numSourceDimensions()
```
    Description copied from interface: RealTransform
    
    Returns n, the minimal number of dimension of the source vector.
    
    Specified by:
    
    numSourceDimensions in interface RealTransform
    
    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.
    
    Specified by:
    
    numTargetDimensions in interface RealTransform
    
    Returns:
    
    the dimension of the target vector.
  - copy
```
public RealTransform 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.
    
    Specified by:
    
    copy in interface RealTransform
    
    Returns:
    
    deep copy
  - setGuess
```
public void setGuess(double[] guess)
```
  - apply
```
public void apply(double[] s,
                  double[] t)
```
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    s - source coordinates, length must be >= RealTransform.numSourceDimensions()
    
    t - set this to the target coordinates, length must be >= RealTransform.numTargetDimensions()
  - apply
```
@Deprecated
public void apply(float[] src,
                              float[] tgt)
```
    Deprecated.
    
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    src - source coordinates, length must be >= RealTransform.numSourceDimensions()
    
    tgt - set this to the target coordinates, length must be >= RealTransform.numTargetDimensions()
  - apply
```
public void apply(RealLocalizable src,
                  RealPositionable tgt)
```
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source RealLocalizable to obtain a target RealPositionable.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    src - source coordinates, numDimensions() must be >= RealTransform.numSourceDimensions()
    
    tgt - set this to the target coordinates, numDimensions() must be >= RealTransform.numTargetDimensions()
  - inverseTol
```
public double inverseTol(double[] target,
                         double[] guess,
                         double tolerance,
                         int maxIters)
```
  - regularizeJacobian
```
public void regularizeJacobian()
```
    Changes jacobian (J) to be: ( 1-eps ) * J + ( eps ) * I note jacRegMatrix = eps * I
  - backtrackingLineSearch
```
public double backtrackingLineSearch(double t0)
```
    Uses Backtracking Line search to determine a step size.
    
    Parameters:
    
    t0 - initial step size
    
    Returns:
    
    the step size
  - backtrackingLineSearch
```
public double backtrackingLineSearch(double c,
                                     double beta,
                                     int maxtries,
                                     double t0)
```
    Uses Backtracking Line search to determine a step size.
    
    Parameters:
    
    c - the armijoCondition parameter
    
    beta - the fraction to multiply the step size at each iteration ( less than 1 )
    
    maxtries - max number of tries
    
    t0 - initial step size
    
    Returns:
    
    the step size
  - armijoCondition
```
public boolean armijoCondition(double c,
                               double t)
```
    Returns true if the armijo condition is satisfied.
    
    Parameters:
    
    c - the c parameter
    
    t - the step size
    
    Returns:
    
    true if the step size satisfies the condition
  - squaredError
```
public double squaredError(double[] x)
```
  - updateEstimate
```
public void updateEstimate(double stepSize)
```
  - updateError
```
public void updateError()
```
  - sumSquaredErrors
```
public static double sumSquaredErrors(double[] y,
                                      double[] x)
```

Class InverseRealTransformGradientDescent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.realtransform.RealTransform

Field Detail

logger

Constructor Detail

InverseRealTransformGradientDescent

Method Detail

setBeta

setC

setTolerance

setMaxIters

setFixZ

setStepSize

setMinStep

setMaxStep

setJacobianEstimateStep

setJacobianRegularizationEps

setStepSizeMaxTries

setTarget

getErrorVector

getDirection

setEstimate

setEstimateXfm

getEstimate

getError

numSourceDimensions

numTargetDimensions

copy

setGuess

apply

apply

apply

inverseTol

regularizeJacobian

backtrackingLineSearch

backtrackingLineSearch

armijoCondition

squaredError

updateEstimate

updateError

sumSquaredErrors