Package fr.igred.omero.meta

Class PlaneInfoWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<PlaneInfoData>

fr.igred.omero.meta.PlaneInfoWrapper

public class PlaneInfoWrapper
extends GenericObjectWrapper<PlaneInfoData>

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
PlaneInfoWrapper(PlaneInfoData object)	Constructor of the class PlaneInfoWrapper.

Method Summary

Modifier and Type	Method	Description
PlaneInfoData	asPlaneInfoData()	Deprecated. Returns the PlaneInfoData contained.
static Time	computeMeanExposureTime(java.lang.Iterable<? extends PlaneInfoWrapper> planesInfo, int channel)	Computes the mean exposure time for a given channel in a PlaneInfoWrapper collection.
static Time	computeMeanTimeInterval(java.util.Collection<? extends PlaneInfoWrapper> planesInfo, int sizeT)	Computes the mean time interval from the deltaT in a PlaneInfoWrapper collection.
Time	getDeltaT()	Retrieves the plane deltaT.
Time	getExposureTime()	Retrieves the exposure time.
static Length	getMinPosition(java.util.Collection<? extends PlaneInfoWrapper> planesInfo, java.util.function.Function<? super PlaneInfoWrapper,? extends Length> getter, ome.units.unit.Unit<ome.units.quantity.Length> unit)	Retrieves the min value for the specified getter in a PlaneInfoWrapper 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 class fr.igred.omero.GenericObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, flatten, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaneInfoWrapper

public PlaneInfoWrapper(PlaneInfoData object)

Constructor of the class PlaneInfoWrapper.

Parameters:

object - The PlaneInfoData to wrap in the PlaneInfoWrapper.

Method Detail

computeMeanTimeInterval

public static Time computeMeanTimeInterval(java.util.Collection<? extends PlaneInfoWrapper> planesInfo,
                                           int sizeT)

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

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

sizeT - The number of time points for these planes.

Returns:

See above.

computeMeanExposureTime

public static Time computeMeanExposureTime(java.lang.Iterable<? extends PlaneInfoWrapper> planesInfo,
                                           int channel)

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

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

channel - The channel index.

Returns:

See above.

getMinPosition

public static Length getMinPosition(java.util.Collection<? extends PlaneInfoWrapper> planesInfo,
                                    java.util.function.Function<? super PlaneInfoWrapper,? extends Length> getter,
                                    ome.units.unit.Unit<ome.units.quantity.Length> unit)

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

Parameters:

planesInfo - A collection of PlaneInfoWrappers.

getter - The getter function to use.

unit - The unit to set the results in.

Returns:

See above.

asPlaneInfoData

@Deprecated
public PlaneInfoData asPlaneInfoData()

Deprecated.

Returns the PlaneInfoData contained. Use GenericObjectWrapper.asDataObject() instead.

Returns:

See above.

getDeltaT

public Time getDeltaT()

Retrieves the plane deltaT.

Returns:

See above.

getExposureTime

public Time getExposureTime()

Retrieves the exposure time.

Returns:

See above.

getPositionX

public Length getPositionX()

Retrieves the X stage position.

Returns:

See above.

getPositionY

public Length getPositionY()

Retrieves the Y stage position.

Returns:

See above.

getPositionZ

public Length getPositionZ()

Retrieves the Z stage position.

Returns:

See above.

getTheC

public int getTheC()

Retrieves the plane channel index.

Returns:

See above.

getTheT

public int getTheT()

Retrieves the plane time index.

Returns:

See above.

getTheZ

public int getTheZ()

Retrieves the plane slice index.

Returns:

See above.