ImageAcquisitionData (omero-gateway 5.9.0 API)

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`java.lang.String`	`getLabelName()` Returns the name of the stage label.
`java.lang.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.
`omero.model.Length`	`getPositionX(omero.model.enums.UnitsLength unit)` Returns the x-coordinate in the frame microscope.
`omero.model.Length`	`getPositionY(omero.model.enums.UnitsLength unit)` Returns the y-coordinate in the frame microscope.
`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.
`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(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(java.lang.String name)` Sets the name of the stage label.
`void`	`setMedium(omero.model.Medium medium)` Sets the medium of the objective.
`void`	`setPositionX(omero.model.Length value)` Sets the x-position.
`void`	`setPositionY(omero.model.Length value)` Sets the y-position.
`void`	`setPositionZ(omero.model.Length value)` Sets the z-position.
`void`	`setRefractiveIndex(double index)` Sets the refractive index of the objective.
`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, asPlaneInfo, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, 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 java.lang.String getLabelName()
```
    Returns the name of the stage label.
    
    Returns:
    
    See above.
  - getPositionX
```
public omero.model.Length getPositionX(omero.model.enums.UnitsLength unit)
                                throws ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getPositionY
```
public omero.model.Length getPositionY(omero.model.enums.UnitsLength unit)
                                throws ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getPositionZ
```
public omero.model.Length getPositionZ(omero.model.enums.UnitsLength unit)
                                throws ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getTemperature
```
public omero.model.Temperature getTemperature(omero.model.enums.UnitsTemperature unit)
                                       throws ome.model.units.BigResult
```
    Returns the temperature.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above.
    
    Throws:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getAirPressure
```
public omero.model.Pressure getAirPressure(omero.model.enums.UnitsPressure unit)
                                    throws ome.model.units.BigResult
```
    Returns the air pressure.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above.
    
    Throws:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - 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 java.lang.String getMedium()
```
    Returns the medium of the objective.
    
    Returns:
    
    See above.
  - setLabelName
```
public void setLabelName(java.lang.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.
  - setPositionY
```
public void setPositionY(omero.model.Length value)
```
    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.
  - setTemperature
```
public void setTemperature(omero.model.Temperature 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.
  - 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.

Class ImageAcquisitionData

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Constructor Detail

ImageAcquisitionData

Method Detail

getObjective

getLabelName

getPositionX

getPositionY

getPositionZ

getTemperature

getAirPressure

getHumidity

getCo2Percent

getCorrectionCollar

getRefractiveIndex

getMedium

setLabelName

setPositionX

setPositionY

setPositionZ

setTemperature

setAirPressure

setHumidity

setCo2Percent

setCorrectionCollar

setRefractiveIndex

setMedium

isStageLabelDirty

isImagingEnvironmentDirty

isObjectiveSettingsDirty

getStageLabelId

getImagingEnvironmentId

getObjectiveSettingsId

getMediumAsEnum