Scale3D (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Concatenable<ScaleGet>, PreConcatenable<ScaleGet>, EuclideanSpace, AffineGet, InvertibleRealTransform, RealTransform, ScaleAndTranslationGet, ScaleGet
```
public class Scale3D
extends AbstractScale
implements Concatenable<ScaleGet>, PreConcatenable<ScaleGet>
```
3-d arbitrary scaling.

Author:

Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected Scale3D inverse
- Fields inherited from class net.imglib2.realtransform.AbstractScale
  ds, s

Fields
Modifier and Type	Field and Description
`protected Scale3D`	`inverse`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Scale3D(double... s)`
`protected`	`Scale3D(double[] s, Scale3D inverse, RealPoint[] ds)`
	`Scale3D(double sx, double sy, double sz)`

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`.
`Scale3D`	`concatenate(ScaleGet a)` Concatenate this object with a.
`Scale3D`	`copy()` Create a deep copy of this `RealTransform`.
`double`	`get(int row, int column)` Get a field of the n×(n+1) affine transformation matrix.
`Class<ScaleGet>`	`getConcatenableClass()`
`Class<ScaleGet>`	`getPreConcatenableClass()`
`double[]`	`getRowPackedCopy()` Get a copy of the n×(n+1) affine transformation matrix as a row packed array similar to Jama.
`Scale3D`	`inverse()` Get the inverse transform.
`boolean`	`isIdentity()` Check if the `RealTransform` is identity.
`Scale3D`	`preConcatenate(ScaleGet a)` Pre-concatenate this object with a.
`void`	`set(double... s)` Set the scale vector.
`void`	`set(double sx, double sy, double sz)`

Methods inherited from class net.imglib2.realtransform.AbstractScale
d, getScale, getScaleCopy, getTranslation, getTranslationCopy, numDimensions, numSourceDimensions, numTargetDimensions

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

- Field Detail
  - inverse
```
protected final Scale3D inverse
```
- Constructor Detail
  - Scale3D
```
protected Scale3D(double[] s,
                  Scale3D inverse,
                  RealPoint[] ds)
```
  - Scale3D
```
public Scale3D(double sx,
               double sy,
               double sz)
```
  - Scale3D
```
public Scale3D(double... s)
```
- Method Detail
  - set
```
public void set(double sx,
                double sy,
                double sz)
```
  - set
```
public void set(double... s)
```
    Description copied from class: AbstractScale
    
    Set the scale vector.
    
    Specified by:
    
    set in class AbstractScale
    
    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
    
    Overrides:
    
    applyInverse in class AbstractScale
    
    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
    
    Overrides:
    
    applyInverse in class AbstractScale
    
    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
    
    Overrides:
    
    applyInverse in class AbstractScale
    
    Parameters:
    
    source - set this to the source coordinates.
    
    target - target coordinates.
  - 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
    
    Overrides:
    
    apply in class AbstractScale
    
    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
    
    Overrides:
    
    apply in class AbstractScale
    
    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
    
    Overrides:
    
    apply in class AbstractScale
    
    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
    
    Overrides:
    
    get in class AbstractScale
    
    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
    
    Overrides:
    
    getRowPackedCopy in class AbstractScale
    
    Returns:
    
    the array of values
  - inverse
```
public Scale3D 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
    
    Specified by:
    
    inverse in class AbstractScale
    
    Returns:
    
    the inverse transform
  - copy
```
public Scale3D 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
    
    Specified by:
    
    copy in class AbstractScale
    
    Returns:
    
    deep copy
  - preConcatenate
```
public Scale3D preConcatenate(ScaleGet 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<ScaleGet>
  - getPreConcatenableClass
```
public Class<ScaleGet> getPreConcatenableClass()
```
    Specified by:
    
    getPreConcatenableClass in interface PreConcatenable<ScaleGet>
  - concatenate
```
public Scale3D concatenate(ScaleGet 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<ScaleGet>
  - getConcatenableClass
```
public Class<ScaleGet> getConcatenableClass()
```
    Specified by:
    
    getConcatenableClass in interface Concatenable<ScaleGet>
  - 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 Scale3D

Field Summary

Fields inherited from class net.imglib2.realtransform.AbstractScale

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.realtransform.AbstractScale

Methods inherited from class java.lang.Object

Field Detail

inverse

Constructor Detail

Scale3D

Scale3D

Scale3D

Method Detail

set

set

applyInverse

applyInverse

applyInverse

apply

apply

apply

get

getRowPackedCopy

inverse

copy

preConcatenate

getPreConcatenableClass

concatenate

getConcatenableClass

isIdentity