PolynomialTransform2D (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.realtransform.PolynomialTransform2D

All Implemented Interfaces:

RealTransform
```
public class PolynomialTransform2D
extends Object
implements RealTransform
```
A 2D polynomial transform of n-th order. Copied from https://github.com/axtimwalde/mpicbg/blob/master/mpicbg/src/main/java/mpicbg/models/PolynomialTransform2D.java

Author:

Stephan Saalfeld

Field Summary

Fields
Modifier and Type	Field and Description
`protected double[]`	`a` holds two coefficients for each polynomial coefficient, including 1 initialized at 0 order, i.e.
`protected int`	`order` order of the polynomial transform
`protected double[]`	`polTerms` register to hold all polynomial terms during applyInPlace following the order specified at http://bishopw.loni.ucla.edu/AIR5/2Dnonlinear.html#polylist excluding 1 because we want to avoid repeated multiplication with 1

Constructor Summary

Constructors
Constructor and Description

PolynomialTransform2D()

Constructors
Constructor and Description
`PolynomialTransform2D()`

Method Summary

All Methods Static 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(float[] source, float[] 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`.
`RealTransform`	`copy()` Create a deep copy of this `RealTransform`.
`static int`	`numPolTerms(int order)` Calculate the number of polynomial terms for a 2d polynomial transform of given order.
`int`	`numSourceDimensions()` Returns n, the minimal number of dimension of the source vector.
`int`	`numTargetDimensions()` Returns m, the minimal dimension of the target vector.
`static int`	`orderOf(int numPolTerms)` Calculate the maximum order of a polynom whose number of polyynomial terms is smaller or equal a given number.
`protected void`	`populateTerms(double x, double y)`
`protected void`	`printTerms()`
`void`	`set(double... a)` Set the coefficients.

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
  - order
```
protected int order
```
    order of the polynomial transform
  - a
```
protected double[] a
```
    holds two coefficients for each polynomial coefficient, including 1 initialized at 0 order, i.e. translation, the order follows that specified at http://bishopw.loni.ucla.edu/AIR5/2Dnonlinear.html#polylist two times
  - polTerms
```
protected double[] polTerms
```
    register to hold all polynomial terms during applyInPlace following the order specified at http://bishopw.loni.ucla.edu/AIR5/2Dnonlinear.html#polylist excluding 1 because we want to avoid repeated multiplication with 1
- Constructor Detail
  - PolynomialTransform2D
```
public PolynomialTransform2D()
```
- Method Detail
  - orderOf
```
public static final int orderOf(int numPolTerms)
```
    Calculate the maximum order of a polynom whose number of polyynomial terms is smaller or equal a given number.
    
    Parameters:
    
    numPolTerms - the number of terms
    
    Returns:
    
    result of the calculation
  - numPolTerms
```
public static final int numPolTerms(int order)
```
    Calculate the number of polynomial terms for a 2d polynomial transform of given order.
    
    Parameters:
    
    order - of the polynomial
    
    Returns:
    
    result of the calculation
  - set
```
public void set(double... a)
```
    Set the coefficients. The number of coefficients implicitly specifies the order of the PolynomialTransform2D which is set to the highest order that is fully specified by the provided coefficients. The coefficients are interpreted in the order specified at http://bishopw.loni.ucla.edu/AIR5/2Dnonlinear.html#polylist , first for x', then for y'. It is thus not possible to omit higher order coefficients assuming that they would become 0. The passed vararg array is used directly without copy which enables direct access to the coefficients from calling code. Use this option wisely.
    
    Parameters:
    
    a - coefficients
  - populateTerms
```
protected void populateTerms(double x,
                             double y)
```
  - printTerms
```
protected void printTerms()
```
  - 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.
  - 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.
    
    Specified by:
    
    apply in interface RealTransform
    
    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(float[] source,
                  float[] target)
```
    Description copied from interface: RealTransform
    
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Specified by:
    
    apply in interface RealTransform
    
    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.
    
    Specified by:
    
    apply in interface RealTransform
    
    Parameters:
    
    source - source coordinates, numDimensions() must be >= RealTransform.numSourceDimensions()
    
    target - set this to the target coordinates, numDimensions() must be >= RealTransform.numTargetDimensions()
  - 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

Class PolynomialTransform2D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.realtransform.RealTransform

Field Detail

order

a

polTerms

Constructor Detail

PolynomialTransform2D

Method Detail

orderOf

numPolTerms

set

populateTerms

printTerms

numSourceDimensions

numTargetDimensions

apply

apply

apply

copy