RealTransform (ImgLib2 Javadocs 0-SNAPSHOT API)

All Known Subinterfaces:

AffineGet, DifferentiableRealTransform, InvertibleRealTransform, ScaleAndTranslationGet, ScaleGet, TranslationGet

All Known Implementing Classes:

AbstractAffineTransform, AbstractDifferentiableRealTransform, AbstractRealTransformSequence, AbstractScale, AbstractTranslation, AffineTransform, AffineTransform2D, AffineTransform3D, ClippedTransitionRealTransform, DeformationFieldTransform, ExplicitInvertibleRealTransform, HomographyTransform2D, InterpolatedRealTransform, InversePerspective3D, InverseRealTransform, InverseRealTransformGradientDescent, InvertibleDeformationFieldTransform, InvertibleRealTransformSequence, InvertibleTransformByGradientDescent, Perspective3D, PolarToCartesianTransform2D, PolynomialTransform2D, PositionFieldTransform, RealTransformFiniteDerivatives, RealTransformSequence, RegularizedDifferentiableRealTransform, Scale, Scale2D, Scale3D, ScaleAndTranslation, ScaledPolarToTranslatedCartesianTransform2D, SphericalToCartesianTransform3D, ThinplateSplineTransform, Translation, Translation2D, Translation3D, WrappedIterativeInvertibleRealTransform
```
public interface RealTransform
```
Transformation from Rⁿ to R^m.
Applying the transformation to an n-dimensional source vector yields an m-dimensional target vector.

Source and target vectors are required to be at least n- or m-dimensional respectively. The RealTransform is expected to leave all dimensions beyond n-1 in the source vector and m -1 in the target vector unchanged.

Implementations must support an in-place apply (i.e., passing the same object as both source and target).

Author:

Tobias Pietzsch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated 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.
`default void`	`apply(float[] source, float[] target)` Deprecated. use double precision instead
`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`.
`default boolean`	`isIdentity()` Check if the `RealTransform` is identity.
`int`	`numSourceDimensions()` Returns n, the minimal number of dimension of the source vector.
`int`	`numTargetDimensions()` Returns m, the minimal dimension of the target vector.

- Method Detail
  - numSourceDimensions
```
int numSourceDimensions()
```
    Returns n, the minimal number of dimension of the source vector.
    
    Returns:
    
    the dimension of the source vector.
  - numTargetDimensions
```
int numTargetDimensions()
```
    Returns m, the minimal dimension of the target vector.
    
    Returns:
    
    the dimension of the target vector.
  - apply
```
void apply(double[] source,
           double[] target)
```
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Parameters:
    
    source - source coordinates, length must be >= numSourceDimensions()
    
    target - set this to the target coordinates, length must be >= numTargetDimensions()
  - apply
```
@Deprecated
default void apply(float[] source,
                               float[] target)
```
    Deprecated. use double precision instead
    
    Apply the RealTransform to a source vector to obtain a target vector.
    
    Parameters:
    
    source - source coordinates, length must be >= numSourceDimensions()
    
    target - set this to the target coordinates, length must be >= numTargetDimensions()
  - apply
```
void apply(RealLocalizable source,
           RealPositionable target)
```
    Apply the RealTransform to a source RealLocalizable to obtain a target RealPositionable.
    
    Parameters:
    
    source - source coordinates, numDimensions() must be >= numSourceDimensions()
    
    target - set this to the target coordinates, numDimensions() must be >= numTargetDimensions()
  - copy
```
RealTransform copy()
```
    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
  - isIdentity
```
default boolean isIdentity()
```
    Check if the RealTransform is identity.
    
    Returns:
    
    true if identity

Interface RealTransform

Method Summary

Method Detail

numSourceDimensions

numTargetDimensions

apply

apply

apply

copy

isIdentity