fr.igred.omero.core

Interface PlaneInfo

All Superinterfaces:

RemoteObject

All Known Implementing Classes:

PlaneInfoWrapper

public interface PlaneInfo
extends RemoteObject

Interface to handle PlaneInfo on OMERO.

Method Summary

Modifier and Type	Method and Description
PlaneInfoData	asDataObject() Returns a PlaneInfoData corresponding to the handled object.
static Time	computeMeanExposureTime(Iterable<? extends PlaneInfo> planesInfo, int channel) Computes the mean exposure time for a given channel in a PlaneInfo collection.
static Time	computeMeanTimeInterval(Collection<? extends PlaneInfo> planesInfo, int sizeT) Computes the mean time interval from the deltaT in a PlaneInfo collection.
Time	getDeltaT() Retrieves the plane deltaT.
Time	getExposureTime() Retrieves the exposure time.
static Length	getMinPosition(Collection<? extends PlaneInfo> planesInfo, Function<? super PlaneInfo,? extends Length> getter, ome.units.unit.Unit<ome.units.quantity.Length> unit) Retrieves the min value for the specified getter in a PlaneInfo collection.
Length	getPositionX() Retrieves the X stage position.
Length	getPositionY() Retrieves the Y stage position.
Length	getPositionZ() Retrieves the Z stage position.
int	getTheC() Retrieves the plane channel index.
int	getTheT() Retrieves the plane time index.
int	getTheZ() Retrieves the plane slice index.

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

Method Detail

computeMeanTimeInterval

static Time computeMeanTimeInterval(Collection<? extends PlaneInfo> planesInfo,
                                    int sizeT)

Computes the mean time interval from the deltaT in a PlaneInfo collection.

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

sizeT - The number of time points for these planes.

Returns:

See above.

computeMeanExposureTime

static Time computeMeanExposureTime(Iterable<? extends PlaneInfo> planesInfo,
                                    int channel)

Computes the mean exposure time for a given channel in a PlaneInfo collection.

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

channel - The channel index.

Returns:

See above.

getMinPosition

static Length getMinPosition(Collection<? extends PlaneInfo> planesInfo,
                             Function<? super PlaneInfo,? extends Length> getter,
                             ome.units.unit.Unit<ome.units.quantity.Length> unit)

Retrieves the min value for the specified getter in a PlaneInfo collection.

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

getter - The getter function to use.

unit - The unit to set the results in.

Returns:

See above.

asDataObject

PlaneInfoData asDataObject()

Returns a PlaneInfoData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getDeltaT

Time getDeltaT()

Retrieves the plane deltaT.

Returns:

See above.

getExposureTime

Time getExposureTime()

Retrieves the exposure time.

Returns:

See above.

getPositionX

Length getPositionX()

Retrieves the X stage position.

Returns:

See above.

getPositionY

Length getPositionY()

Retrieves the Y stage position.

Returns:

See above.

getPositionZ

Length getPositionZ()

Retrieves the Z stage position.

Returns:

See above.

getTheC

int getTheC()

Retrieves the plane channel index.

Returns:

See above.

getTheT

int getTheT()

Retrieves the plane time index.

Returns:

See above.

getTheZ

int getTheZ()

Retrieves the plane slice index.

Returns:

See above.