FloorOffset (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.position.transform.AbstractPositionableTransform<LocalizablePositionable>
  - - net.imglib2.position.transform.FloorOffset<LocalizablePositionable>

All Implemented Interfaces:

EuclideanSpace, Positionable, RealLocalizable, RealPositionable

Direct Known Subclasses:

LanczosInterpolator
```
public class FloorOffset<LocalizablePositionable extends Localizable & Positionable>
extends AbstractPositionableTransform<LocalizablePositionable>
```
A RealPositionable that drives a Positionable to its floor discrete coordinates plus a discrete offset vector. For practical useage, the floor operation is defined as the integer smaller than the real value: f = r < 0 ? (long)r - 1 : (long)r

Author:

Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected long[] offset
- Fields inherited from class net.imglib2.position.transform.AbstractPositionableTransform
  discrete, position, target
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Fields
Modifier and Type	Field and Description
`protected long[]`	`offset`

Constructor Summary

Constructors
Constructor and Description
`FloorOffset(LocalizablePositionable target, Localizable offset)`
`FloorOffset(LocalizablePositionable target, long[] offset)`
`FloorOffset(RealLocalizable origin, LocalizablePositionable target, Localizable offset)`
`FloorOffset(RealLocalizable origin, LocalizablePositionable target, long[] offset)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`f(double[] r, long[] f)`
`protected static long`	`f(double r, long off)`
`protected void`	`f(float[] r, long[] f)`
`protected static long`	`f(float r, long off)`
`protected void`	`f(RealLocalizable r, long[] f)`
`void`	`move(double[] distance)` Move the element relative to its current location using a float[] as distance vector.
`void`	`move(double distance, int d)` Move the element in one dimension for some distance.
`void`	`move(float[] distance)` Move the element relative to its current location using a float[] as distance vector.
`void`	`move(float distance, int d)` Move the element in one dimension for some distance.
`void`	`move(RealLocalizable localizable)` Move the element relative to its current location using a `RealLocalizable` as distance vector.
`void`	`setPosition(double[] position)` Set the position of the element.
`void`	`setPosition(double position, int d)` Set the position of the element for one dimension.
`void`	`setPosition(float[] pos)` Set the position of the element.
`void`	`setPosition(float position, int d)` Set the position of the element for one dimension.
`void`	`setPosition(RealLocalizable localizable)` Place the element at the same location as a given `RealLocalizable`

Methods inherited from class net.imglib2.position.transform.AbstractPositionableTransform
bck, fwd, getDoublePosition, getFloatPosition, localize, localize, move, move, move, move, move, setPosition, setPosition, setPosition, setPosition, setPosition, toString

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

- Field Detail
  - offset
```
protected final long[] offset
```
- Constructor Detail
  - FloorOffset
```
public FloorOffset(LocalizablePositionable target,
                   long[] offset)
```
  - FloorOffset
```
public FloorOffset(LocalizablePositionable target,
                   Localizable offset)
```
  - FloorOffset
```
public FloorOffset(RealLocalizable origin,
                   LocalizablePositionable target,
                   long[] offset)
```
  - FloorOffset
```
public FloorOffset(RealLocalizable origin,
                   LocalizablePositionable target,
                   Localizable offset)
```
- Method Detail
  - f
```
protected static final long f(double r,
                              long off)
```
  - f
```
protected static final long f(float r,
                              long off)
```
  - f
```
protected void f(double[] r,
                 long[] f)
```
  - f
```
protected void f(float[] r,
                 long[] f)
```
  - f
```
protected void f(RealLocalizable r,
                 long[] f)
```
  - move
```
public void move(float distance,
                 int d)
```
    Description copied from interface: RealPositionable
    
    Move the element in one dimension for some distance.
  - move
```
public void move(double distance,
                 int d)
```
    Description copied from interface: RealPositionable
    
    Move the element in one dimension for some distance.
  - move
```
public void move(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a RealLocalizable as distance vector.
    
    Parameters:
    
    localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(float[] distance)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a float[] as distance vector.
  - move
```
public void move(double[] distance)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a float[] as distance vector.
  - setPosition
```
public void setPosition(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Place the element at the same location as a given RealLocalizable
    
    Parameters:
    
    localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(float[] pos)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element.
    
    Parameters:
    
    pos - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(double[] position)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element.
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(float position,
                        int d)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.
  - setPosition
```
public void setPosition(double position,
                        int d)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.

Class FloorOffset<LocalizablePositionable extends Localizable & Positionable>

Field Summary

Fields inherited from class net.imglib2.position.transform.AbstractPositionableTransform

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.position.transform.AbstractPositionableTransform

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

offset

Constructor Detail

FloorOffset

FloorOffset

FloorOffset

FloorOffset

Method Detail

f

f

f

f

f

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition