IntervalIndexer (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.util.IntervalIndexer

```
public class IntervalIndexer
extends Object
```
N-dimensional data is often stored in a flat 1-dimensional array. This class provides convenience methods to translate between N-dimensional indices (positions) and 1-dimensional indices.

Author:

Tobias Pietzsch, Philipp Hanslovsky

Constructor Summary

Constructors
Constructor and Description

IntervalIndexer()

Constructors
Constructor and Description
`IntervalIndexer()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`createAllocationSteps(int[] dimensions, int[] steps)` Create allocation step array from the dimensions of an N-dimensional array.
`static void`	`createAllocationSteps(long[] dimensions, long[] steps)` Create allocation step array from the dimensions of an N-dimensional array.
`static void`	`indexToPosition(int index, int[] dimensions, double[] position)`
`static void`	`indexToPosition(int index, int[] dimensions, float[] position)`
`static int`	`indexToPosition(int index, int[] dimensions, int dimension)`
`static void`	`indexToPosition(int index, int[] dimensions, int[] position)`
`static int`	`indexToPosition(int index, int[] dimensions, int[] steps, int dimension)`
`static void`	`indexToPosition(int index, int[] dimensions, long[] position)`
`static void`	`indexToPosition(long index, Dimensions dimensions, Positionable position)`
`static void`	`indexToPosition(long index, long[] dimensions, double[] position)`
`static void`	`indexToPosition(long index, long[] dimensions, float[] position)`
`static long`	`indexToPosition(long index, long[] dimensions, int dimension)`
`static void`	`indexToPosition(long index, long[] dimensions, int[] position)`
`static void`	`indexToPosition(long index, long[] dimensions, long[] position)`
`static long`	`indexToPosition(long index, long[] dimensions, long[] steps, int dimension)`
`static void`	`indexToPositionForInterval(long index, Interval interval, Positionable position)`
`static int`	`indexToPositionWithOffset(int index, int[] dimensions, int[] offsets, int dimension)`
`static void`	`indexToPositionWithOffset(int index, int[] dimensions, int[] offsets, int[] position)`
`static int`	`indexToPositionWithOffset(int index, int[] dimensions, int[] steps, int[] offset, int dimension)`
`static long`	`indexToPositionWithOffset(int index, int[] dimensions, int[] steps, long[] offset, int dimension)`
`static void`	`indexToPositionWithOffset(int index, int[] dimensions, long[] offsets, long[] position)`
`static void`	`indexToPositionWithOffset(long index, long[] dimensions, long[] offsets, double[] position)`
`static void`	`indexToPositionWithOffset(long index, long[] dimensions, long[] offsets, float[] position)`
`static void`	`indexToPositionWithOffset(long index, long[] dimensions, long[] offsets, int[] position)`
`static void`	`indexToPositionWithOffset(long index, long[] dimensions, long[] offsets, long[] position)`
`static long`	`indexToPositionWithOffset(long index, long[] dimensions, long[] steps, long[] offsets, int dimension)`
`static int`	`positionToIndex(int[] position, int[] dimensions)`
`static long`	`positionToIndex(Localizable position, Dimensions dimensions)`
`static int`	`positionToIndex(long[] position, int[] dimensions)`
`static long`	`positionToIndex(long[] position, long[] dimensions)`
`static long`	`positionToIndexForInterval(Localizable position, Interval interval)`
`static int`	`positionWithOffsetToIndex(int[] position, int[] dimensions, int[] offsets)`
`static int`	`positionWithOffsetToIndex(long[] position, int[] dimensions, long[] offsets)`
`static long`	`positionWithOffsetToIndex(long[] position, long[] dimensions, long[] offsets)`

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

Constructor Detail
- IntervalIndexer
```
public IntervalIndexer()
```

Method Detail

positionToIndex

public static final int positionToIndex(int[] position,
                                        int[] dimensions)

positionToIndex

public static final int positionToIndex(long[] position,
                                        int[] dimensions)

positionToIndex

public static final long positionToIndex(long[] position,
                                         long[] dimensions)

positionToIndex

public static final long positionToIndex(Localizable position,
                                         Dimensions dimensions)

positionWithOffsetToIndex

public static final long positionWithOffsetToIndex(long[] position,
                                                   long[] dimensions,
                                                   long[] offsets)

positionWithOffsetToIndex

public static final int positionWithOffsetToIndex(long[] position,
                                                  int[] dimensions,
                                                  long[] offsets)

positionWithOffsetToIndex

public static final int positionWithOffsetToIndex(int[] position,
                                                  int[] dimensions,
                                                  int[] offsets)

indexToPosition

public static final void indexToPosition(int index,
                                         int[] dimensions,
                                         int[] position)

indexToPosition

public static final void indexToPosition(long index,
                                         long[] dimensions,
                                         int[] position)

indexToPosition

public static final void indexToPosition(int index,
                                         int[] dimensions,
                                         long[] position)

indexToPosition

public static final void indexToPosition(long index,
                                         long[] dimensions,
                                         long[] position)

indexToPosition

public static final void indexToPosition(long index,
                                         Dimensions dimensions,
                                         Positionable position)

indexToPosition

public static final void indexToPosition(int index,
                                         int[] dimensions,
                                         float[] position)

indexToPosition

public static final void indexToPosition(long index,
                                         long[] dimensions,
                                         float[] position)

indexToPosition

public static final void indexToPosition(int index,
                                         int[] dimensions,
                                         double[] position)

indexToPosition

public static final void indexToPosition(long index,
                                         long[] dimensions,
                                         double[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(int index,
                                                   int[] dimensions,
                                                   int[] offsets,
                                                   int[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(int index,
                                                   int[] dimensions,
                                                   long[] offsets,
                                                   long[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(long index,
                                                   long[] dimensions,
                                                   long[] offsets,
                                                   long[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(long index,
                                                   long[] dimensions,
                                                   long[] offsets,
                                                   int[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(long index,
                                                   long[] dimensions,
                                                   long[] offsets,
                                                   float[] position)

indexToPositionWithOffset

public static final void indexToPositionWithOffset(long index,
                                                   long[] dimensions,
                                                   long[] offsets,
                                                   double[] position)

indexToPosition

public static final int indexToPosition(int index,
                                        int[] dimensions,
                                        int dimension)

indexToPosition

public static final long indexToPosition(long index,
                                         long[] dimensions,
                                         int dimension)

indexToPositionWithOffset

public static final int indexToPositionWithOffset(int index,
                                                  int[] dimensions,
                                                  int[] offsets,
                                                  int dimension)

indexToPosition

public static final int indexToPosition(int index,
                                        int[] dimensions,
                                        int[] steps,
                                        int dimension)

indexToPosition

public static final long indexToPosition(long index,
                                         long[] dimensions,
                                         long[] steps,
                                         int dimension)

indexToPositionWithOffset

public static final int indexToPositionWithOffset(int index,
                                                  int[] dimensions,
                                                  int[] steps,
                                                  int[] offset,
                                                  int dimension)

indexToPositionWithOffset

public static long indexToPositionWithOffset(int index,
                                             int[] dimensions,
                                             int[] steps,
                                             long[] offset,
                                             int dimension)

indexToPositionWithOffset

public static final long indexToPositionWithOffset(long index,
                                                   long[] dimensions,
                                                   long[] steps,
                                                   long[] offsets,
                                                   int dimension)

positionToIndexForInterval

public static long positionToIndexForInterval(Localizable position,
                                              Interval interval)

indexToPositionForInterval

public static void indexToPositionForInterval(long index,
                                              Interval interval,
                                              Positionable position)

createAllocationSteps
```
public static void createAllocationSteps(long[] dimensions,
                                         long[] steps)
```
Create allocation step array from the dimensions of an N-dimensional array.

Parameters:

dimensions -

steps -

createAllocationSteps
```
public static void createAllocationSteps(int[] dimensions,
                                         int[] steps)
```
Create allocation step array from the dimensions of an N-dimensional array.

Parameters:

dimensions -

steps -

Class IntervalIndexer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntervalIndexer

Method Detail

positionToIndex

positionToIndex

positionToIndex

positionToIndex

positionWithOffsetToIndex

positionWithOffsetToIndex

positionWithOffsetToIndex

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPosition

indexToPositionWithOffset

indexToPositionWithOffset

indexToPositionWithOffset

indexToPositionWithOffset

indexToPositionWithOffset

indexToPositionWithOffset

indexToPosition

indexToPosition

indexToPositionWithOffset

indexToPosition

indexToPosition

indexToPositionWithOffset

indexToPositionWithOffset

indexToPositionWithOffset

positionToIndexForInterval

indexToPositionForInterval

createAllocationSteps

createAllocationSteps