ChannelData (omero-gateway 5.9.1 API)

java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ANNOTATIONS
Identifies the Channel.ANNOTATIONLINKS field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANNOTATIONS` Identifies the `Channel.ANNOTATIONLINKS` field.

Constructor Summary

Constructors
Constructor and Description

ChannelData(int index)
Creates a new instance.

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

Constructors
Constructor and Description
`ChannelData(int index)` Creates a new instance.
`ChannelData(int index, omero.model.Channel channel)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getChannelLabeling()` Returns the label of the channel.
`java.lang.String`	`getContrastMethod()` Returns the contrast method.
`omero.model.ContrastMethod`	`getContrastMethodAsEnum()` Returns the contrast method enumeration value.
`omero.model.Length`	`getEmissionWavelength(omero.model.enums.UnitsLength unit)` Returns the emission wavelength of the channel.
`omero.model.Length`	`getExcitationWavelength(omero.model.enums.UnitsLength unit)` Returns the excitation wavelength of the channel.
`java.lang.String`	`getFluor()` Returns the Fluorophore used.
`double`	`getGlobalMax()` Returns the global maximum of the channel i.e.
`double`	`getGlobalMin()` Returns the global minimum of the channel i.e.
`java.lang.String`	`getIllumination()` Returns the illumination.
`omero.model.Illumination`	`getIlluminationAsEnum()` Returns the illumination enumeration value.
`int`	`getIndex()` Returns the channel's index.
`java.lang.String`	`getMode()` Returns the mode.
`omero.model.AcquisitionMode`	`getModeAsEnum()` Returns the acquisition enumeration value.
`java.lang.String`	`getName()` Returns the name of the channel.
`double`	`getNDFilter()` Returns the ND filter wavelength of the channel.
`omero.model.Length`	`getPinholeSize(omero.model.enums.UnitsLength unit)` Returns the pin hole size of the channel.
`int`	`getPockelCell()` Returns the Pockel cell settings.
`boolean`	`hasStats()` Returns `true` if the channel has some channel information `false` otherwise.
`void`	`setContrastMethod(omero.model.ContrastMethod contrastMethod)` Sets the contrast method value.
`void`	`setEmissionWavelength(omero.model.Length value)` Sets the emission wavelength.
`void`	`setExcitationWavelength(omero.model.Length value)` Sets the excitation wavelength.
`void`	`setFluor(java.lang.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(java.lang.String name)` Sets the name of the logical channel.
`void`	`setNDFilter(double value)` Sets the ND filter.
`void`	`setPinholeSize(omero.model.Length value)` Sets the pinhole size.
`void`	`setPockelCell(int value)` Sets the pockel cell.

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

- Field Detail
  - ANNOTATIONS
```
public static final java.lang.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:
    
    java.lang.IllegalArgumentException - If the object is null.
- Method Detail
  - getIndex
```
public int getIndex()
```
    Returns the channel's index.
    
    Returns:
    
    See above.
  - getChannelLabeling
```
public java.lang.String getChannelLabeling()
```
    Returns the label of the channel. Following the specification: Name→Fluor→Emission wavelength→index.
    
    Returns:
    
    See above.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the logical channel.
    
    Parameters:
    
    name - The name of the channel.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the channel.
    
    Returns:
    
    See above.
  - getEmissionWavelength
```
public omero.model.Length getEmissionWavelength(omero.model.enums.UnitsLength unit)
                                         throws ome.model.units.BigResult
```
    Returns the emission wavelength of the channel. param 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
  - getExcitationWavelength
```
public omero.model.Length getExcitationWavelength(omero.model.enums.UnitsLength unit)
                                           throws ome.model.units.BigResult
```
    Returns the excitation wavelength of the channel.
    
    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
  - getPinholeSize
```
public omero.model.Length getPinholeSize(omero.model.enums.UnitsLength unit)
                                  throws ome.model.units.BigResult
```
    Returns the pin hole size of the channel.
    
    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
  - getNDFilter
```
public double getNDFilter()
```
    Returns the ND filter wavelength of the channel.
    
    Returns:
    
    See above
  - getFluor
```
public java.lang.String getFluor()
```
    Returns the Fluorophore used.
    
    Returns:
    
    See above.
  - getPockelCell
```
public int getPockelCell()
```
    Returns the Pockel cell settings.
    
    Returns:
    
    See above.
  - getIllumination
```
public java.lang.String getIllumination()
```
    Returns the illumination.
    
    Returns:
    
    See above.
  - getContrastMethod
```
public java.lang.String getContrastMethod()
```
    Returns the contrast method.
    
    Returns:
    
    See above.
  - getMode
```
public java.lang.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.
  - hasStats
```
public boolean hasStats()
```
    Returns true if the channel has some channel information false otherwise.
    
    Returns:
    
    See above.
  - setPinholeSize
```
public void setPinholeSize(omero.model.Length 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(java.lang.String value)
```
    Sets the fluor.
    
    Parameters:
    
    value - The value to set.
  - setEmissionWavelength
```
public void setEmissionWavelength(omero.model.Length value)
```
    Sets the emission wavelength.
    
    Parameters:
    
    value - The value to set.
  - setExcitationWavelength
```
public void setExcitationWavelength(omero.model.Length 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.

Class ChannelData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

ANNOTATIONS

Constructor Detail

ChannelData

ChannelData

Method Detail

getIndex

getChannelLabeling

setName

getName

getEmissionWavelength

getExcitationWavelength

getPinholeSize

getNDFilter

getFluor

getPockelCell

getIllumination

getContrastMethod

getMode

getGlobalMin

getGlobalMax

hasStats

setPinholeSize

setNDFilter

setFluor

setEmissionWavelength

setExcitationWavelength

setPockelCell

setIllumination

setMode

setContrastMethod

getModeAsEnum

getIlluminationAsEnum

getContrastMethodAsEnum