RealPointSampleList (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.RealPointSampleList<T>

All Implemented Interfaces:

Iterable<T>, EuclideanSpace, IterableRealInterval<T>, RealInterval
```
public class RealPointSampleList<T>
extends Object
implements IterableRealInterval<T>
```
A list of data samples at explicit real coordinates.

Author:

Stephan Saalfeld

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class RealPointSampleList.RealPointSampleListCursor

Nested Classes
Modifier and Type	Class and Description
`class`	`RealPointSampleList.RealPointSampleListCursor`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<RealPoint>`	`coordinates`
`protected int`	`lastIndex`
`protected double[]`	`max`
`protected double[]`	`min`
`protected int`	`n`
`protected ArrayList<T>`	`samples`

Constructor Summary

Constructors
Constructor and Description

RealPointSampleList(int n)

Constructors
Constructor and Description
`RealPointSampleList(int n)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(RealPoint position, T sample)`
`RealCursor<T>`	`cursor()` Returns a `RealCursor` that iterates with optimal speed without calculating the location at each iteration step.
`T`	`firstElement()` Get the first element of this `IterableRealInterval`.
`Object`	`iterationOrder()` Returns the iteration order of this `IterableRealInterval`.
`Iterator<T>`	`iterator()`
`RealCursor<T>`	`localizingCursor()` Returns a `RealLocalizable` `Iterator` that calculates its location at each iteration step.
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`realMax(double[] m)` Write the maximum of each dimension into double[].
`double`	`realMax(int d)` Get the maximum in dimension d.
`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)` Get the minimum in dimension d.
`void`	`realMin(RealPositionable m)` Sets a `RealPositionable` to the minimum of this `Interval`
`long`	`size()` Returns the number of elements in this `Function`.

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

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

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

- Field Detail
  - n
```
protected final int n
```
  - coordinates
```
protected final ArrayList<RealPoint> coordinates
```
  - samples
```
protected final ArrayList<T> samples
```
  - lastIndex
```
protected int lastIndex
```
  - min
```
protected final double[] min
```
  - max
```
protected final double[] max
```
- Constructor Detail
  - RealPointSampleList
```
public RealPointSampleList(int n)
```
    Parameters:
    
    n - - number of dimensions
- Method Detail
  - add
```
public void add(RealPoint position,
                T sample)
```
  - cursor
```
public RealCursor<T> cursor()
```
    Description copied from interface: IterableRealInterval
    
    Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.
    
    Use this where localization is required rarely/ not for each iteration.
    
    Specified by:
    
    cursor in interface IterableRealInterval<T>
    
    Returns:
    
    fast iterating iterator
  - iterationOrder
```
public Object iterationOrder()
```
    Description copied from interface: IterableRealInterval
    
    Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.
    
    Specified by:
    
    iterationOrder in interface IterableRealInterval<T>
    
    Returns:
    
    the iteration order of this IterableRealInterval.
    
    See Also:
    
    FlatIterationOrder
  - 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.
  - localizingCursor
```
public RealCursor<T> localizingCursor()
```
    Description copied from interface: IterableRealInterval
    
    Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.
    
    Use this where localization is required often/ for each iteration.
    
    Specified by:
    
    localizingCursor in interface IterableRealInterval<T>
    
    Returns:
    
    fast localizing iterator
  - 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
  - realMax
```
public double realMax(int d)
```
    Description copied from interface: RealInterval
    
    Get the maximum in dimension d.
    
    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: RealInterval
    
    Get the minimum in dimension d.
    
    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
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>

Class RealPointSampleList<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface java.lang.Iterable

Field Detail

n

coordinates

samples

lastIndex

min

max

Constructor Detail

RealPointSampleList

Method Detail

add

cursor

iterationOrder

firstElement

localizingCursor

size

realMax

realMax

realMax

realMin

realMin

realMin

numDimensions

iterator