PredicateCursor (Fiji Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class PredicateCursor<T extends Type<T>>
extends Object
implements Cursor<T>
```
The PredicateCursor traverses a whole image but only returns those pixels for which the Predicate returns true. There is little sense to make this less than a LocalizableCursor

Field Summary

Fields
Modifier and Type Field and Description

protected Cursor<T> cursor

protected boolean hasNext

protected boolean lookedForNext

protected Predicate<T> predicate

Fields
Modifier and Type	Field and Description
`protected Cursor<T>`	`cursor`
`protected boolean`	`hasNext`
`protected boolean`	`lookedForNext`
`protected Predicate<T>`	`predicate`

Constructor Summary

Constructors
Constructor and Description

PredicateCursor(Cursor<T> cursor, Predicate<T> predicate)

Constructors
Constructor and Description
`PredicateCursor(Cursor<T> cursor, Predicate<T> predicate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sampler<T>`	`copy()`
`Cursor<T>`	`copyCursor()`
`protected boolean`	`findNext()` Walks to the next valid elements and stores them in member variables cachedType1 and cachedType2.
`void`	`fwd()`
`T`	`get()`
`double`	`getDoublePosition(int arg0)`
`float`	`getFloatPosition(int arg0)`
`int`	`getIntPosition(int arg0)`
`long`	`getLongPosition(int arg0)`
`boolean`	`hasNext()`
`void`	`jumpFwd(long num)`
`void`	`localize(double[] arg0)`
`void`	`localize(float[] arg0)`
`void`	`localize(int[] arg0)`
`void`	`localize(long[] arg0)`
`T`	`next()`
`int`	`numDimensions()`
`void`	`remove()`
`void`	`reset()`

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

Methods inherited from interface java.util.Iterator
forEachRemaining

Methods inherited from interface net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

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

- Field Detail
  - predicate
```
protected final Predicate<T extends Type<T>> predicate
```
  - cursor
```
protected final Cursor<T extends Type<T>> cursor
```
  - lookedForNext
```
protected boolean lookedForNext
```
  - hasNext
```
protected boolean hasNext
```
- Constructor Detail
  - PredicateCursor
```
public PredicateCursor(Cursor<T> cursor,
                       Predicate<T> predicate)
```
- Method Detail
  - findNext
```
protected boolean findNext()
```
    Walks to the next valid elements and stores them in member variables cachedType1 and cachedType2.
    
    Returns:
    
    true if a next element was found, false otherwise
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
  - fwd
```
public void fwd()
```
  - jumpFwd
```
public void jumpFwd(long num)
```
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T extends Type<T>>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T extends Type<T>>
  - reset
```
public void reset()
```
  - getDoublePosition
```
public double getDoublePosition(int arg0)
```
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - getFloatPosition
```
public float getFloatPosition(int arg0)
```
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - localize
```
public void localize(float[] arg0)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] arg0)
```
    Specified by:
    
    localize in interface RealLocalizable
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - copy
```
public Sampler<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T extends Type<T>>
  - get
```
public T get()
```
    Specified by:
    
    get in interface Sampler<T extends Type<T>>
  - getIntPosition
```
public int getIntPosition(int arg0)
```
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int arg0)
```
    Specified by:
    
    getLongPosition in interface Localizable
  - localize
```
public void localize(int[] arg0)
```
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] arg0)
```
    Specified by:
    
    localize in interface Localizable
  - copyCursor
```
public Cursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T extends Type<T>>
    
    Specified by:
    
    copyCursor in interface RealCursor<T extends Type<T>>

Class PredicateCursor<T extends Type<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

predicate

cursor

lookedForNext

hasNext

Constructor Detail

PredicateCursor

Method Detail

findNext

hasNext

fwd

jumpFwd

next

remove

reset

getDoublePosition

getFloatPosition

localize

localize

numDimensions

copy

get

getIntPosition

getLongPosition

localize

localize

copyCursor