RegularizedDifferentiableRealTransform (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.realtransform.inverse.AbstractDifferentiableRealTransform
- - net.imglib2.realtransform.inverse.RegularizedDifferentiableRealTransform

All Implemented Interfaces:

DifferentiableRealTransform, RealTransform
```
public class RegularizedDifferentiableRealTransform
extends AbstractDifferentiableRealTransform
```
Wraps and regularizes a DifferentiableRealTransform.
Returns a convex combination of the identity matrix and the jacobian of the wrapped DifferentiableReal Transform. Specifically: epsilon * I + ( 1 - * epsilon ) * J

Author:

John Bogovic <bogovicj@janelia.hhmi.org>

Field Summary

Fields
Modifier and Type Field and Description

protected DifferentiableRealTransform dxfm

protected double epsilon

Fields
Modifier and Type	Field and Description
`protected DifferentiableRealTransform`	`dxfm`
`protected double`	`epsilon`

Constructor Summary

Constructors
Constructor and Description

RegularizedDifferentiableRealTransform(DifferentiableRealTransform dxfm, double epsilon)

Constructors
Constructor and Description
`RegularizedDifferentiableRealTransform(DifferentiableRealTransform dxfm, double epsilon)`

Method Summary

All Methods Instance Methods Concrete Methods
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(RealLocalizable source, RealPositionable target)` Apply the `RealTransform` to a source `RealLocalizable` to obtain a target `RealPositionable`.
`DifferentiableRealTransform`	`copy()` Create a deep copy of this `RealTransform`.
`AffineTransform`	`jacobian(double[] x)` Returns the jacobian matrix of this transform at the point x.
`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 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, isIdentity

- Field Detail
  - dxfm
```
protected final DifferentiableRealTransform dxfm
```
  - epsilon
```
protected final double epsilon
```
- Constructor Detail
  - RegularizedDifferentiableRealTransform
```
public RegularizedDifferentiableRealTransform(DifferentiableRealTransform dxfm,
                                              double epsilon)
```
- Method Detail
  - jacobian
```
public AffineTransform jacobian(double[] x)
```
    Returns the jacobian matrix of this transform at the point x.
    
    Specified by:
    
    jacobian in interface DifferentiableRealTransform
    
    Specified by:
    
    jacobian in class AbstractDifferentiableRealTransform
    
    Parameters:
    
    x - the point
    
    Returns:
    
    the jacobian
  - 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(RealLocalizable source,
                  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 DifferentiableRealTransform 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

Class RegularizedDifferentiableRealTransform

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.realtransform.RealTransform

Field Detail

dxfm

epsilon

Constructor Detail

RegularizedDifferentiableRealTransform

Method Detail

jacobian

numSourceDimensions

numTargetDimensions

apply

apply

copy