pojos
Class ChannelAcquisitionData

java.lang.Object
  extended by pojos.DataObject
      extended by 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
ChannelAcquisitionData(omero.model.LogicalChannel channel)
          Creates a new instance.
 
Method Summary
 DetectorData getDetector()
          Returns the detector used for that channel.
 omero.model.Binning getDetectorBinningAsEnum()
          Returns the binning enumeration value.
 String getDetectorSettingsBinning()
          Returns the binning.
 Double getDetectorSettingsGain()
          Returns the gain set on the detector.
 Double getDetectorSettingsOffset()
          Returns the offset set on the detector.
 Double getDetectorSettingsReadOutRate()
          Returns the Read out rate set on the detector.
 Double getDetectorSettingsVoltage()
          Returns the voltage set on the detector.
 DichroicData getDichroic()
          Returns the dichroic.
 FilterData getEmissionFilter()
          Returns the emission filter.
 FilterData getExcitationFilter()
          Returns the excitation filter.
 LightSourceData getLightSource()
          Returns the source of light.
 Double getLigthSettingsAttenuation()
          Returns the attenuation of the light source, percent value between 0 and 1.
 Integer getLigthSettingsWavelength()
          Returns the wavelength of the light source.
 FilterData getSecondaryEmissionFilter()
          Returns the secondary emission filter.
 FilterData getSecondaryExcitationFilter()
          Returns the secondary excitation filter.
 boolean hasDectector()
          Returns true if there is a detector for that channel, false otherwise.
 boolean hasFilter()
          Returns true if there is an filter 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)
          Sets the detector setting's read out rate.
 void setDetectorSettingsVoltage(double value)
          Sets the detector setting's voltage.
 void setLigthSettingsAttenuation(double value)
          Sets the attenuation of the light settings.
 void setLigthSettingsWavelength(int value)
          Returns the wavelength of the light source.
 
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

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

getEmissionFilter

public FilterData getEmissionFilter()
Returns the emission filter.

Returns:
See above.

getExcitationFilter

public FilterData getExcitationFilter()
Returns the excitation filter.

Returns:
See above.

getDichroic

public DichroicData getDichroic()
Returns the dichroic.

Returns:
See above.

getDetector

public DetectorData getDetector()
Returns the detector 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 Double getDetectorSettingsVoltage()
Returns the voltage set on the detector.

Returns:
See above.

getDetectorSettingsReadOutRate

public Double getDetectorSettingsReadOutRate()
Returns the Read out rate set on the detector.

Returns:
See above.

getDetectorSettingsBinning

public String getDetectorSettingsBinning()
Returns the binning.

Returns:
See above.

getLigthSettingsAttenuation

public Double getLigthSettingsAttenuation()
Returns the attenuation of the light source, percent value between 0 and 1.

Returns:
See above.

getLigthSettingsWavelength

public Integer getLigthSettingsWavelength()
Returns the wavelength of the light source.

Returns:
See above.

getSecondaryEmissionFilter

public FilterData getSecondaryEmissionFilter()
Returns the secondary emission filter.

Returns:
See above.

getSecondaryExcitationFilter

public FilterData getSecondaryExcitationFilter()
Returns the secondary excitation filter.

Returns:
See above.

hasFilter

public boolean hasFilter()
Returns true if there is an filter 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.

setLigthSettingsAttenuation

public void setLigthSettingsAttenuation(double value)
Sets the attenuation of the light settings.

Parameters:
value - The value to set.

setLigthSettingsWavelength

public void setLigthSettingsWavelength(int value)
Returns 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(double value)
Sets the detector setting's read out rate.

Parameters:
value - The value to set.

setDetectorSettingsVoltage

public void setDetectorSettingsVoltage(double value)
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.


OmeroJava Api

Version: Beta-4.1.1-r5927-b91

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