pojos

Class ChannelAcquisitionData

java.lang.Object

pojos.DataObject

pojos.ChannelAcquisitionData

public class ChannelAcquisitionData
extends DataObject

Object hosting the acquisition related to a logical channel.

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

Constructors

Constructor and Description
ChannelAcquisitionData(omero.model.LogicalChannel channel) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContrastMethod() Returns the contrast method.
DetectorData	getDetector() Returns the detector used for that channel.
omero.model.Binning	getDetectorBinningAsEnum() Returns the binning enumeration value.
String	getDetectorSettingsBinning() Returns the Binning factor.
Double	getDetectorSettingsGain() Returns the gain set on the detector.
Double	getDetectorSettingsOffset() Returns the offset set on the detector.
Double	getDetectorSettingsReadOutRate() Deprecated. Replaced by getDetectorSettingsReadOutRate(UnitsFrequency)
omero.model.Frequency	getDetectorSettingsReadOutRate(omero.model.enums.UnitsFrequency unit) Returns the Read out rate set on the detector.
Double	getDetectorSettingsVoltage() Deprecated. Replaced by getDetectorSettingsVoltage(UnitsElectricPotential)
omero.model.ElectricPotential	getDetectorSettingsVoltage(omero.model.enums.UnitsElectricPotential unit) Returns the voltage set on the detector.
FilterSetData	getFilterSet() Returns the filter set or null.
String	getIllumination() Returns the illumination.
LightPathData	getLightPath() Returns the light path or null.
Double	getLightSettingsAttenuation() Returns the attenuation of the light source, percent value between 0 and 1.
Double	getLightSettingsWavelength() Deprecated. Replaced by getLightSettingsWavelength(UnitsLength)
omero.model.Length	getLightSettingsWavelength(omero.model.enums.UnitsLength unit) Returns the wavelength of the light source.
LightSourceData	getLightSource() Returns the source of light.
String	getMode() Returns the mode.
OTFData	getOTF() Returns the OTF used for that channel.
boolean	hasDectector() Returns true if there is a detector for that channel, false otherwise.
boolean	hasFilter() Returns true if there is a filter set linked to the channel false otherwise.
boolean	hasLightPath() Returns true if there is a light path described for that channel, false otherwise.
boolean	isDetectorSettingsDirty() Returns true if the detector settings has been updated, false otherwise.
boolean	isLightSourceSettingsDirty() Returns true if the light source settings has been updated, false otherwise.
void	setDetectorSettingBinning(omero.model.Binning binning) Sets the detector's binning.
void	setDetectorSettingOffset(double value) Sets the detector's setting offset.
void	setDetectorSettingsGain(double value) Sets the detector setting's gain.
void	setDetectorSettingsReadOutRate(double value) Deprecated. Replaced by setDetectorSettingsReadOutRate(Frequency)
void	setDetectorSettingsReadOutRate(omero.model.Frequency value) Sets the detector setting's read out rate.
void	setDetectorSettingsVoltage(double value) Deprecated. Replaced by setDetectorSettingsVoltage(ElectricPotential)
void	setDetectorSettingsVoltage(omero.model.ElectricPotential value) Sets the detector setting's voltage.
void	setLightSettingsAttenuation(double value) Sets the attenuation of the light settings.
void	setLightSettingsWavelength(double value) Deprecated. Replaced by setLightSettingsWavelength(Length)
void	setLightSettingsWavelength(omero.model.Length value) Sets the wavelength of the light source.
void	setLightSource(LightSourceData lightSource) Sets the light source associated to the settings.

Methods inherited from class pojos.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, 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

ChannelAcquisitionData

public ChannelAcquisitionData(omero.model.LogicalChannel channel)

Creates a new instance.

Parameters:

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

Method Detail

getDetector

public DetectorData getDetector()

Returns the detector used for that channel.

Returns:

See above.

getOTF

public OTFData getOTF()

Returns the OTF used for that channel.

Returns:

See above.

getDetectorSettingsOffset

public Double getDetectorSettingsOffset()

Returns the offset set on the detector.

Returns:

See above.

getDetectorSettingsGain

public Double getDetectorSettingsGain()

Returns the gain set on the detector.

Returns:

See above.

getDetectorSettingsVoltage

public omero.model.ElectricPotential getDetectorSettingsVoltage(omero.model.enums.UnitsElectricPotential unit)
                                                         throws BigResult

Returns the voltage set on the detector.

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

getDetectorSettingsVoltage

@Deprecated
public Double getDetectorSettingsVoltage()

Deprecated. Replaced by getDetectorSettingsVoltage(UnitsElectricPotential)

Returns the voltage set on the detector.

Returns:

See above.

getDetectorSettingsReadOutRate

public omero.model.Frequency getDetectorSettingsReadOutRate(omero.model.enums.UnitsFrequency unit)
                                                     throws BigResult

Returns the Read out rate set on the detector.

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

getDetectorSettingsReadOutRate

@Deprecated
public Double getDetectorSettingsReadOutRate()

Deprecated. Replaced by getDetectorSettingsReadOutRate(UnitsFrequency)

Returns the Read out rate set on the detector.

Returns:

See above.

getDetectorSettingsBinning

public String getDetectorSettingsBinning()

Returns the Binning factor.

Returns:

See above.

getLightSettingsAttenuation

public Double getLightSettingsAttenuation()

Returns the attenuation of the light source, percent value between 0 and 1.

Returns:

See above.

getLightSettingsWavelength

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

Returns the wavelength of the light source.

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

getLightSettingsWavelength

@Deprecated
public Double getLightSettingsWavelength()

Deprecated. Replaced by getLightSettingsWavelength(UnitsLength)

Returns the wavelength of the light source.

Returns:

See above.

hasFilter

public boolean hasFilter()

Returns true if there is a filter set linked to the channel false otherwise.

Returns:

See above.

hasLightPath

public boolean hasLightPath()

Returns true if there is a light path described for that channel, false otherwise.

Returns:

See above.

hasDectector

public boolean hasDectector()

Returns true if there is a detector for that channel, false otherwise.

Returns:

See above.

setLightSettingsAttenuation

public void setLightSettingsAttenuation(double value)

Sets the attenuation of the light settings.

Parameters:

value - The value to set.

setLightSettingsWavelength

public void setLightSettingsWavelength(omero.model.Length value)

Sets the wavelength of the light source.

Parameters:

value - The value to set.

setLightSettingsWavelength

@Deprecated
public void setLightSettingsWavelength(double value)

Deprecated. Replaced by setLightSettingsWavelength(Length)

Sets the wavelength of the light source.

Parameters:

value - The value to set.

setDetectorSettingOffset

public void setDetectorSettingOffset(double value)

Sets the detector's setting offset.

Parameters:

value - The value to set.

setDetectorSettingsGain

public void setDetectorSettingsGain(double value)

Sets the detector setting's gain.

Parameters:

value - The value to set.

setDetectorSettingsReadOutRate

public void setDetectorSettingsReadOutRate(omero.model.Frequency value)

Sets the detector setting's read out rate.

Parameters:

value - The value to set.

setDetectorSettingsReadOutRate

@Deprecated
public void setDetectorSettingsReadOutRate(double value)

Deprecated. Replaced by setDetectorSettingsReadOutRate(Frequency)

Sets the detector setting's read out rate.

Parameters:

value - The value to set.

setDetectorSettingsVoltage

public void setDetectorSettingsVoltage(omero.model.ElectricPotential value)

Sets the detector setting's voltage.

Parameters:

value - The value to set.

setDetectorSettingsVoltage

@Deprecated
public void setDetectorSettingsVoltage(double value)

Deprecated. Replaced by setDetectorSettingsVoltage(ElectricPotential)

Sets the detector setting's voltage.

Parameters:

value - The value to set.

setDetectorSettingBinning

public void setDetectorSettingBinning(omero.model.Binning binning)

Sets the detector's binning.

Parameters:

binning - The value to set.

getDetectorBinningAsEnum

public omero.model.Binning getDetectorBinningAsEnum()

Returns the binning enumeration value.

Returns:

See above.

isDetectorSettingsDirty

public boolean isDetectorSettingsDirty()

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

Returns:

See above.

isLightSourceSettingsDirty

public boolean isLightSourceSettingsDirty()

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

Returns:

See above.

getLightSource

public LightSourceData getLightSource()

Returns the source of light.

Returns:

See above.

setLightSource

public void setLightSource(LightSourceData lightSource)

Sets the light source associated to the settings.

Parameters:

lightSource - The value to set.

getLightPath

public LightPathData getLightPath()

Returns the light path or null.

Returns:

See above.

getFilterSet

public FilterSetData getFilterSet()

Returns the filter set or null.

Returns:

See above.

getIllumination

public String getIllumination()

Returns the illumination.

Returns:

See above.

getContrastMethod

public String getContrastMethod()

Returns the contrast method.

Returns:

See above.

getMode

public String getMode()

Returns the mode.

Returns:

See above.