AbstractOutOfBoundsValue (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.outofbounds.AbstractOutOfBoundsValue<T>

Type Parameters:

T -

All Implemented Interfaces:

EuclideanSpace, Localizable, Bounded, OutOfBounds<T>, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>

Direct Known Subclasses:

OutOfBoundsConstantValue, OutOfBoundsRandomValue
```
public abstract class AbstractOutOfBoundsValue<T>
extends AbstractLocalizable
implements OutOfBounds<T>
```
Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch, Philipp Hanslovsky

Field Summary

Fields
Modifier and Type	Field and Description
`protected long[]`	`dimension`
`protected boolean[]`	`dimIsOutOfBounds`
`protected boolean`	`isOutOfBounds`
`protected long[]`	`max`
`protected long[]`	`min`
`protected RandomAccess<T>`	`sampler`

Fields inherited from class net.imglib2.AbstractLocalizable
position

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractOutOfBoundsValue(AbstractOutOfBoundsValue<T> outOfBounds)

AbstractOutOfBoundsValue(F f)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractOutOfBoundsValue(AbstractOutOfBoundsValue<T> outOfBounds)`
	`AbstractOutOfBoundsValue(F f)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int dim)` Move by -1 in one dimension.
`void`	`fwd(int dim)` Move by 1 in one dimension.
`boolean`	`isOutOfBounds()` True if located out of image bounds.
`void`	`move(int[] distance)` Move the element relative to its current location using an int[] as distance vector.
`void`	`move(int distance, int dim)` Move the element in one dimension for some distance.
`void`	`move(Localizable localizable)` Move the element relative to its current location using an `Localizable` as distance vector.
`void`	`move(long[] distance)` Move the element relative to its current location using a long[] as distance vector.
`void`	`move(long distance, int dim)` Move the element in one dimension for some distance.
`void`	`setPosition(int[] position)` Set the position of the element.
`void`	`setPosition(int position, int dim)` Set the position of the element for one dimension.
`void`	`setPosition(Localizable localizable)` Place the element at the same location as a given `Localizable`
`void`	`setPosition(long[] position)` Set the position of the element.
`void`	`setPosition(long position, int dim)` Set the position of the element for one dimension.

Methods inherited from class net.imglib2.AbstractLocalizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

Methods inherited from interface net.imglib2.outofbounds.OutOfBounds
copy

Methods inherited from interface net.imglib2.RandomAccess
copyRandomAccess, setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.Localizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, positionAsLongArray, positionAsPoint

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Sampler
get

- Field Detail
  - sampler
```
protected final RandomAccess<T> sampler
```
  - dimension
```
protected final long[] dimension
```
  - min
```
protected final long[] min
```
  - max
```
protected final long[] max
```
  - dimIsOutOfBounds
```
protected final boolean[] dimIsOutOfBounds
```
  - isOutOfBounds
```
protected boolean isOutOfBounds
```
- Constructor Detail
  - AbstractOutOfBoundsValue
```
protected AbstractOutOfBoundsValue(AbstractOutOfBoundsValue<T> outOfBounds)
```
  - AbstractOutOfBoundsValue
```
public AbstractOutOfBoundsValue(F f)
```
- Method Detail
  - isOutOfBounds
```
public boolean isOutOfBounds()
```
    Description copied from interface: Bounded
    
    True if located out of image bounds.
    
    Specified by:
    
    isOutOfBounds in interface Bounded
  - fwd
```
public void fwd(int dim)
```
    Description copied from interface: Positionable
    
    Move by 1 in one dimension.
    
    Specified by:
    
    fwd in interface Positionable
    
    Parameters:
    
    dim - dimension
  - bck
```
public void bck(int dim)
```
    Description copied from interface: Positionable
    
    Move by -1 in one dimension.
    
    Specified by:
    
    bck in interface Positionable
    
    Parameters:
    
    dim - dimension
  - move
```
public void move(long distance,
                 int dim)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    dim - dimension
  - move
```
public void move(int distance,
                 int dim)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    dim - dimension
  - move
```
public void move(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an Localizable as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(int[] distance)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an int[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(long[] distance)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using a long[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(long position,
                        int dim)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    dim - dimension
  - setPosition
```
public void setPosition(int position,
                        int dim)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    dim - dimension
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Place the element at the same location as a given Localizable
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(int[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(long[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

Class AbstractOutOfBoundsValue<T>

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizable

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizable

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.outofbounds.OutOfBounds

Methods inherited from interface net.imglib2.RandomAccess

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Sampler

Field Detail

sampler

dimension

min

max

dimIsOutOfBounds

isOutOfBounds

Constructor Detail

AbstractOutOfBoundsValue

AbstractOutOfBoundsValue

Method Detail

isOutOfBounds

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition