ArrayImgs (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.img.array.ArrayImgs

```
public final class ArrayImgs
extends Object
```
Convenience factory methods for creation of ArrayImg instances with the most common pixel Type variants. The collection includes factories to re-use existing primitive type arrays as data. This can be used for in-place access to data from other libraries such as AWT or ImageJ. Keep in mind that this cannot be a complete collection since the number of existing pixel Types may be extended.

For pixel Types T not present in this collection, use the generic ArrayImgFactory.create(long[], net.imglib2.type.NativeType), e.g.
```
 img = new ArrayImgFactory< MyType >.create( new long[] { 100, 200 }, new MyType() );
 
```
Author:

Stephan Saalfeld, Philipp Hanslovsky

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static <A extends IntAccess> ArrayImg<ARGBType,A>`	`argbs(A access, long... dim)` Creates an `ArrayImg`<`ARGBType`, `IntAccess`> using a `IntAccess` passed as argument.
`static ArrayImg<ARGBType,IntArray>`	`argbs(int[] array, long... dim)` Creates an `ArrayImg`<`ARGBType`, `IntArray`> reusing a passed int[] array.
`static ArrayImg<ARGBType,IntArray>`	`argbs(long... dim)` Create an `ArrayImg`<`ARGBType`, `IntArray`>.
`static <A extends BooleanAccess> ArrayImg<NativeBoolType,A>`	`bits(A access, long... dim)` Deprecated. use `booleans(BooleanAccess, long...)`
`static <A extends LongAccess> ArrayImg<BitType,A>`	`bits(A access, long... dim)` Creates an `ArrayImg`<`BitType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<BitType,LongArray>`	`bits(long... dim)` Create an `ArrayImg`<`BitType`, `LongArray`>.
`static <A extends BooleanAccess> ArrayImg<NativeBoolType,A>`	`booleans(A access, long... dim)` Creates an `ArrayImg`<`NativeBoolType`, `BooleanAccess`> using a `BooleanAccess` passed as argument.
`static ArrayImg<NativeBoolType,BooleanArray>`	`booleans(boolean[] array, long... dim)` Creates an `ArrayImg`<`NativeBoolType`, `BooleanArray`> reusing a passed byte[] array.
`static ArrayImg<NativeBoolType,BooleanArray>`	`booleans(long... dim)` Create an `ArrayImg`<`NativeBoolType`, `BooleanArray`>.
`static <A extends ByteAccess> ArrayImg<ByteType,A>`	`bytes(A access, long... dim)` Creates an `ArrayImg`<`ByteType`, `ByteAccess`> using a `ByteAccess` passed as argument.
`static ArrayImg<ByteType,ByteArray>`	`bytes(byte[] array, long... dim)` Creates an `ArrayImg`<`ByteType`, `ByteArray`> reusing a passed byte[] array.
`static ArrayImg<ByteType,ByteArray>`	`bytes(long... dim)` Create an `ArrayImg`<`ByteType`, `ByteArray`>.
`static <A extends DoubleAccess> ArrayImg<ComplexDoubleType,A>`	`complexDoubles(A access, long... dim)` Creates an `ArrayImg`<`ComplexDoubleType`, `DoubleAccess`> using a `DoubleAccess` passed as argument.
`static ArrayImg<ComplexDoubleType,DoubleArray>`	`complexDoubles(double[] array, long... dim)` Creates an `ArrayImg`<`DoubleType`, `DoubleArray`> reusing a passed double[] array.
`static ArrayImg<ComplexDoubleType,DoubleArray>`	`complexDoubles(long... dim)` Create an `ArrayImg`<`ComplexDoubleType`, `DoubleArray`>.
`static <A extends FloatAccess> ArrayImg<ComplexFloatType,A>`	`complexFloats(A access, long... dim)` Creates an `ArrayImg`<`ComplexFloatType`, `FloatAccess`> using a `FloatAccess` passed as argument.
`static ArrayImg<ComplexFloatType,FloatArray>`	`complexFloats(float[] array, long... dim)` Creates an `ArrayImg`<`FloatType`, `FloatArray`> reusing a passed float[] array.
`static ArrayImg<ComplexFloatType,FloatArray>`	`complexFloats(long... dim)` Create an `ArrayImg`<`ComplexFloatType`, `FloatArray`>.
`static <A extends DoubleAccess> ArrayImg<DoubleType,A>`	`doubles(A access, long... dim)` Creates an `ArrayImg`<`DoubleType`, `DoubleAccess`> using a `DoubleAccess` passed as argument.
`static ArrayImg<DoubleType,DoubleArray>`	`doubles(double[] array, long... dim)` Creates an `ArrayImg`<`DoubleType`, `DoubleArray`> reusing a passed double[] array.
`static ArrayImg<DoubleType,DoubleArray>`	`doubles(long... dim)` Create an `ArrayImg`<`DoubleType`, `DoubleArray`>.
`static <A extends FloatAccess> ArrayImg<FloatType,A>`	`floats(A access, long... dim)` Creates an `ArrayImg`<`FloatType`, `FloatAccess`> using a `FloatAccess` passed as argument.
`static ArrayImg<FloatType,FloatArray>`	`floats(float[] array, long... dim)` Creates an `ArrayImg`<`FloatType`, `FloatArray`> reusing a passed float[] array.
`static ArrayImg<FloatType,FloatArray>`	`floats(long... dim)` Create an `ArrayImg`<`FloatType`, `FloatArray`>.
`static <A extends IntAccess> ArrayImg<IntType,A>`	`ints(A access, long... dim)` Creates an `ArrayImg`<`IntType`, `IntAccess`> using a `IntAccess` passed as argument.
`static ArrayImg<IntType,IntArray>`	`ints(int[] array, long... dim)` Creates an `ArrayImg`<`IntType`, `IntArray`> reusing a passed int[] array.
`static ArrayImg<IntType,IntArray>`	`ints(long... dim)` Create an `ArrayImg`<`IntType`, `IntArray`>.
`static <A extends LongAccess> ArrayImg<LongType,A>`	`longs(A access, long... dim)` Creates an `ArrayImg`<`LongType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<LongType,LongArray>`	`longs(long... dim)` Create an `ArrayImg`<`LongType`, `LongArray`>.
`static ArrayImg<LongType,LongArray>`	`longs(long[] array, long... dim)` Creates an `ArrayImg`<`LongType`, `LongArray`> reusing a passed long[] array.
`static <A extends ShortAccess> ArrayImg<ShortType,A>`	`shorts(A access, long... dim)` Creates an `ArrayImg`<`ShortType`, `ShortAccess`> using a `ShortAccess` passed as argument.
`static ArrayImg<ShortType,ShortArray>`	`shorts(long... dim)` Create an `ArrayImg`<`ShortType`, `ShortArray`>.
`static ArrayImg<ShortType,ShortArray>`	`shorts(short[] array, long... dim)` Creates an `ArrayImg`<`ShortType`, `ShortArray`> reusing a passed short[] array.
`static <A extends LongAccess> ArrayImg<Unsigned128BitType,A>`	`unsigned128Bits(A access, long... dim)` Creates an `ArrayImg`<`Unsigned128BitType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<Unsigned128BitType,LongArray>`	`unsigned128Bits(long... dim)` Create an `ArrayImg`<`Unsigned128BitType`, `LongArray`>.
`static <A extends LongAccess> ArrayImg<Unsigned12BitType,A>`	`unsigned12Bits(A access, long... dim)` Creates an `ArrayImg`<`Unsigned12BitType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<Unsigned12BitType,LongArray>`	`unsigned12Bits(long... dim)` Create an `ArrayImg`<`Unsigned12BitType`, `LongArray`>.
`static <A extends LongAccess> ArrayImg<Unsigned2BitType,A>`	`unsigned2Bits(A access, long... dim)` Creates an `ArrayImg`<`Unsigned2BitType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<Unsigned2BitType,LongArray>`	`unsigned2Bits(long... dim)` Create an `ArrayImg`<`Unsigned2BitType`, `LongArray`>.
`static <A extends LongAccess> ArrayImg<Unsigned4BitType,A>`	`unsigned4Bits(A access, long... dim)` Creates an `ArrayImg`<`Unsigned4BitType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<Unsigned4BitType,LongArray>`	`unsigned4Bits(long... dim)` Create an `ArrayImg`<`Unsigned4BitType`, `LongArray`>.
`static <A extends ByteAccess> ArrayImg<UnsignedByteType,A>`	`unsignedBytes(A access, long... dim)` Creates an `ArrayImg`<`UnsignedByteType`, `ByteAccess`> using a `ByteAccess` passed as argument.
`static ArrayImg<UnsignedByteType,ByteArray>`	`unsignedBytes(byte[] array, long... dim)` Creates an `ArrayImg`<`UnsignedByteType`, `ByteArray`> reusing a passed byte[] array.
`static ArrayImg<UnsignedByteType,ByteArray>`	`unsignedBytes(long... dim)` Create an `ArrayImg`<`UnsignedByteType`, `ByteArray`>.
`static <A extends IntAccess> ArrayImg<UnsignedIntType,A>`	`unsignedInts(A access, long... dim)` Creates an `ArrayImg`<`UnsignedIntType`, `IntAccess`> using a `IntAccess` passed as argument.
`static ArrayImg<UnsignedIntType,IntArray>`	`unsignedInts(int[] array, long... dim)` Creates an `ArrayImg`<`UnsignedIntType`, `IntArray`> reusing a passed int[] array.
`static ArrayImg<UnsignedIntType,IntArray>`	`unsignedInts(long... dim)` Create an `ArrayImg`<`UnsignedIntType`, `IntArray`>.
`static <A extends LongAccess> ArrayImg<UnsignedLongType,A>`	`unsignedLongs(A access, long... dim)` Creates an `ArrayImg`<`UnsignedLongType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<UnsignedLongType,LongArray>`	`unsignedLongs(long... dim)` Create an `ArrayImg`<`UnsignedLongType`, `LongArray`>.
`static ArrayImg<UnsignedLongType,LongArray>`	`unsignedLongs(long[] array, long... dim)` Creates an `ArrayImg`<`UnsignedLongType`, `LongArray`> reusing a passed long[] array.
`static ArrayImg<UnsignedLongType,LongArray>`	`unsignedLongss(long[] array, long... dim)` Deprecated. use `unsignedLongs(long[], long...)`
`static <A extends ShortAccess> ArrayImg<UnsignedShortType,A>`	`unsignedShorts(A access, long... dim)` Creates an `ArrayImg`<`UnsignedShortType`, `ShortAccess`> using a `ShortAccess` passed as argument.
`static ArrayImg<UnsignedShortType,ShortArray>`	`unsignedShorts(long... dim)` Create an `ArrayImg`<`UnsignedShortType`, `ShortArray`>.
`static ArrayImg<UnsignedShortType,ShortArray>`	`unsignedShorts(short[] array, long... dim)` Creates an `ArrayImg`<`UnsignedShortType`, `ShortArray`> reusing a passed short[] array.
`static <A extends LongAccess> ArrayImg<UnsignedVariableBitLengthType,A>`	`unsignedVariableBitLengths(A access, int nbits, long... dim)` Creates an `ArrayImg`<`UnsignedVariableBitLengthType`, `LongAccess`> using a `LongAccess` passed as argument.
`static ArrayImg<UnsignedVariableBitLengthType,LongArray>`	`unsignedVariableBitLengths(int nbits, long... dim)` Create an `ArrayImg`<`UnsignedVariableBitLengthType`, `LongArray`>.

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

Method Detail

unsignedBytes

public static final ArrayImg<UnsignedByteType,ByteArray> unsignedBytes(long... dim)

Create an ArrayImg<UnsignedByteType, ByteArray>.

unsignedBytes

public static final ArrayImg<UnsignedByteType,ByteArray> unsignedBytes(byte[] array,
                                                                       long... dim)

Creates an ArrayImg<UnsignedByteType, ByteArray> reusing a passed byte[] array.

unsignedBytes

public static final <A extends ByteAccess> ArrayImg<UnsignedByteType,A> unsignedBytes(A access,
                                                                                      long... dim)

Creates an ArrayImg<UnsignedByteType, ByteAccess> using a ByteAccess passed as argument.

bytes

public static final ArrayImg<ByteType,ByteArray> bytes(long... dim)

Create an ArrayImg<ByteType, ByteArray>.

bytes

public static final ArrayImg<ByteType,ByteArray> bytes(byte[] array,
                                                       long... dim)

Creates an ArrayImg<ByteType, ByteArray> reusing a passed byte[] array.

bytes

public static final <A extends ByteAccess> ArrayImg<ByteType,A> bytes(A access,
                                                                      long... dim)

Creates an ArrayImg<ByteType, ByteAccess> using a ByteAccess passed as argument.

unsignedShorts

public static final ArrayImg<UnsignedShortType,ShortArray> unsignedShorts(long... dim)

Create an ArrayImg<UnsignedShortType, ShortArray>.

unsignedShorts

public static final ArrayImg<UnsignedShortType,ShortArray> unsignedShorts(short[] array,
                                                                          long... dim)

Creates an ArrayImg<UnsignedShortType, ShortArray> reusing a passed short[] array.

unsignedShorts

public static final <A extends ShortAccess> ArrayImg<UnsignedShortType,A> unsignedShorts(A access,
                                                                                         long... dim)

Creates an ArrayImg<UnsignedShortType, ShortAccess> using a ShortAccess passed as argument.

shorts

public static final ArrayImg<ShortType,ShortArray> shorts(long... dim)

Create an ArrayImg<ShortType, ShortArray>.

shorts

public static final ArrayImg<ShortType,ShortArray> shorts(short[] array,
                                                          long... dim)

Creates an ArrayImg<ShortType, ShortArray> reusing a passed short[] array.

shorts

public static final <A extends ShortAccess> ArrayImg<ShortType,A> shorts(A access,
                                                                         long... dim)

Creates an ArrayImg<ShortType, ShortAccess> using a ShortAccess passed as argument.

unsignedInts

public static final ArrayImg<UnsignedIntType,IntArray> unsignedInts(long... dim)

Create an ArrayImg<UnsignedIntType, IntArray>.

unsignedInts

public static final ArrayImg<UnsignedIntType,IntArray> unsignedInts(int[] array,
                                                                    long... dim)

Creates an ArrayImg<UnsignedIntType, IntArray> reusing a passed int[] array.

unsignedInts

public static final <A extends IntAccess> ArrayImg<UnsignedIntType,A> unsignedInts(A access,
                                                                                   long... dim)

Creates an ArrayImg<UnsignedIntType, IntAccess> using a IntAccess passed as argument.

ints

public static final ArrayImg<IntType,IntArray> ints(long... dim)

Create an ArrayImg<IntType, IntArray>.

ints

public static final ArrayImg<IntType,IntArray> ints(int[] array,
                                                    long... dim)

Creates an ArrayImg<IntType, IntArray> reusing a passed int[] array.

ints

public static final <A extends IntAccess> ArrayImg<IntType,A> ints(A access,
                                                                   long... dim)

Creates an ArrayImg<IntType, IntAccess> using a IntAccess passed as argument.

unsignedLongs

public static final ArrayImg<UnsignedLongType,LongArray> unsignedLongs(long... dim)

Create an ArrayImg<UnsignedLongType, LongArray>.

unsignedLongss

@Deprecated
public static final ArrayImg<UnsignedLongType,LongArray> unsignedLongss(long[] array,
                                                                                    long... dim)

Deprecated. use unsignedLongs(long[], long...)

Creates an ArrayImg<UnsignedLongType, LongArray> reusing a passed long[] array.

unsignedLongs

public static final ArrayImg<UnsignedLongType,LongArray> unsignedLongs(long[] array,
                                                                       long... dim)

Creates an ArrayImg<UnsignedLongType, LongArray> reusing a passed long[] array.

unsignedLongs

public static final <A extends LongAccess> ArrayImg<UnsignedLongType,A> unsignedLongs(A access,
                                                                                      long... dim)

Creates an ArrayImg<UnsignedLongType, LongAccess> using a LongAccess passed as argument.

longs

public static final ArrayImg<LongType,LongArray> longs(long... dim)

Create an ArrayImg<LongType, LongArray>.

longs

public static final ArrayImg<LongType,LongArray> longs(long[] array,
                                                       long... dim)

Creates an ArrayImg<LongType, LongArray> reusing a passed long[] array.

longs

public static final <A extends LongAccess> ArrayImg<LongType,A> longs(A access,
                                                                      long... dim)

Creates an ArrayImg<LongType, LongAccess> using a LongAccess passed as argument.

booleans

public static final ArrayImg<NativeBoolType,BooleanArray> booleans(long... dim)

Create an ArrayImg<NativeBoolType, BooleanArray>.

booleans

public static final ArrayImg<NativeBoolType,BooleanArray> booleans(boolean[] array,
                                                                   long... dim)

Creates an ArrayImg<NativeBoolType, BooleanArray> reusing a passed byte[] array.

booleans

public static final <A extends BooleanAccess> ArrayImg<NativeBoolType,A> booleans(A access,
                                                                                  long... dim)

Creates an ArrayImg<NativeBoolType, BooleanAccess> using a BooleanAccess passed as argument.

bits

public static final ArrayImg<BitType,LongArray> bits(long... dim)

Create an ArrayImg<BitType, LongArray>.

bits

@Deprecated
public static final <A extends BooleanAccess> ArrayImg<NativeBoolType,A> bits(A access,
                                                                                          long... dim)

Deprecated. use booleans(BooleanAccess, long...)

bits

public static final <A extends LongAccess> ArrayImg<BitType,A> bits(A access,
                                                                    long... dim)

Creates an ArrayImg<BitType, LongAccess> using a LongAccess passed as argument.

unsigned2Bits

public static final ArrayImg<Unsigned2BitType,LongArray> unsigned2Bits(long... dim)

Create an ArrayImg<Unsigned2BitType, LongArray>.

unsigned2Bits

public static final <A extends LongAccess> ArrayImg<Unsigned2BitType,A> unsigned2Bits(A access,
                                                                                      long... dim)

Creates an ArrayImg<Unsigned2BitType, LongAccess> using a LongAccess passed as argument.

unsigned4Bits

public static final ArrayImg<Unsigned4BitType,LongArray> unsigned4Bits(long... dim)

Create an ArrayImg<Unsigned4BitType, LongArray>.

unsigned4Bits

public static final <A extends LongAccess> ArrayImg<Unsigned4BitType,A> unsigned4Bits(A access,
                                                                                      long... dim)

Creates an ArrayImg<Unsigned4BitType, LongAccess> using a LongAccess passed as argument.

unsigned12Bits

public static final ArrayImg<Unsigned12BitType,LongArray> unsigned12Bits(long... dim)

Create an ArrayImg<Unsigned12BitType, LongArray>.

unsigned12Bits

public static final <A extends LongAccess> ArrayImg<Unsigned12BitType,A> unsigned12Bits(A access,
                                                                                        long... dim)

Creates an ArrayImg<Unsigned12BitType, LongAccess> using a LongAccess passed as argument.

unsigned128Bits

public static final ArrayImg<Unsigned128BitType,LongArray> unsigned128Bits(long... dim)

Create an ArrayImg<Unsigned128BitType, LongArray>.

unsigned128Bits

public static final <A extends LongAccess> ArrayImg<Unsigned128BitType,A> unsigned128Bits(A access,
                                                                                          long... dim)

Creates an ArrayImg<Unsigned128BitType, LongAccess> using a LongAccess passed as argument.

unsignedVariableBitLengths

public static final ArrayImg<UnsignedVariableBitLengthType,LongArray> unsignedVariableBitLengths(int nbits,
                                                                                                 long... dim)

Create an ArrayImg<UnsignedVariableBitLengthType, LongArray>.

unsignedVariableBitLengths

public static final <A extends LongAccess> ArrayImg<UnsignedVariableBitLengthType,A> unsignedVariableBitLengths(A access,
                                                                                                                int nbits,
                                                                                                                long... dim)

Creates an ArrayImg<UnsignedVariableBitLengthType, LongAccess> using a LongAccess passed as argument.

floats

public static final ArrayImg<FloatType,FloatArray> floats(long... dim)

Create an ArrayImg<FloatType, FloatArray>.

floats

public static final ArrayImg<FloatType,FloatArray> floats(float[] array,
                                                          long... dim)

Creates an ArrayImg<FloatType, FloatArray> reusing a passed float[] array.

floats

public static final <A extends FloatAccess> ArrayImg<FloatType,A> floats(A access,
                                                                         long... dim)

Creates an ArrayImg<FloatType, FloatAccess> using a FloatAccess passed as argument.

doubles

public static final ArrayImg<DoubleType,DoubleArray> doubles(long... dim)

Create an ArrayImg<DoubleType, DoubleArray>.

doubles

public static final ArrayImg<DoubleType,DoubleArray> doubles(double[] array,
                                                             long... dim)

Creates an ArrayImg<DoubleType, DoubleArray> reusing a passed double[] array.

doubles

public static final <A extends DoubleAccess> ArrayImg<DoubleType,A> doubles(A access,
                                                                            long... dim)

Creates an ArrayImg<DoubleType, DoubleAccess> using a DoubleAccess passed as argument.

argbs

public static final ArrayImg<ARGBType,IntArray> argbs(long... dim)

Create an ArrayImg<ARGBType, IntArray>.

argbs

public static final ArrayImg<ARGBType,IntArray> argbs(int[] array,
                                                      long... dim)

Creates an ArrayImg<ARGBType, IntArray> reusing a passed int[] array.

argbs

public static final <A extends IntAccess> ArrayImg<ARGBType,A> argbs(A access,
                                                                     long... dim)

Creates an ArrayImg<ARGBType, IntAccess> using a IntAccess passed as argument.

complexFloats

public static final ArrayImg<ComplexFloatType,FloatArray> complexFloats(long... dim)

Create an ArrayImg<ComplexFloatType, FloatArray>.

complexFloats

public static final ArrayImg<ComplexFloatType,FloatArray> complexFloats(float[] array,
                                                                        long... dim)

Creates an ArrayImg<FloatType, FloatArray> reusing a passed float[] array.

complexFloats

public static final <A extends FloatAccess> ArrayImg<ComplexFloatType,A> complexFloats(A access,
                                                                                       long... dim)

Creates an ArrayImg<ComplexFloatType, FloatAccess> using a FloatAccess passed as argument.

complexDoubles

public static final ArrayImg<ComplexDoubleType,DoubleArray> complexDoubles(long... dim)

Create an ArrayImg<ComplexDoubleType, DoubleArray>.

complexDoubles

public static final ArrayImg<ComplexDoubleType,DoubleArray> complexDoubles(double[] array,
                                                                           long... dim)

Creates an ArrayImg<DoubleType, DoubleArray> reusing a passed double[] array.

complexDoubles

public static final <A extends DoubleAccess> ArrayImg<ComplexDoubleType,A> complexDoubles(A access,
                                                                                          long... dim)

Creates an ArrayImg<ComplexDoubleType, DoubleAccess> using a DoubleAccess passed as argument.

Class ArrayImgs

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unsignedBytes

unsignedBytes

unsignedBytes

bytes

bytes

bytes

unsignedShorts

unsignedShorts

unsignedShorts

shorts

shorts

shorts

unsignedInts

unsignedInts

unsignedInts

ints

ints

ints

unsignedLongs

unsignedLongss

unsignedLongs

unsignedLongs

longs

longs

longs

booleans

booleans

booleans

bits

bits

bits

unsigned2Bits

unsigned2Bits

unsigned4Bits

unsigned4Bits

unsigned12Bits

unsigned12Bits

unsigned128Bits

unsigned128Bits

unsignedVariableBitLengths

unsignedVariableBitLengths

floats

floats

floats

doubles

doubles

doubles

argbs

argbs

argbs

complexFloats

complexFloats

complexFloats

complexDoubles

complexDoubles

complexDoubles