pojos
Class ChannelData

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

public class ChannelData
extends DataObject

The data that makes up an OME Channel along with links to its 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

Field Summary
static String ANNOTATIONS
          Identifies the Channel#ANNOTATIONLINKS field.
 
Constructor Summary
ChannelData(int index)
          Creates a new instance.
ChannelData(int index, omero.model.Channel channel)
          Creates a new instance.
 
Method Summary
 String getChannelLabeling()
          Returns the label of the channel.
 String getContrastMethod()
          Returns the contrast method.
 omero.model.ContrastMethod getContrastMethodAsEnum()
          Returns the contrast method enumeration value.
 int getEmissionWavelength()
          Returns the emission wavelength of the channel.
 int getExcitationWavelength()
          Returns the excitation wavelength of the channel.
 String getFluor()
          Returns the Fluorophore used.
 double getGlobalMax()
          Returns the global maximum of the channel i.e. the maximum of all maxima.
 double getGlobalMin()
          Returns the global minimum of the channel i.e. the minimum of all minima.
 String getIllumination()
          Returns the illumination.
 omero.model.Illumination getIlluminationAsEnum()
          Returns the illumination enumeration value.
 int getIndex()
          Returns the channel's index.
 String getMode()
          Returns the mode.
 omero.model.AcquisitionMode getModeAsEnum()
          Returns the acquisition enumeration value.
 String getName()
          Returns the name of the channel.
 double getNDFilter()
          Returns the ND filter wavelength of the channel.
 double getPinholeSize()
          Returns the pin hole size of the channel.
 int getPockelCell()
          Returns the Pockels cell settings.
 void setContrastMethod(omero.model.ContrastMethod contrastMethod)
          Sets the contrast method value.
 void setEmissionWavelength(int value)
          Sets the emission wavelength.
 void setExcitationWavelength(int value)
          Sets the excitation wavelength.
 void setFluor(String value)
          Sets the fluor.
 void setIllumination(omero.model.Illumination illumination)
          Sets the illumination value.
 void setMode(omero.model.AcquisitionMode mode)
          Sets the acquisition mode value.
 void setName(String name)
          Sets the name of the logical channel.
 void setNDFilter(double value)
          Sets the ND filter.
 void setPinholeSize(double value)
          Sets the pinhole size.
 void setPockelCell(int value)
          Sets the pockel cell.
 
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
 

Field Detail

ANNOTATIONS

public static final String ANNOTATIONS
Identifies the Channel#ANNOTATIONLINKS field.

See Also:
Constant Field Values
Constructor Detail

ChannelData

public ChannelData(int index)
Creates a new instance.

Parameters:
index - The index of the channel.

ChannelData

public ChannelData(int index,
                   omero.model.Channel channel)
Creates a new instance.

Parameters:
index - The index of the channel.
channel - Back pointer to the Channel model object. Mustn't be null.
Throws:
IllegalArgumentException - If the object is null.
Method Detail

getIndex

public int getIndex()
Returns the channel's index.

Returns:
See above.

getChannelLabeling

public String getChannelLabeling()
Returns the label of the channel. Following the specification: Name>Fluor>Emission wavelength>index.

Returns:
See above.

setName

public void setName(String name)
Sets the name of the logical channel.

Parameters:
name - The name of the channel.

getName

public String getName()
Returns the name of the channel.

Returns:
See above.

getEmissionWavelength

public int getEmissionWavelength()
Returns the emission wavelength of the channel.

Returns:
See above

getExcitationWavelength

public int getExcitationWavelength()
Returns the excitation wavelength of the channel.

Returns:
See above

getPinholeSize

public double getPinholeSize()
Returns the pin hole size of the channel.

Returns:
See above

getNDFilter

public double getNDFilter()
Returns the ND filter wavelength of the channel.

Returns:
See above

getFluor

public String getFluor()
Returns the Fluorophore used.

Returns:
See above.

getPockelCell

public int getPockelCell()
Returns the Pockels cell settings.

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.

getGlobalMin

public double getGlobalMin()
Returns the global minimum of the channel i.e. the minimum of all minima.

Returns:
See above.

getGlobalMax

public double getGlobalMax()
Returns the global maximum of the channel i.e. the maximum of all maxima.

Returns:
See above.

setPinholeSize

public void setPinholeSize(double value)
Sets the pinhole size.

Parameters:
value - The value to set.

setNDFilter

public void setNDFilter(double value)
Sets the ND filter.

Parameters:
value - The value to set.

setFluor

public void setFluor(String value)
Sets the fluor.

Parameters:
value - The value to set.

setEmissionWavelength

public void setEmissionWavelength(int value)
Sets the emission wavelength.

Parameters:
value - The value to set.

setExcitationWavelength

public void setExcitationWavelength(int value)
Sets the excitation wavelength.

Parameters:
value - The value to set.

setPockelCell

public void setPockelCell(int value)
Sets the pockel cell.

Parameters:
value - The value to set.

setIllumination

public void setIllumination(omero.model.Illumination illumination)
Sets the illumination value.

Parameters:
illumination - The value to set.

setMode

public void setMode(omero.model.AcquisitionMode mode)
Sets the acquisition mode value.

Parameters:
mode - The value to set.

setContrastMethod

public void setContrastMethod(omero.model.ContrastMethod contrastMethod)
Sets the contrast method value.

Parameters:
contrastMethod - The value to set.

getModeAsEnum

public omero.model.AcquisitionMode getModeAsEnum()
Returns the acquisition enumeration value.

Returns:
See above.

getIlluminationAsEnum

public omero.model.Illumination getIlluminationAsEnum()
Returns the illumination enumeration value.

Returns:
See above.

getContrastMethodAsEnum

public omero.model.ContrastMethod getContrastMethodAsEnum()
Returns the contrast method enumeration value.

Returns:
See above.


OmeroJava Api

Version: Beta4.2.1-r8614-Beta4.2-b41

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