AbstractImg (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.img.AbstractImg<T>

All Implemented Interfaces:

Iterable<T>, Dimensions, EuclideanSpace, Img<T>, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval

Direct Known Subclasses:

AbstractListImg, AbstractLongListImg, AbstractNativeImg, AbstractNativeLongAccessImg
```
public abstract class AbstractImg<T>
extends Object
implements Img<T>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected long[] dimension

protected long[] max

protected int n

protected long numPixels

Fields
Modifier and Type	Field and Description
`protected long[]`	`dimension`
`protected long[]`	`max`
`protected int`	`n`
`protected long`	`numPixels`

Constructor Summary

Constructors
Constructor and Description

AbstractImg(long[] size)

Constructors
Constructor and Description
`AbstractImg(long[] size)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`dimension(int d)` Default implementation of `Dimensions.dimension(int)`.
`void`	`dimensions(long[] s)` Write the number of pixels in each dimension into long[].
`T`	`firstElement()` Get the first element of this `IterableRealInterval`.
`Iterator<T>`	`iterator()`
`long`	`max(int d)` Get the maximum in dimension d.
`void`	`max(long[] m)` Write the maximum of each dimension into long[].
`void`	`max(Positionable m)` Sets a `Positionable` to the maximum of this `Interval`
`long`	`min(int d)` Get the minimum in dimension d.
`void`	`min(long[] m)` Write the minimum of each dimension into long[].
`void`	`min(Positionable m)` Sets a `Positionable` to the minimum of this `Interval`
`int`	`numDimensions()` Gets the space's number of dimensions.
`static long`	`numElements(long[] dim)`
`RandomAccess<T>`	`randomAccess(Interval interval)` Create a random access sampler for integer coordinates.
`void`	`realMax(double[] m)` Write the maximum of each dimension into double[].
`double`	`realMax(int d)` Default implementation of `RealInterval.realMax(int)`.
`void`	`realMax(RealPositionable m)` Sets a `RealPositionable` to the maximum of this `Interval`
`void`	`realMin(double[] m)` Write the minimum of each dimension into double[].
`double`	`realMin(int d)` Default implementation of `RealInterval.realMin(int)`.
`void`	`realMin(RealPositionable m)` Sets a `RealPositionable` to the minimum of this `Interval`
`long`	`size()` Returns the number of elements in this `Function`.
`String`	`toString()`

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

Methods inherited from interface net.imglib2.img.Img
copy, factory

Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt, randomAccess

Methods inherited from interface net.imglib2.IterableInterval
cursor, localizingCursor

Methods inherited from interface net.imglib2.IterableRealInterval
iterationOrder

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface net.imglib2.Interval
maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Methods inherited from interface net.imglib2.Dimensions
allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

- Field Detail
  - n
```
protected final int n
```
  - numPixels
```
protected long numPixels
```
  - dimension
```
protected final long[] dimension
```
  - max
```
protected final long[] max
```
- Constructor Detail
  - AbstractImg
```
public AbstractImg(long[] size)
```
- Method Detail
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - firstElement
```
public T firstElement()
```
    Description copied from interface: IterableRealInterval
    
    Get the first element of this IterableRealInterval. This is a shortcut for cursor().next(). This can be used to create a new variable of type T using firstElement().createVariable(), which is useful in generic methods to store temporary results, e.g., a running sum over pixels in the IterableRealInterval.
    
    Specified by:
    
    firstElement in interface IterableRealInterval<T>
    
    Returns:
    
    the first element in iteration order.
  - numElements
```
public static long numElements(long[] dim)
```
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - dimensions
```
public void dimensions(long[] s)
```
    Description copied from interface: Dimensions
    
    Write the number of pixels in each dimension into long[].
    
    Specified by:
    
    dimensions in interface Dimensions
  - dimension
```
public long dimension(int d)
```
    Description copied from interface: Interval
    
    Default implementation of Dimensions.dimension(int).
    
    Specified by:
    
    dimension in interface Dimensions
    
    Specified by:
    
    dimension in interface Interval
  - size
```
public long size()
```
    Description copied from interface: IterableRealInterval
    
    Returns the number of elements in this Function.
    
    Specified by:
    
    size in interface IterableRealInterval<T>
    
    Returns:
    
    number of elements
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - realMax
```
public double realMax(int d)
```
    Description copied from interface: Interval
    
    Default implementation of RealInterval.realMax(int).
    
    Specified by:
    
    realMax in interface Interval
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - realMax
```
public void realMax(double[] m)
```
    Description copied from interface: RealInterval
    
    Write the maximum of each dimension into double[].
    
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(RealPositionable m)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the maximum of this Interval
    
    Specified by:
    
    realMax in interface RealInterval
  - realMin
```
public double realMin(int d)
```
    Description copied from interface: Interval
    
    Default implementation of RealInterval.realMin(int).
    
    Specified by:
    
    realMin in interface Interval
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMin
```
public void realMin(double[] m)
```
    Description copied from interface: RealInterval
    
    Write the minimum of each dimension into double[].
    
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(RealPositionable m)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the minimum of this Interval
    
    Specified by:
    
    realMin in interface RealInterval
  - max
```
public long max(int d)
```
    Description copied from interface: Interval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    max in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - max
```
public void max(long[] m)
```
    Description copied from interface: Interval
    
    Write the maximum of each dimension into long[].
    
    Specified by:
    
    max in interface Interval
  - max
```
public void max(Positionable m)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the maximum of this Interval
    
    Specified by:
    
    max in interface Interval
  - min
```
public void min(long[] m)
```
    Description copied from interface: Interval
    
    Write the minimum of each dimension into long[].
    
    Specified by:
    
    min in interface Interval
  - min
```
public long min(int d)
```
    Description copied from interface: Interval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    min in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - min
```
public void min(Positionable m)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the minimum of this Interval
    
    Specified by:
    
    min in interface Interval
  - randomAccess
```
public RandomAccess<T> randomAccess(Interval interval)
```
    Description copied from interface: RandomAccessible
    
    Create a random access sampler for integer coordinates.
    The returned random access is intended to be used in the specified interval only. Thus, the RandomAccessible may provide optimized versions. If the interval is completely contained in the domain, the random access is guaranteed to provide the same values as that obtained by RandomAccessible.randomAccess() within the interval.
    
    Specified by:
    
    randomAccess in interface RandomAccessible<T>
    
    Parameters:
    
    interval - in which interval you intend to use the random access.
    
    Returns:
    
    random access sampler

Class AbstractImg<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.img.Img

Methods inherited from interface net.imglib2.RandomAccessible

Methods inherited from interface net.imglib2.IterableInterval

Methods inherited from interface net.imglib2.IterableRealInterval

Methods inherited from interface java.lang.Iterable

Methods inherited from interface net.imglib2.Interval

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.Dimensions

Field Detail

n

numPixels

dimension

max

Constructor Detail

AbstractImg

Method Detail

iterator

firstElement

numElements

numDimensions

dimensions

dimension

size

toString

realMax

realMax

realMax

realMin

realMin

realMin

max

max

max

min

min

min

randomAccess