AbstractScale (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

EuclideanSpace, AffineGet, InvertibleRealTransform, RealTransform, ScaleAndTranslationGet, ScaleGet

Direct Known Subclasses:

Scale, Scale2D, Scale3D
```
public abstract class AbstractScale
extends Object
implements ScaleGet
```
n-d arbitrary scaling. Abstract base implementation.

Author:

Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected RealPoint[] ds

protected double[] s

Fields
Modifier and Type	Field and Description
`protected RealPoint[]`	`ds`
`protected double[]`	`s`

Constructor Summary

Constructors
Modifier Constructor and Description

AbstractScale(double... s)

protected AbstractScale(double[] s, RealPoint[] ds)

Constructors
Modifier	Constructor and Description
	`AbstractScale(double... s)`
`protected`	`AbstractScale(double[] s, RealPoint[] ds)`

Method Summary

All Methods Instance Methods Abstract 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`.
`abstract AbstractScale`	`copy()` Create a deep copy of this `RealTransform`.
`RealLocalizable`	`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.
`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.
`abstract AbstractScale`	`inverse()` Get the inverse transform.
`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.
`abstract void`	`set(double... s)` Set the scale vector.

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
  - s
```
protected final double[] s
```
  - ds
```
protected final RealPoint[] ds
```
- Constructor Detail
  - AbstractScale
```
protected AbstractScale(double[] s,
                        RealPoint[] ds)
```
  - AbstractScale
```
public AbstractScale(double... s)
```
- Method Detail
  - set
```
public abstract void set(double... s)
```
    Set the scale vector.
    
    Parameters:
    
    s - s.length <= the number of dimensions of this AbstractScale
  - 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 abstract AbstractScale 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
    
    Specified by:
    
    inverse in interface ScaleGet
    
    Returns:
    
    the inverse transform
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - 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()
  - 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 RealLocalizable 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
  - copy
```
public abstract AbstractScale 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
    
    Specified by:
    
    copy in interface ScaleGet
    
    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
  - 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

Class AbstractScale

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.realtransform.RealTransform

Field Detail

s

ds

Constructor Detail

AbstractScale

AbstractScale

Method Detail

set

applyInverse

applyInverse

applyInverse

inverse

numDimensions

numSourceDimensions

numTargetDimensions

apply

apply

apply

get

getRowPackedCopy

d

copy

getScale

getScaleCopy

getTranslation

getTranslationCopy