omero.gateway.model

Class ImageAcquisitionData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ImageAcquisitionData

public class ImageAcquisitionData
extends DataObject

Object hosting the acquisition metadata.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
ImageAcquisitionData(omero.model.Image image) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
double	getAirPressure() Deprecated. Replaced by getAirPressure(UnitsPressure)
omero.model.Pressure	getAirPressure(omero.model.enums.UnitsPressure unit) Returns the air pressure.
double	getCo2Percent() Returns the Co2 level, this is a percent value in the interval [0, 1].
double	getCorrectionCollar() Returns the correction collar of the objective.
double	getHumidity() Returns the humidity level, this is a value in the interval [0, 1].
long	getImagingEnvironmentId() Returns the id of the StageLabel or -1 if not already linked to the image.
String	getLabelName() Returns the name of the stage label.
String	getMedium() Returns the medium of the objective.
omero.model.Medium	getMediumAsEnum() Returns the medium enumeration value.
ObjectiveData	getObjective() Returns the objective used to capture the image.
long	getObjectiveSettingsId() Returns the id of the Objective settings or -1 if not already linked to the image.
Object	getPositionX() Deprecated. Replaced by getPositionX(UnitsLength)
omero.model.Length	getPositionX(omero.model.enums.UnitsLength unit) Returns the x-coordinate in the frame microscope.
Object	getPositionY() Deprecated. Replaced by getPositionY(UnitsLength)
omero.model.Length	getPositionY(omero.model.enums.UnitsLength unit) Returns the y-coordinate in the frame microscope.
Object	getPositionZ() Deprecated. Replaced by getPositionZ(UnitsLength)
omero.model.Length	getPositionZ(omero.model.enums.UnitsLength unit) Returns the z-coordinate in the frame microscope.
double	getRefractiveIndex() Returns the refractive index of the objective.
long	getStageLabelId() Returns the id of the StageLabel or -1 if not already linked to the image.
Object	getTemperature() Deprecated. Replaced by getTemperature(UnitsTemperature)
omero.model.Temperature	getTemperature(omero.model.enums.UnitsTemperature unit) Returns the temperature.
boolean	isImagingEnvironmentDirty() Returns true if the StageLabel has been updated, false otherwise.
boolean	isObjectiveSettingsDirty() Returns true if the objective settings has been updated, false otherwise.
boolean	isStageLabelDirty() Returns true if the position has been updated, false otherwise.
void	setAirPressure(double pressure) Deprecated. Replaced by setAirPressure(Pressure)
void	setAirPressure(omero.model.Pressure pressure) Sets the air pressure.
void	setCo2Percent(double co2) Sets the co2 level.
void	setCorrectionCollar(double correction) Sets the correction of the objective.
void	setHumidity(double humidity) Sets the humidity.
void	setLabelName(String name) Sets the name of the stage label.
void	setMedium(omero.model.Medium medium) Sets the medium of the objective.
void	setPositionX(double value) Deprecated. Replaced by setPositionX(Length)
void	setPositionX(omero.model.Length value) Sets the x-position.
void	setPositionY(double value) Deprecated. Replaced by setPositionY(Length)
void	setPositionY(omero.model.Length value) Sets the y-position.
void	setPositionZ(double value) Deprecated. Replaced by setPositionZ(Length)
void	setPositionZ(omero.model.Length value) Sets the z-position.
void	setRefractiveIndex(double index) Sets the refractive index of the objective.
void	setTemperature(double temperature) Deprecated. Replaced by setTemperature(Temperature)
void	setTemperature(omero.model.Temperature temperature) Sets the temperature.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageAcquisitionData

public ImageAcquisitionData(omero.model.Image image)

Creates a new instance.

Parameters:

image - The image the acquisition data is related to. Mustn't be null.

Method Detail

getObjective

public ObjectiveData getObjective()

Returns the objective used to capture the image.

Returns:

See above.

getLabelName

public String getLabelName()

Returns the name of the stage label.

Returns:

See above.

getPositionX

public omero.model.Length getPositionX(omero.model.enums.UnitsLength unit)
                                throws BigResult

Returns the x-coordinate in the frame microscope.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getPositionX

@Deprecated
public Object getPositionX()

Deprecated. Replaced by getPositionX(UnitsLength)

Returns the x-coordinate in the frame microscope.

Returns:

See above.

getPositionY

public omero.model.Length getPositionY(omero.model.enums.UnitsLength unit)
                                throws BigResult

Returns the y-coordinate in the frame microscope.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getPositionY

@Deprecated
public Object getPositionY()

Deprecated. Replaced by getPositionY(UnitsLength)

Returns the y-coordinate in the frame microscope.

Returns:

See above.

getPositionZ

public omero.model.Length getPositionZ(omero.model.enums.UnitsLength unit)
                                throws BigResult

Returns the z-coordinate in the frame microscope.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getPositionZ

@Deprecated
public Object getPositionZ()

Deprecated. Replaced by getPositionZ(UnitsLength)

Returns the z-coordinate in the frame microscope.

Returns:

See above.

getTemperature

public omero.model.Temperature getTemperature(omero.model.enums.UnitsTemperature unit)
                                       throws BigResult

Returns the temperature.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getTemperature

@Deprecated
public Object getTemperature()

Deprecated. Replaced by getTemperature(UnitsTemperature)

Returns the temperature.

Returns:

See above.

getAirPressure

public omero.model.Pressure getAirPressure(omero.model.enums.UnitsPressure unit)
                                    throws BigResult

Returns the air pressure.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getAirPressure

@Deprecated
public double getAirPressure()

Deprecated. Replaced by getAirPressure(UnitsPressure)

Returns the air pressure.

Returns:

See above.

getHumidity

public double getHumidity()

Returns the humidity level, this is a value in the interval [0, 1].

Returns:

See above.

getCo2Percent

public double getCo2Percent()

Returns the Co2 level, this is a percent value in the interval [0, 1].

Returns:

See above.

getCorrectionCollar

public double getCorrectionCollar()

Returns the correction collar of the objective.

Returns:

See above.

getRefractiveIndex

public double getRefractiveIndex()

Returns the refractive index of the objective.

Returns:

See above.

getMedium

public String getMedium()

Returns the medium of the objective.

Returns:

See above.

setLabelName

public void setLabelName(String name)

Sets the name of the stage label.

Parameters:

name - The value to set.

setPositionX

public void setPositionX(omero.model.Length value)

Sets the x-position.

Parameters:

value - The value to set.

setPositionX

@Deprecated
public void setPositionX(double value)

Deprecated. Replaced by setPositionX(Length)

Sets the x-position.

Parameters:

value - The value to set.

setPositionY

public void setPositionY(omero.model.Length value)

Sets the y-position.

Parameters:

value - The value to set.

setPositionY

@Deprecated
public void setPositionY(double value)

Deprecated. Replaced by setPositionY(Length)

Sets the y-position.

Parameters:

value - The value to set.

setPositionZ

public void setPositionZ(omero.model.Length value)

Sets the z-position.

Parameters:

value - The value to set.

setPositionZ

@Deprecated
public void setPositionZ(double value)

Deprecated. Replaced by setPositionZ(Length)

Sets the z-position.

Parameters:

value - The value to set.

setTemperature

public void setTemperature(omero.model.Temperature temperature)

Sets the temperature.

Parameters:

temperature - The value to set.

setTemperature

@Deprecated
public void setTemperature(double temperature)

Deprecated. Replaced by setTemperature(Temperature)

Sets the temperature.

Parameters:

temperature - The value to set.

setAirPressure

public void setAirPressure(omero.model.Pressure pressure)

Sets the air pressure.

Parameters:

pressure - The value to set.

setAirPressure

@Deprecated
public void setAirPressure(double pressure)

Deprecated. Replaced by setAirPressure(Pressure)

Sets the air pressure.

Parameters:

pressure - The value to set.

setHumidity

public void setHumidity(double humidity)

Sets the humidity.

Parameters:

humidity - The value to set.

setCo2Percent

public void setCo2Percent(double co2)

Sets the co2 level.

Parameters:

co2 - The value to set.

setCorrectionCollar

public void setCorrectionCollar(double correction)

Sets the correction of the objective.

Parameters:

correction - The value to set.

setRefractiveIndex

public void setRefractiveIndex(double index)

Sets the refractive index of the objective.

Parameters:

index - The value to set.

setMedium

public void setMedium(omero.model.Medium medium)

Sets the medium of the objective.

Parameters:

medium - The value to set.

isStageLabelDirty

public boolean isStageLabelDirty()

Returns true if the position has been updated, false otherwise.

Returns:

See above.

isImagingEnvironmentDirty

public boolean isImagingEnvironmentDirty()

Returns true if the StageLabel has been updated, false otherwise.

Returns:

See above.

isObjectiveSettingsDirty

public boolean isObjectiveSettingsDirty()

Returns true if the objective settings has been updated, false otherwise.

Returns:

See above.

getStageLabelId

public long getStageLabelId()

Returns the id of the StageLabel or -1 if not already linked to the image.

Returns:

See above

getImagingEnvironmentId

public long getImagingEnvironmentId()

Returns the id of the StageLabel or -1 if not already linked to the image.

Returns:

See above

getObjectiveSettingsId

public long getObjectiveSettingsId()

Returns the id of the Objective settings or -1 if not already linked to the image.

Returns:

See above

getMediumAsEnum

public omero.model.Medium getMediumAsEnum()

Returns the medium enumeration value.

Returns:

See above.