InvertibleTransformByGradientDescent (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

InvertibleRealTransform, RealTransform
```
public class InvertibleTransformByGradientDescent
extends Object
implements InvertibleRealTransform
```
Use gradient descent to iteratively estimate the inverse of a differentiable forward transformation.

Author:

John Bogovic

Constructor Summary

Constructors
Constructor and Description
`InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform)`
`InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform, BacktrackingLineSearch inverseTransform, boolean isInverse)`
`InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform, boolean isInverse)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(double[] p, double[] q)` Apply the `RealTransform` to a source vector to obtain a target vector.
`void`	`apply(RealLocalizable p, RealPositionable q)` Apply the `RealTransform` to a source `RealLocalizable` to obtain a target `RealPositionable`.
`void`	`applyInverse(double[] p, double[] q)` Apply the inverse transform to a target vector to obtain a source vector.
`void`	`applyInverse(RealPositionable p, RealLocalizable q)` Apply the inverse transform to a target `RealLocalizable` to obtain a source `RealPositionable`.
`InvertibleTransformByGradientDescent`	`copy()` Create a deep copy of this `RealTransform`.
`InvertibleTransformByGradientDescent`	`inverse()` Get the inverse transform.
`int`	`numSourceDimensions()` Returns n, the minimal number of dimension of the source vector.
`int`	`numTargetDimensions()` Returns m, the minimal dimension of the target vector.

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.InvertibleRealTransform
applyInverse

Methods inherited from interface net.imglib2.realtransform.RealTransform
apply, isIdentity

- Constructor Detail
  - InvertibleTransformByGradientDescent
```
public InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform)
```
  - InvertibleTransformByGradientDescent
```
public InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform,
                                            boolean isInverse)
```
  - InvertibleTransformByGradientDescent
```
public InvertibleTransformByGradientDescent(DifferentiableRealTransform forwardTransform,
                                            BacktrackingLineSearch inverseTransform,
                                            boolean isInverse)
```
- Method Detail
  - apply
```
public void apply(double[] p,
                  double[] q)
```
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    p - source coordinates, length must be >= RealTransform.numSourceDimensions()
    
    q - set this to the target coordinates, length must be >= RealTransform.numTargetDimensions()
  - apply
```
public void apply(RealLocalizable p,
                  RealPositionable q)
```
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source RealLocalizable to obtain a target RealPositionable.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    p - source coordinates, numDimensions() must be >= RealTransform.numSourceDimensions()
    
    q - set this to the target coordinates, numDimensions() must be >= RealTransform.numTargetDimensions()
  - applyInverse
```
public void applyInverse(double[] p,
                         double[] q)
```
    Description copied from interface: InvertibleRealTransform
    
    Apply the inverse transform to a target vector to obtain a source vector.
    
    Specified by:
    
    applyInverse in interface InvertibleRealTransform
    
    Parameters:
    
    p - set this to the source coordinates.
    
    q - target coordinates.
  - applyInverse
```
public void applyInverse(RealPositionable p,
                         RealLocalizable q)
```
    Description copied from interface: InvertibleRealTransform
    
    Apply the inverse transform to a target RealLocalizable to obtain a source RealPositionable.
    
    Specified by:
    
    applyInverse in interface InvertibleRealTransform
    
    Parameters:
    
    p - set this to the source coordinates.
    
    q - target coordinates.
  - copy
```
public InvertibleTransformByGradientDescent 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 InvertibleRealTransform
    
    Specified by:
    
    copy in interface RealTransform
    
    Returns:
    
    deep copy
  - inverse
```
public InvertibleTransformByGradientDescent inverse()
```
    Description copied from interface: InvertibleRealTransform
    
    Get the inverse transform.
    
    Specified by:
    
    inverse in interface InvertibleRealTransform
    
    Returns:
    
    the inverse transform
  - 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.

Class InvertibleTransformByGradientDescent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.realtransform.InvertibleRealTransform

Methods inherited from interface net.imglib2.realtransform.RealTransform

Constructor Detail

InvertibleTransformByGradientDescent

InvertibleTransformByGradientDescent

InvertibleTransformByGradientDescent

Method Detail

apply

apply

applyInverse

applyInverse

copy

inverse

numSourceDimensions

numTargetDimensions