Package ome.xml.model

Class Channel

All Implemented Interfaces:
OMEModelObject

public class Channel extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Channel

      public Channel()
      Default constructor.
    • Channel

      public Channel(Element element, OMEModel model) throws EnumerationException
      Constructs Channel recursively from an XML DOM tree.
      Parameters:
      element - Root of the XML DOM tree to construct a model object graph from.
      model - Handler for the OME model which keeps track of instances and references seen during object population.
      Throws:
      EnumerationException - If there is an error instantiating an enumeration during model object creation.
    • Channel

      public Channel(Channel orig)
      Copy constructor.
  • Method Details

    • update

      public void update(Element element, OMEModel model) throws EnumerationException
      Updates Channel recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
      Specified by:
      update in interface OMEModelObject
      Overrides:
      update in class AbstractOMEModelObject
      Parameters:
      element - Root of the XML DOM tree to construct a model object graph from.
      model - Handler for the OME model which keeps track of instances and references seen during object population.
      Throws:
      EnumerationException - If there is an error instantiating an enumeration during model object creation.
    • link

      public boolean link(Reference reference, OMEModelObject o)
      Description copied from interface: OMEModelObject
      Link a given OME model object to this model object.
      Specified by:
      link in interface OMEModelObject
      Overrides:
      link in class AbstractOMEModelObject
      Parameters:
      reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
      o - Model object to link to.
      Returns:
      true if this model object was able to handle the reference, false otherwise.
    • getID

      public String getID()
    • setID

      public void setID(String id)
    • getName

      public String getName()
    • setName

      public void setName(String name)
    • getSamplesPerPixel

      public PositiveInteger getSamplesPerPixel()
    • setSamplesPerPixel

      public void setSamplesPerPixel(PositiveInteger samplesPerPixel)
    • getIlluminationType

      public IlluminationType getIlluminationType()
    • setIlluminationType

      public void setIlluminationType(IlluminationType illuminationType)
    • getPinholeSize

      public Length getPinholeSize()
    • setPinholeSize

      public void setPinholeSize(Length pinholeSize)
    • getPinholeSizeUnitXsdDefault

      public static String getPinholeSizeUnitXsdDefault()
    • getAcquisitionMode

      public AcquisitionMode getAcquisitionMode()
    • setAcquisitionMode

      public void setAcquisitionMode(AcquisitionMode acquisitionMode)
    • getContrastMethod

      public ContrastMethod getContrastMethod()
    • setContrastMethod

      public void setContrastMethod(ContrastMethod contrastMethod)
    • getExcitationWavelength

      public Length getExcitationWavelength()
    • setExcitationWavelength

      public void setExcitationWavelength(Length excitationWavelength)
    • getExcitationWavelengthUnitXsdDefault

      public static String getExcitationWavelengthUnitXsdDefault()
    • getEmissionWavelength

      public Length getEmissionWavelength()
    • setEmissionWavelength

      public void setEmissionWavelength(Length emissionWavelength)
    • getEmissionWavelengthUnitXsdDefault

      public static String getEmissionWavelengthUnitXsdDefault()
    • getFluor

      public String getFluor()
    • setFluor

      public void setFluor(String fluor)
    • getNDFilter

      public Double getNDFilter()
    • setNDFilter

      public void setNDFilter(Double ndFilter)
    • getPockelCellSetting

      public Integer getPockelCellSetting()
    • setPockelCellSetting

      public void setPockelCellSetting(Integer pockelCellSetting)
    • getColor

      public Color getColor()
    • setColor

      public void setColor(Color color)
    • getLightSourceSettings

      public LightSourceSettings getLightSourceSettings()
    • setLightSourceSettings

      public void setLightSourceSettings(LightSourceSettings lightSourceSettings)
    • getDetectorSettings

      public DetectorSettings getDetectorSettings()
    • setDetectorSettings

      public void setDetectorSettings(DetectorSettings detectorSettings)
    • getLinkedFilterSet

      public FilterSet getLinkedFilterSet()
    • linkFilterSet

      public void linkFilterSet(FilterSet o)
    • unlinkFilterSet

      public void unlinkFilterSet(FilterSet o)
    • sizeOfLinkedAnnotationList

      public int sizeOfLinkedAnnotationList()
    • copyLinkedAnnotationList

      public List<Annotation> copyLinkedAnnotationList()
    • getLinkedAnnotation

      public Annotation getLinkedAnnotation(int index)
    • setLinkedAnnotation

      public Annotation setLinkedAnnotation(int index, Annotation o)
    • linkAnnotation

      public boolean linkAnnotation(Annotation o)
    • unlinkAnnotation

      public boolean unlinkAnnotation(Annotation o)
    • getLightPath

      public LightPath getLightPath()
    • setLightPath

      public void setLightPath(LightPath lightPath)
    • getPixels

      public Pixels getPixels()
    • setPixels

      public void setPixels(Pixels pixels_BackReference)
    • asXMLElement

      public Element asXMLElement(Document document)
      Description copied from interface: OMEModelObject
      Takes the entire object hierarchy and produces an XML DOM tree.
      Specified by:
      asXMLElement in interface OMEModelObject
      Specified by:
      asXMLElement in class AbstractOMEModelObject
      Parameters:
      document - Destination document for element creation, etc.
      Returns:
      XML DOM tree root element for this model object.
    • asXMLElement

      public Element asXMLElement(Document document, Element Channel_element)
      Description copied from class: AbstractOMEModelObject
      Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
      Overrides:
      asXMLElement in class AbstractOMEModelObject
      Parameters:
      document - Destination document for element creation, etc.
      Channel_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.