com.bitplane.xt

Interface ImarisApplication

All Known Implementing Classes:

DefaultImarisApplication

public interface ImarisApplication

ImarisApplication wraps IApplicationPrx and represents one particular Imaris instance.

Author:

Tobias Pietzsch

Method Summary

Modifier and Type	Method and Description
default <T extends NativeType<T> & RealType<T>> ImarisDataset<T>	createDataset(T type, DatasetDimensions size) TODO
<T extends NativeType<T> & RealType<T>> ImarisDataset<T>	createDataset(T type, DatasetDimensions size, ImarisDatasetOptions options) TODO
default <T extends NativeType<T> & RealType<T>> ImarisDataset<T>	createDataset(T type, int sx, int sy, int sz, int sc, int st) Calls createDataset(NativeType, int, int, int, int, int, ImarisDatasetOptions) with default options.
<T extends NativeType<T> & RealType<T>> ImarisDataset<T>	createDataset(T type, int sx, int sy, int sz, int sc, int st, ImarisDatasetOptions options) Create a new ImarisDataset of the specified type with the specified dimensions.
int	getApplicationID() Get the object ID of the underlying IApplication ICE proxy.
default ImarisDataset<?>	getDataset() Get the first Imaris image as an ImarisDataset.
default ImarisDataset<?>	getDataset(ImarisDatasetOptions options) Get the first Imaris image as an ImarisDataset.
Imaris.IApplicationPrx	getIApplicationPrx() Get the underlying IApplication ICE proxy.
default ImarisDataset<?>	getImage(int imageIndex) Get the Imaris image at imageIndex as an ImarisDataset.
ImarisDataset<?>	getImage(int imageIndex, ImarisDatasetOptions options) Get the Imaris image at imageIndex as an ImarisDataset.
int	getNumberOfImages() Get the number of images loaded in the application.
default void	setDataset(ImarisDataset<?> dataset) Equivalent to setImage(0,dataset).
void	setImage(int imageIndex, ImarisDataset<?> dataset) Set an image to the application.

Method Detail

getIApplicationPrx

Imaris.IApplicationPrx getIApplicationPrx()

Get the underlying IApplication ICE proxy.

getApplicationID

int getApplicationID()

Get the object ID of the underlying IApplication ICE proxy.

getNumberOfImages

int getNumberOfImages()

Get the number of images loaded in the application.

getImage

ImarisDataset<?> getImage(int imageIndex,
                          ImarisDatasetOptions options)

Get the Imaris image at imageIndex as an ImarisDataset.

getImage

default ImarisDataset<?> getImage(int imageIndex)

Get the Imaris image at imageIndex as an ImarisDataset.

getDataset

default ImarisDataset<?> getDataset()

Get the first Imaris image as an ImarisDataset. Equivalent to getImage(0).

getDataset

default ImarisDataset<?> getDataset(ImarisDatasetOptions options)

Get the first Imaris image as an ImarisDataset. Equivalent to getImage(0).

setImage

void setImage(int imageIndex,
              ImarisDataset<?> dataset)

Set an image to the application. Image index is clamped to be at most the current number of images in the application.

setDataset

default void setDataset(ImarisDataset<?> dataset)

Equivalent to setImage(0,dataset).

createDataset

<T extends NativeType<T> & RealType<T>> ImarisDataset<T> createDataset(T type,
                                                                       int sx,
                                                                       int sy,
                                                                       int sz,
                                                                       int sc,
                                                                       int st,
                                                                       ImarisDatasetOptions options)

Create a new ImarisDataset of the specified type with the specified dimensions.

Sizes s≤0 indicate missing dimensions. For example, createDataset(new UnsignedByteType(), 300, 200, 0, 0, 0) creates a 2D ImarisDataset with axes [X,Y]. The size along missing dimensions (Z, C, T in this example) is set to s=1 on the Imaris side.

Parameters:

type - imglib2 pixel type. Must be one of UnsignedByteType, UnsignedShortType, or FloatType.

sx - size in X dimension

sy - size in Y dimension

sz - size in Z dimension

sc - size in C (channel) dimension

st - size in T (time) dimension

options -

createDataset

default <T extends NativeType<T> & RealType<T>> ImarisDataset<T> createDataset(T type,
                                                                               int sx,
                                                                               int sy,
                                                                               int sz,
                                                                               int sc,
                                                                               int st)

Calls createDataset(NativeType, int, int, int, int, int, ImarisDatasetOptions) with default options.

createDataset

<T extends NativeType<T> & RealType<T>> ImarisDataset<T> createDataset(T type,
                                                                       DatasetDimensions size,
                                                                       ImarisDatasetOptions options)

TODO

createDataset

default <T extends NativeType<T> & RealType<T>> ImarisDataset<T> createDataset(T type,
                                                                               DatasetDimensions size)

TODO