CubicBSplineTransform (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.models.AbstractModel<CubicBSplineTransform>
- - bunwarpj.trakem2.transform.CubicBSplineTransform

All Implemented Interfaces:

Serializable, CoordinateTransform, Model<CubicBSplineTransform>
```
public class CubicBSplineTransform
extends AbstractModel<CubicBSplineTransform>
implements CoordinateTransform
```
Class to implement elastic transforms based on cubic B-splines.

Author:

Ignacio Arganda-Carreras (ignacio.arganda@gmail.com)

See Also:

Serialized Form

Field Summary
- Fields inherited from class mpicbg.models.AbstractModel
  cost, rnd

Constructor Summary

Constructors
Constructor and Description
`CubicBSplineTransform()` Empty constructor
`CubicBSplineTransform(int intervals, BSplineModel swx, BSplineModel swy, int width, int height)` Cubic B-spline transform constructor
`CubicBSplineTransform(int intervals, double[][] cx, double[][] cy, int width, int height)` Cubic B-spline transform constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[]`	`apply(double[] l)` Apply the `CoordinateTransform` to a location.
`void`	`applyInPlace(double[] l)` Apply the `CoordinateTransform` to a location.
`CubicBSplineTransform`	`copy()` Clone method
`<P extends PointMatch> void`	`fit(Collection<P> matches)` Fit the `Model` to a set of data points minimizing the global transfer error.
`int`	`getMinNumMatches()`
`void`	`init(String dataString)` Initialize cubic B-spline transform from the parameters of a string
`void`	`scale(double xScale, double yScale)`
`void`	`set(CubicBSplineTransform m)` Set the model to m
`void`	`set(int intervals, BSplineModel swx, BSplineModel swy, int width, int height)` Set cubic B-spline transform values
`void`	`set(int intervals, double[][] cx, double[][] cy, int width, int height)` Set cubic B-spline transform constructor
`void`	`set(Param p, int sourceWidth, int sourceHeight, int targetWidth, int targetHeight)`
`String`	`toDataString()` Save cubic B-spline transform information into String
`String`	`toString()`
`String`	`toXML(String indent)` Create an XML-export of the `CoordinateTransform` for use in TrakEM2.

Methods inherited from class mpicbg.models.AbstractModel
betterThan, filter, filter, filter, filterRansac, filterRansac, filterRansac, filterRansac, fit, fit, getCost, icp, localSmoothnessFilter, ransac, ransac, setCost, test, test

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CubicBSplineTransform
```
public CubicBSplineTransform()
```
    Empty constructor
  - CubicBSplineTransform
```
public CubicBSplineTransform(int intervals,
                             double[][] cx,
                             double[][] cy,
                             int width,
                             int height)
```
    Cubic B-spline transform constructor
    
    Parameters:
    
    intervals - intervals between B-spline coefficients
    
    cx - B-spline coefficients for transformation in the x axis
    
    cy - B-spline coefficients for transformation in the y axis
    
    width - width of the target image
    
    height - height of the target image
  - CubicBSplineTransform
```
public CubicBSplineTransform(int intervals,
                             BSplineModel swx,
                             BSplineModel swy,
                             int width,
                             int height)
```
    Cubic B-spline transform constructor
    
    Parameters:
    
    intervals - intervals between B-spline coefficients
    
    swx - B-spline model for transformation in the x axis
    
    swy - B-spline model for transformation in the y axis
    
    width - width of the target image
    
    height - height of the target image
- Method Detail
  - set
```
public void set(int intervals,
                BSplineModel swx,
                BSplineModel swy,
                int width,
                int height)
```
    Set cubic B-spline transform values
    
    Parameters:
    
    intervals - intervals between B-spline coefficients
    
    swx - B-spline model for transformation in the x axis
    
    swy - B-spline model for transformation in the y axis
    
    width - width of the target image
    
    height - height of the target image
  - set
```
public void set(int intervals,
                double[][] cx,
                double[][] cy,
                int width,
                int height)
```
    Set cubic B-spline transform constructor
    
    Parameters:
    
    intervals - intervals between B-spline coefficients
    
    cx - B-spline coefficients for transformation in the x axis
    
    cy - B-spline coefficients for transformation in the y axis
    
    width - width of the target image
    
    height - height of the target image
  - apply
```
public double[] apply(double[] l)
```
    Description copied from interface: CoordinateTransform
    
    Apply the CoordinateTransform to a location.
    
    Specified by:
    
    apply in interface CoordinateTransform
    
    Returns:
    
    transformed location
  - applyInPlace
```
public void applyInPlace(double[] l)
```
    Description copied from interface: CoordinateTransform
    
    Apply the CoordinateTransform to a location.
    
    Specified by:
    
    applyInPlace in interface CoordinateTransform
  - init
```
public void init(String dataString)
          throws NumberFormatException
```
    Initialize cubic B-spline transform from the parameters of a string
    
    Parameters:
    
    dataString - basic cubic B-spline transform parameters
    
    Throws:
    
    NumberFormatException
  - toDataString
```
public String toDataString()
```
    Save cubic B-spline transform information into String
    
    Returns:
  - toXML
```
public final String toXML(String indent)
```
    Description copied from interface: CoordinateTransform
    
    Create an XML-export of the CoordinateTransform for use in TrakEM2.
    
    Returns:
    
    TrakEM2-readable XML
  - copy
```
public final CubicBSplineTransform copy()
```
    Clone method
    
    Specified by:
    
    copy in interface Model<CubicBSplineTransform>
  - fit
```
public <P extends PointMatch> void fit(Collection<P> matches)
                                throws NotEnoughDataPointsException,
                                       IllDefinedDataPointsException
```
    Description copied from interface: Model
    
    Fit the Model to a set of data points minimizing the global transfer error. This is assumed to be implemented as a weighted least squares minimization. Use ransac and/ or Model.filter(java.util.Collection<P>, java.util.Collection<P>, double, int) to remove outliers from your data points.
    The estimated model transfers match.p1.local to match.p2.world.
    
    Specified by:
    
    fit in interface Model<CubicBSplineTransform>
    
    Parameters:
    
    matches - set of point correpondences
    
    Throws:
    
    NotEnoughDataPointsException - if matches does not contain enough data points
    
    IllDefinedDataPointsException - if the set of data points is inappropriate to solve the Model
  - scale
```
public void scale(double xScale,
                  double yScale)
```
  - set
```
public void set(Param p,
                int sourceWidth,
                int sourceHeight,
                int targetWidth,
                int targetHeight)
```
  - getMinNumMatches
```
public int getMinNumMatches()
```
    Specified by:
    
    getMinNumMatches in interface Model<CubicBSplineTransform>
    
    Returns:
    
    the minimal number of PointMatches required to solve the model.
  - set
```
public void set(CubicBSplineTransform m)
```
    Description copied from interface: Model
    
    Set the model to m
    
    Specified by:
    
    set in interface Model<CubicBSplineTransform>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CubicBSplineTransform

Field Summary

Fields inherited from class mpicbg.models.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class mpicbg.models.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CubicBSplineTransform

CubicBSplineTransform

CubicBSplineTransform

Method Detail

set

set

apply

applyInPlace

init

toDataString

toXML

copy

fit

scale

set

getMinNumMatches

set

toString