pojos
Class ImageAcquisitionData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.ImageAcquisitionData

public class ImageAcquisitionData
extends DataObject

Object hosting the acquisition metadata.

Since:
3.0-Beta4
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Constructor Summary
ImageAcquisitionData(omero.model.Image image)
          Creates a new instance.
 
Method Summary
 double getAirPressure()
          Returns the air pressure in bar
 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()
          Returns the x-coordinate in the frame microscope.
 Object getPositionY()
          Returns the y-coordinate in the frame microscope.
 Object getPositionZ()
          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()
          Returns the temperature in Celcius.
 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)
          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)
          Sets the x-position.
 void setPositionY(double value)
          Sets the y-position.
 void setPositionZ(double value)
          Sets the z-position.
 void setRefractiveIndex(double index)
          Sets the refractive index of the objective.
 void setTemperature(double temperature)
          Sets the temperature.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, 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 Object getPositionX()
Returns the x-coordinate in the frame microscope.

Returns:
See above.

getPositionY

public Object getPositionY()
Returns the y-coordinate in the frame microscope.

Returns:
See above.

getPositionZ

public Object getPositionZ()
Returns the z-coordinate in the frame microscope.

Returns:
See above.

getTemperature

public Object getTemperature()
Returns the temperature in Celcius.

Returns:
See above.

getAirPressure

public double getAirPressure()
Returns the air pressure in bar

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(double value)
Sets the x-position.

Parameters:
value - The value to set.

setPositionY

public void setPositionY(double value)
Sets the y-position.

Parameters:
value - The value to set.

setPositionZ

public void setPositionZ(double value)
Sets the z-position.

Parameters:
value - The value to set.

setTemperature

public void setTemperature(double temperature)
Sets the temperature.

Parameters:
temperature - The value to set.

setAirPressure

public void setAirPressure(double 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.


OmeroJava Api

Version: Beta-4.1.1-r5927-b91

Copyright © 2009 The University of Dundee. All Rights Reserved.