ScaleAndTranslation (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Concatenable<ScaleAndTranslationGet>, PreConcatenable<ScaleAndTranslationGet>, EuclideanSpace, AffineGet, InvertibleRealTransform, RealTransform, ScaleAndTranslationGet
```
public class ScaleAndTranslation
extends Object
implements ScaleAndTranslationGet, Concatenable<ScaleAndTranslationGet>, PreConcatenable<ScaleAndTranslationGet>
```
An n transform that applies a scaling first and then shifts coordinates. This transform is faster than using an AffineTransform with entries on the diagonal only.

Author:

Philipp Hanslovsky, Stephan Saalfeld

Constructor Summary

Constructors
Constructor and Description

ScaleAndTranslation(double[] scales, double[] translations)

Constructors
Constructor and Description
`ScaleAndTranslation(double[] scales, double[] translations)`

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(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`.
`void`	`applyInverse(double[] source, double[] target)` Apply the inverse transform to a target vector to obtain a source vector.
`void`	`applyInverse(float[] source, float[] target)` Apply the inverse transform to a target vector to obtain a source vector.
`void`	`applyInverse(RealPositionable source, RealLocalizable target)` Apply the inverse transform to a target `RealLocalizable` to obtain a source `RealPositionable`.
`ScaleAndTranslation`	`concatenate(ScaleAndTranslationGet a)` Concatenate this object with a.
`ScaleAndTranslation`	`copy()` Create a deep copy of this `RealTransform`.
`ScaleAndTranslation`	`createInverse()`
`RealPoint`	`d(int d)` Get the constant partial differential vector for dimension d.
`double`	`get(int row, int column)` Get a field of the n×(n+1) affine transformation matrix.
`Class<ScaleAndTranslationGet>`	`getConcatenableClass()`
`Class<ScaleAndTranslationGet>`	`getPreConcatenableClass()`
`double[]`	`getRowPackedCopy()` Get a copy of the n×(n+1) affine transformation matrix as a row packed array similar to Jama.
`double`	`getScale(int d)` Get a field of the n-dimensional scale vector.
`double[]`	`getScaleCopy()` Get a copy of the n-dimensional scale vector.
`double`	`getTranslation(int d)` Get a field of the n-dimensionsional translation vector.
`double[]`	`getTranslationCopy()` Get a copy of the n-dimensionsional translation vector.
`ScaleAndTranslation`	`inverse()` Get the inverse transform.
`boolean`	`isIdentity()` Check if the `RealTransform` is identity.
`int`	`numDimensions()` Gets the space's number of dimensions.
`int`	`numSourceDimensions()` Returns n, the minimal number of dimension of the source vector.
`int`	`numTargetDimensions()` Returns m, the minimal dimension of the target vector.
`ScaleAndTranslation`	`preConcatenate(ScaleAndTranslationGet a)` Pre-concatenate this object with a.

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

- Constructor Detail
  - ScaleAndTranslation
```
public ScaleAndTranslation(double[] scales,
                           double[] translations)
```
    Parameters:
    
    scales - Array containing scales
    
    translations - Array containing translations
- Method Detail
  - 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()
  - applyInverse
```
public void applyInverse(double[] source,
                         double[] target)
```
    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:
    
    source - set this to the source coordinates.
    
    target - target coordinates.
  - applyInverse
```
public void applyInverse(float[] source,
                         float[] target)
```
    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:
    
    source - set this to the source coordinates.
    
    target - target coordinates.
  - applyInverse
```
public void applyInverse(RealPositionable source,
                         RealLocalizable target)
```
    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:
    
    source - set this to the source coordinates.
    
    target - target coordinates.
  - inverse
```
public ScaleAndTranslation inverse()
```
    Description copied from interface: InvertibleRealTransform
    
    Get the inverse transform.
    
    Specified by:
    
    inverse in interface AffineGet
    
    Specified by:
    
    inverse in interface InvertibleRealTransform
    
    Specified by:
    
    inverse in interface ScaleAndTranslationGet
    
    Returns:
    
    the inverse transform
  - createInverse
```
public ScaleAndTranslation createInverse()
```
  - copy
```
public ScaleAndTranslation 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 AffineGet
    
    Specified by:
    
    copy in interface InvertibleRealTransform
    
    Specified by:
    
    copy in interface RealTransform
    
    Specified by:
    
    copy in interface ScaleAndTranslationGet
    
    Returns:
    
    deep copy
  - getScale
```
public double getScale(int d)
```
    Description copied from interface: ScaleAndTranslationGet
    
    Get a field of the n-dimensional scale vector.
    
    Specified by:
    
    getScale in interface ScaleAndTranslationGet
    
    Parameters:
    
    d - the dimension
    
    Returns:
    
    element of the scale
  - getScaleCopy
```
public double[] getScaleCopy()
```
    Description copied from interface: ScaleAndTranslationGet
    
    Get a copy of the n-dimensional scale vector.
    
    Specified by:
    
    getScaleCopy in interface ScaleAndTranslationGet
    
    Returns:
    
    copy of the scale vector
  - get
```
public double get(int row,
                  int column)
```
    Description copied from interface: AffineGet
    
    Get a field of the n×(n+1) affine transformation matrix.
    
    Specified by:
    
    get in interface AffineGet
    
    Parameters:
    
    row - the row index
    
    column - the column index
    
    Returns:
    
    the value
  - getRowPackedCopy
```
public double[] getRowPackedCopy()
```
    Description copied from interface: AffineGet
    
    Get a copy of the n×(n+1) affine transformation matrix as a row packed array similar to Jama.
    
    Specified by:
    
    getRowPackedCopy in interface AffineGet
    
    Returns:
    
    the array of values
  - d
```
public RealPoint d(int d)
```
    Description copied from interface: AffineGet
    
    Get the constant partial differential vector for dimension d.
    
    Specified by:
    
    d in interface AffineGet
    
    Parameters:
    
    d - the dimension
    
    Returns:
    
    the partial differential vector
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - getTranslation
```
public double getTranslation(int d)
```
    Description copied from interface: ScaleAndTranslationGet
    
    Get a field of the n-dimensionsional translation vector.
    
    Specified by:
    
    getTranslation in interface ScaleAndTranslationGet
    
    Parameters:
    
    d - the dimension
    
    Returns:
    
    element of the translation
  - getTranslationCopy
```
public double[] getTranslationCopy()
```
    Description copied from interface: ScaleAndTranslationGet
    
    Get a copy of the n-dimensionsional translation vector.
    
    Specified by:
    
    getTranslationCopy in interface ScaleAndTranslationGet
    
    Returns:
    
    copy of the translation vector
  - preConcatenate
```
public ScaleAndTranslation preConcatenate(ScaleAndTranslationGet a)
```
    Description copied from interface: PreConcatenable
    
    Pre-concatenate this object with a. The result will be an object that can be pre-concatenated with another A. The conventional meaning for concatenating transformations is the following: Let ba = a.preConcatenate(b). Applying ba to x is equivalent to first applying a to x and then applying b to the result.
    
    Specified by:
    
    preConcatenate in interface PreConcatenable<ScaleAndTranslationGet>
  - getPreConcatenableClass
```
public Class<ScaleAndTranslationGet> getPreConcatenableClass()
```
    Specified by:
    
    getPreConcatenableClass in interface PreConcatenable<ScaleAndTranslationGet>
  - concatenate
```
public ScaleAndTranslation concatenate(ScaleAndTranslationGet a)
```
    Description copied from interface: Concatenable
    
    Concatenate this object with a. The result will be an object that can be concatenated with another A. The conventional meaning for concatenating transformations is the following: Let ba = b.concatenate(a). Applying ba to x is equivalent to first applying a to x and then applying b to the result.
    
    Specified by:
    
    concatenate in interface Concatenable<ScaleAndTranslationGet>
  - getConcatenableClass
```
public Class<ScaleAndTranslationGet> getConcatenableClass()
```
    Specified by:
    
    getConcatenableClass in interface Concatenable<ScaleAndTranslationGet>
  - isIdentity
```
public boolean isIdentity()
```
    Description copied from interface: RealTransform
    
    Check if the RealTransform is identity.
    
    Specified by:
    
    isIdentity in interface RealTransform
    
    Returns:
    
    true if identity

Class ScaleAndTranslation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScaleAndTranslation

Method Detail

numSourceDimensions

numTargetDimensions

apply

apply

apply

applyInverse

applyInverse

applyInverse

inverse

createInverse

copy

getScale

getScaleCopy

get

getRowPackedCopy

d

numDimensions

getTranslation

getTranslationCopy

preConcatenate

getPreConcatenableClass

concatenate

getConcatenableClass

isIdentity