HorizontalLineNeighborhoodLocalizableSampler (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.algorithm.neighborhood.HorizontalLineNeighborhoodLocalizableSampler<T>

All Implemented Interfaces:

EuclideanSpace, Localizable, RealLocalizable, Sampler<Neighborhood<T>>

Direct Known Subclasses:

HorizontalLineNeighborhoodCursor, HorizontalLineNeighborhoodRandomAccess
```
public abstract class HorizontalLineNeighborhoodLocalizableSampler<T>
extends AbstractEuclideanSpace
implements Localizable, Sampler<Neighborhood<T>>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Neighborhood<T>`	`currentNeighborhood`
`protected long[]`	`currentPos`
`protected int`	`dim`
`protected HorizontalLineNeighborhoodFactory<T>`	`neighborhoodFactory`
`protected RandomAccessible<T>`	`source`
`protected Interval`	`sourceInterval`
`protected long`	`span`

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HorizontalLineNeighborhoodLocalizableSampler(HorizontalLineNeighborhoodLocalizableSampler<T> c)`
	`HorizontalLineNeighborhoodLocalizableSampler(RandomAccessible<T> source, long span, int dim, boolean skipCenter, HorizontalLineNeighborhoodFactory<T> factory, Interval accessInterval)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Neighborhood<T>`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`double`	`getDoublePosition(int d)` Return the current position in a given dimension.
`float`	`getFloatPosition(int d)` Return the current position in a given dimension.
`int`	`getIntPosition(int d)` Return the current position in a given dimension.
`long`	`getLongPosition(int d)` Return the current position in a given dimension.
`void`	`localize(double[] position)` Write the current position into the passed array.
`void`	`localize(float[] position)` Write the current position into the passed array.
`void`	`localize(int[] position)` Write the current position into the passed array.
`void`	`localize(long[] position)` Write the current position into the passed array.

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.Localizable
localize, positionAsLongArray, positionAsPoint

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Sampler
copy

- Field Detail
  - source
```
protected final RandomAccessible<T> source
```
  - sourceInterval
```
protected final Interval sourceInterval
```
  - span
```
protected final long span
```
  - dim
```
protected final int dim
```
  - currentPos
```
protected final long[] currentPos
```
  - neighborhoodFactory
```
protected final HorizontalLineNeighborhoodFactory<T> neighborhoodFactory
```
  - currentNeighborhood
```
protected final Neighborhood<T> currentNeighborhood
```
- Constructor Detail
  - HorizontalLineNeighborhoodLocalizableSampler
```
public HorizontalLineNeighborhoodLocalizableSampler(RandomAccessible<T> source,
                                                    long span,
                                                    int dim,
                                                    boolean skipCenter,
                                                    HorizontalLineNeighborhoodFactory<T> factory,
                                                    Interval accessInterval)
```
  - HorizontalLineNeighborhoodLocalizableSampler
```
protected HorizontalLineNeighborhoodLocalizableSampler(HorizontalLineNeighborhoodLocalizableSampler<T> c)
```
- Method Detail
  - get
```
public Neighborhood<T> get()
```
    Description copied from interface: Sampler
    
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
    
    Specified by:
    
    get in interface Sampler<Neighborhood<T>>
  - localize
```
public void localize(int[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(long[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - getIntPosition
```
public int getIntPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getLongPosition
```
public long getLongPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - localize
```
public void localize(float[] position)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(double[] position)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position

Class HorizontalLineNeighborhoodLocalizableSampler<T>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

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

source

sourceInterval

span

dim

currentPos

neighborhoodFactory

currentNeighborhood

Constructor Detail

HorizontalLineNeighborhoodLocalizableSampler

HorizontalLineNeighborhoodLocalizableSampler

Method Detail

get

localize

localize

getIntPosition

getLongPosition

localize

localize

getFloatPosition

getDoublePosition