The OME element is a container for all information objects accessible by OME. These information objects include descriptions of the imaging experiments and the people who perform them, descriptions of the microscope, the resulting images and how they were acquired, the analyses performed on those images, and the analysis results themselves. An OME file may contain any or all of this information. With the creation of the Metadata Only Companion OME-XML and Binary Only OME-TIFF files the top level OME node has changed slightly. It can EITHER: Contain all the previously expected elements OR: Contain a single BinaryOnly element that points at its Metadata Only Companion OME-XML file.
This is the name of the creating application of the OME-XMLand preferably its full version.e.g "CompanyName, SoftwareName, V2.6.3456"This is optional but we hope it will be set by applicationswriting out OME-XML from scratch.
This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.
Source
<xsd:element name="OME"><!-- top level definition --><xsd:annotation><xsd:documentation>The OME element is a container for all information objects accessible by OME. These information objects include descriptions of the imaging experiments and the people who perform them, descriptions of the microscope, the resulting images and how they were acquired, the analyses performed on those images, and the analysis results themselves. An OME file may contain any or all of this information. With the creation of the Metadata Only Companion OME-XML and Binary Only OME-TIFF files the top level OME node has changed slightly. It can EITHER: Contain all the previously expected elements OR: Contain a single BinaryOnly element that points at its Metadata Only Companion OME-XML file.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="Rights" minOccurs="0" maxOccurs="1"/><xsd:choice><!-- Either: standard expected elements --><xsd:sequence><xsd:element ref="Project" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Dataset" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Experiment" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="SPW:Plate" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="SPW:Screen" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Experimenter" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="ExperimenterGroup" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Instrument" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Image" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="SA:StructuredAnnotations" minOccurs="0" maxOccurs="1"/><xsd:element ref="ROI:ROI" minOccurs="0" maxOccurs="unbounded"/></xsd:sequence><!-- Or: Single BinaryOnly element --><xsd:element name="BinaryOnly" minOccurs="1" maxOccurs="1"><xsd:annotation><xsd:documentation>Pointer to an external metadata file. If this element is present, then no other metadata may be present in this file, i.e. this file is a place-holder.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:attribute name="MetadataFile" type="xsd:string" use="required"><xsd:annotation><xsd:documentation>Filename of the OME-XML metadata file for this binary data. If the file cannot be found, a search can be performed based on the UUID.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="UUID" type="UniversallyUniqueIdentifier" use="required"><xsd:annotation><xsd:documentation>The unique identifier of another OME-XML block whose metadata describes the binary data in this file. This UUID is considered authoritative regardless of mismatches in the filename.</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element><!-- End of MetadataOnly Element --></xsd:choice></xsd:sequence><xsd:attribute name="UUID" type="UniversallyUniqueIdentifier" use="optional"><xsd:annotation><xsd:documentation>This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Creator" type="xsd:string" use="optional"><xsd:annotation><xsd:documentation>This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType><!-- Unique IDs --><xsd:key name="ChannelIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="DatasetIDKey"><xsd:selector xpath="OME:Dataset"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="DetectorIDKey"><xsd:selector xpath="OME:Instrument/OME:Detector"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="DichroicIDKey"><xsd:selector xpath="OME:Instrument/OME:Dichroic"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ExperimentIDKey"><xsd:selector xpath="OME:Experiment"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ExperimenterIDKey"><xsd:selector xpath="OME:Experimenter"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="FilterIDKey"><xsd:selector xpath="OME:Instrument/OME:Filter"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="FilterSetIDKey"><xsd:selector xpath="OME:Instrument/OME:FilterSet"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ExperimenterGroupIDKey"><xsd:selector xpath="OME:ExperimenterGroup"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ImageIDKey"><xsd:selector xpath="OME:Image"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="InstrumentIDKey"><xsd:selector xpath="OME:Instrument"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="LightSourceIDKey"><xsd:selector xpath="OME:Instrument/OME:LightSource"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="MicrobeamManipulationIDKey"><xsd:selector xpath="OME:Experiment/OME:MicrobeamManipulation"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ObjectiveIDKey"><xsd:selector xpath="OME:Instrument/OME:Objective"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="PixelsIDKey"><xsd:selector xpath="OME:Image/OME:Pixels"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="PlateIDKey"><xsd:selector xpath="SPW:Plate"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ProjectIDKey"><xsd:selector xpath="OME:Project"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ReagentIDKey"><xsd:selector xpath="SPW:Screen/SPW:Reagent"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ScreenAcquisitionIDKey"><xsd:selector xpath="SPW:Screen/SPW:ScreenAcquisition"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ScreenIDKey"><xsd:selector xpath="SPW:Screen"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="WellIDKey"><xsd:selector xpath="SPW:Plate/SPW:Well"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="WellSampleIDKey"><xsd:selector xpath="SPW:Plate/SPW:Well/SPW:WellSample"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ROIIDKey"><xsd:selector xpath="ROI:ROI"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="ShapeIDKey"><xsd:selector xpath="ROI:ROI/ROI:Union/ROI:Shape"/><xsd:field xpath="@ID"/></xsd:key><xsd:key name="AnnotationIDKey"><xsd:selector xpath="SA:StructuredAnnotations/*"/><xsd:field xpath="@ID"/></xsd:key><!-- Unique references --><xsd:key name="WellSampleImageRefIDKey"><xsd:selector xpath="SPW:Plate/SPW:Well/SPW:WellSample/OME:ImageRef"/><xsd:field xpath="@ID"/></xsd:key><!-- Valid references --><xsd:keyref name="DatasetExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:Dataset/OME:ExperimenterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="DatasetExperimenterGroupIDKeyRef" refer="OME:ExperimenterGroupIDKey"><xsd:selector xpath="OME:Dataset/OME:ExperimenterGroupRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="DatasetProjectIDKeyRef" refer="OME:ProjectIDKey"><xsd:selector xpath="OME:Dataset/OME:ProjectRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimentExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:Experiment/OME:ExperimenterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimentMicrobeamManipulationExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:Experiment/OME:MicrobeamManipulation/OME:ExperimenterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimentMicrobeamManipulationLightSourceSettingsLightSourceIDKeyRef" refer="OME:LightSourceIDKey"><xsd:selector xpath="OME:Experiment/OME:MicrobeamManipulation/OME:LightSourceSettings"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimenterExperimenterGroupIDKeyRef" refer="OME:ExperimenterGroupIDKey"><xsd:selector xpath="OME:Experimenter/OME:ExperimenterGroupRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimenterGroupContactExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:ExperimenterGroup/OME:Contact"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimenterGroupLeaderExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:ExperimenterGroup/OME:Leader"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageDatasetIDKeyRef" refer="OME:DatasetIDKey"><xsd:selector xpath="OME:Image/OME:DatasetRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:Image/OME:ExperimenterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageExperimentIDKeyRef" refer="OME:ExperimentIDKey"><xsd:selector xpath="OME:Image/OME:ExperimentRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageExperimenterGroupIDKeyRef" refer="OME:ExperimenterGroupIDKey"><xsd:selector xpath="OME:Image/OME:ExperimenterGroupRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageInstrumentIDKeyRef" refer="OME:InstrumentIDKey"><xsd:selector xpath="OME:Image/OME:InstrumentRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageMicrobeamManipulationIDKeyRef" refer="OME:MicrobeamManipulationIDKey"><xsd:selector xpath="OME:Image/OME:MicrobeamManipulationRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageObjectiveSettingsObjectiveIDKeyRef" refer="OME:ObjectiveIDKey"><xsd:selector xpath="OME:Image/OME:ObjectiveSettings"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelDetectorSettingsDetectorIDKeyRef" refer="OME:DetectorIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:DetectorSettings"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelFilterSetIDKeyRef" refer="OME:FilterSetIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:FilterSetRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightPathExcitationFilterIDKeyRef" refer="OME:FilterIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightPath/OME:ExcitationFilterPath/OME:FilterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightPathExcitationDichroicIDKeyRef" refer="OME:DichroicIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightPath/OME:ExcitationFilterPath/OME:DichroicRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightPathDichroicIDKeyRef" refer="OME:DichroicIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightPath/OME:DichroicRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightPathEmissionFilterIDKeyRef" refer="OME:FilterIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightPath/OME:EmissionFilterPath/OME:FilterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightPathEmissionDichroicIDKeyRef" refer="OME:DichroicIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightPath/OME:EmissionFilterPath/OME:DichroicRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImagePixelsChannelLightSourceSettingsLightSourceIDKeyRef" refer="OME:LightSourceIDKey"><xsd:selector xpath="OME:Image/OME:Pixels/OME:Channel/OME:LightSourceSettings"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="InstrumentFilterSetExcitationFilterIDKeyRef" refer="OME:FilterIDKey"><xsd:selector xpath="OME:Instrument/OME:FilterSet/OME:ExcitationFilterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="InstrumentFilterSetDichroicIDKeyRef" refer="OME:DichroicIDKey"><xsd:selector xpath="OME:Instrument/OME:FilterSet/OME:DichroicRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="InstrumentFilterSetEmissionFilterIDKeyRef" refer="OME:FilterIDKey"><xsd:selector xpath="OME:Instrument/OME:FilterSet/OME:EmissionFilterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="InstrumentLightSourceLaserPumpLightSourceIDKey" refer="OME:LightSourceIDKey"><xsd:selector xpath="OME:Instrument/OME:LightSource/OME:Laser/OME:Pump"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="PlateScreenIDKeyRef" refer="OME:ScreenIDKey"><xsd:selector xpath="SPW:Plate/SPW:ScreenRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="PlateWellReagentIDKeyRef" refer="OME:ReagentIDKey"><xsd:selector xpath="SPW:Plate/SPW:Well/SPW:ReagentRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="PlateWellWellSampleImageIDKeyRef" refer="OME:ImageIDKey"><xsd:selector xpath="SPW:Plate/SPW:Well/SPW:WellSample/SPW:ImageRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ProjectExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="OME:Project/OME:ExperimenterRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ProjectExperimenterGroupIDKeyRef" refer="OME:ExperimenterGroupIDKey"><xsd:selector xpath="OME:Project/OME:ExperimenterGroupRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ScreenPlateIDKeyRef" refer="OME:PlateIDKey"><xsd:selector xpath="SPW:Screen/SPW:PlateRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ScreenScreenAcquisitionWellSampleIDKeyRef" refer="OME:WellSampleIDKey"><xsd:selector xpath="SPW:Screen/SPW:ScreenAcquisition/SPW:WellSampleRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ExperimentMicrobeamManipulationROIIDKeyRef" refer="OME:ROIIDKey"><xsd:selector xpath="OME:Experiment/OME:MicrobeamManipulation/ROI:ROIRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="ImageROIIDKeyRef" refer="OME:ROIIDKey"><xsd:selector xpath="OME:Image/ROI:ROIRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="AnnotationRefAnnotationIDKeyRef" refer="OME:AnnotationIDKey"><xsd:selector xpath=".//SA:AnnotationRef"/><xsd:field xpath="@ID"/></xsd:keyref><xsd:keyref name="AnnotationAnnotatorExperimenterIDKeyRef" refer="OME:ExperimenterIDKey"><xsd:selector xpath="SA:StructuredAnnotations/*"/><xsd:field xpath="@Annotator"/></xsd:keyref></xsd:element>
<xsd:element name="Rights"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Rights</plural></xsdfu></xsd:appinfo><xsd:documentation>The rights holder of this data and the rights held.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="RightsHolder" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The rights holder for this data. [plane text multi-line string] e.g. "Copyright (C) 2002 - 2016 Open Microscopy Environment"</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element name="RightsHeld" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The rights held by the rights holder. [plane text multi-line string] e.g. "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element></xsd:sequence></xsd:complexType></xsd:element>
The rights holder for this data. [plane text multi-line string]e.g. "Copyright (C) 2002 - 2016 Open Microscopy Environment"
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="RightsHolder" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The rights holder for this data. [plane text multi-line string] e.g. "Copyright (C) 2002 - 2016 Open Microscopy Environment"</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
The rights held by the rights holder. [plane text multi-line string] e.g. "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="RightsHeld" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The rights held by the rights holder. [plane text multi-line string] e.g. "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
The Project ID is required.Datasets can be grouped into projects using a many-to-many relationship.A Dataset may belong to one or more Projects by including one or more ProjectRef elements which refer to Project IDs.Projects do not directly contain images - only by virtue of containing datasets, which themselves contain images.
<xsd:element name="Project"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Projects</plural></xsdfu></xsd:appinfo><xsd:documentation>The Project ID is required. Datasets can be grouped into projects using a many-to-many relationship. A Dataset may belong to one or more Projects by including one or more ProjectRef elements which refer to Project IDs. Projects do not directly contain images - only by virtue of containing datasets, which themselves contain images.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the project. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="ExperimenterGroupRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="DatasetRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Name" use="optional" type="xsd:string"/><xsd:attribute name="ID" use="required" type="ProjectID"/></xsd:complexType></xsd:element>
A description for the project. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the project. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
<xsd:element name="ExperimenterRef"><!-- top level definition --><xsd:annotation><xsd:documentation>This empty element has a required Experimenter ID and an optional DocumentID attribute which refers to one of the Experimenters defined within OME.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="ExperimenterID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
<xsd:element name="ExperimenterGroupRef"><!-- top level definition --><xsd:annotation><xsd:documentation>This empty element has a reference (the ExperimenterGroup ID attribute) to a ExperimenterGroup defined within OME.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="ExperimenterGroupID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The DatasetRef element refers to a Dataset by specifying the Dataset ID attribute.One or more DatasetRef elements may be listed within the Image element to specify what Datasetsthe Image belongs to.
<xsd:element name="DatasetRef"><!-- top level definition --><xsd:annotation><xsd:documentation>The DatasetRef element refers to a Dataset by specifying the Dataset ID attribute. One or more DatasetRef elements may be listed within the Image element to specify what Datasets the Image belongs to.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="DatasetID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
An element specifying a collection of images that are always processed together.Images can belong to more than one Dataset, and a Dataset may contain more than one Image.Images contain one or more DatasetRef elements to specify what datasets they belong to.Once a Dataset has been processed in any way, its collection of images cannot be altered.The ExperimenterRef and ExperimenterGroupRef elements specify the person and group this Dataset belongs to.Projects may contain one or more Datasets, and Datasets may belong to one or more Projects.This relationship is specified by listing DatasetRef elements within the Project element.
A name for the dataset that is suitable be presented to the user.
Source
<xsd:element name="Dataset"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Datasets</plural></xsdfu></xsd:appinfo><xsd:documentation>An element specifying a collection of images that are always processed together. Images can belong to more than one Dataset, and a Dataset may contain more than one Image. Images contain one or more DatasetRef elements to specify what datasets they belong to. Once a Dataset has been processed in any way, its collection of images cannot be altered. The ExperimenterRef and ExperimenterGroupRef elements specify the person and group this Dataset belongs to. Projects may contain one or more Datasets, and Datasets may belong to one or more Projects. This relationship is specified by listing DatasetRef elements within the Project element.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the dataset. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="ExperimenterGroupRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="ImageRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Name" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>A name for the dataset that is suitable be presented to the user.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="ID" use="required" type="DatasetID"/></xsd:complexType></xsd:element>
A description for the dataset. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the dataset. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
<xsd:element name="ImageRef"><!-- top level definition --><xsd:annotation><xsd:documentation>The ImageRef element is a reference to a OME:Image element.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="ImageID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
This element describes the type of experiment. The required Type attribute must contain one or more entries from the following list:FP FRET Time-lapse 4-D+ Screen Immunocytochemistry FISH Electrophysiology Ion-Imaging Colocalization PGI/DocumentationFRAP Photoablation Optical-Trapping Photoactivation Fluorescence-Lifetime Spectral-Imaging OtherFP refers to fluorescent proteins, PGI/Documentation is not a 'data' image.The optional Description element may contain free text to further describe the experiment.
<xsd:element name="Experiment"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Experiments</plural></xsdfu></xsd:appinfo><xsd:documentation>This element describes the type of experiment. The required Type attribute must contain one or more entries from the following list: FP FRET Time-lapse 4-D+ Screen Immunocytochemistry FISH Electrophysiology Ion-Imaging Colocalization PGI/Documentation FRAP Photoablation Optical-Trapping Photoactivation Fluorescence-Lifetime Spectral-Imaging Other FP refers to fluorescent proteins, PGI/Documentation is not a 'data' image. The optional Description element may contain free text to further describe the experiment.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the experiment. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>This is a link to the Experimenter who conducted the experiment</xsd:documentation></xsd:annotation></xsd:element><xsd:element ref="MicrobeamManipulation" minOccurs="0" maxOccurs="unbounded"/></xsd:sequence><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>A term to describe the type of experiment.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:list><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="FP"/><xsd:enumeration value="FRET"/><!-- Förster resonance energy transfer, also known as fluorescence resonance energy transfer, resonance energy transfer (RET) or electronic energy transfer (EET) --><xsd:enumeration value="TimeLapse"/><!-- Time-lapse microscopy (microphotography, photomicrography) --><xsd:enumeration value="FourDPlus"/><xsd:enumeration value="Screen"/><xsd:enumeration value="Immunocytochemistry"/><xsd:enumeration value="Immunofluorescence"/><xsd:enumeration value="FISH"/><!-- Fluorescent in situ hybridization --><xsd:enumeration value="Electrophysiology"/><xsd:enumeration value="IonImaging"/><xsd:enumeration value="Colocalization"/><xsd:enumeration value="PGIDocumentation"/><xsd:enumeration value="FluorescenceLifetime"/><!-- Fluorescence lifetime imaging (FLIM) --><xsd:enumeration value="SpectralImaging"/><xsd:enumeration value="Photobleaching"/><xsd:enumeration value="SPIM"/><!-- Selective or Single Plane Illumination Microscopy --><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:list></xsd:simpleType></xsd:attribute><xsd:attribute name="ID" use="required" type="ExperimentID"/></xsd:complexType></xsd:element>
A description for the experiment. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the experiment. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
Defines a microbeam operation type and the region of the image it was applied to.The LightSourceRef element is a reference to a LightSource specified in the Instrument element which was used for a technique other than illumination forthe purpose of imaging. For example, a laser used for photobleaching.
<xsd:element name="MicrobeamManipulation"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>MicrobeamManipulations</plural></xsdfu></xsd:appinfo><xsd:documentation>Defines a microbeam operation type and the region of the image it was applied to. The LightSourceRef element is a reference to a LightSource specified in the Instrument element which was used for a technique other than illumination for the purpose of imaging. For example, a laser used for photobleaching.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the Microbeam Manipulation. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ROI:ROIRef" minOccurs="1" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="1" maxOccurs="1"/><xsd:element ref="LightSourceSettings" minOccurs="0" maxOccurs="unbounded"/></xsd:sequence><xsd:attribute name="ID" use="required" type="MicrobeamManipulationID"/><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>The type of manipulation performed.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:list><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="FRAP"/><!-- Fluorescence recovery after photobleaching --><xsd:enumeration value="FLIP"/><!-- Fluorescence Loss in Photobleaching --><xsd:enumeration value="InverseFRAP"/><!-- iFRAP, inverse FRAP --><xsd:enumeration value="Photoablation"/><xsd:enumeration value="Photoactivation"/><xsd:enumeration value="Uncaging"/><xsd:enumeration value="OpticalTrapping"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:list></xsd:simpleType></xsd:attribute></xsd:complexType></xsd:element>
A description for the Microbeam Manipulation. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the Microbeam Manipulation. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
The units of the Wavelength of the light source - default:nanometres[nm]
Source
<xsd:element name="LightSourceSettings"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>LightSourceSettingsCombinations</plural></xsdfu></xsd:appinfo></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Settings"><xsd:attribute name="ID" use="required" type="LightSourceID"/><xsd:attribute name="Attenuation" use="optional" type="PercentFraction"><xsd:annotation><xsd:documentation>The Attenuation of the light source [units:none] A fraction, as a value from 0.0 to 1.0.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Wavelength" use="optional" type="PositiveFloat"><xsd:annotation><xsd:documentation>The Wavelength of the light source. Units are set by WavelengthUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="WavelengthUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the Wavelength of the light source - default:nanometres[nm]</xsd:documentation></xsd:annotation></xsd:attribute></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
This element describes a person who performed an imaging experiment.This person may also be a user of the OME system, in which case the UserName element contains their login name.Experimenters may belong to one or more groups which are specified using one or more ExperimenterGroupRef elements.
A person's InstitutionThe organizing structure that people belong to other than groups. A university, or company, etc.We do not specify a department element, and do not mean for Institution to be used in this way.We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed locationand of being more recognizable than a group of experimenters. [plain text string]
This is the username of the experimenter (in a 'unix' or 'database' sense). [plain text string]
Source
<xsd:element name="Experimenter"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Experimenters</plural><global/></xsdfu></xsd:appinfo><xsd:documentation>This element describes a person who performed an imaging experiment. This person may also be a user of the OME system, in which case the UserName element contains their login name. Experimenters may belong to one or more groups which are specified using one or more ExperimenterGroupRef elements.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="ExperimenterID"/><xsd:attribute name="FirstName" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>First name, sometime called christian name or given name or forename. [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="MiddleName" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>Any other names. [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="LastName" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>A person's last name sometimes called surname or family name. [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Email" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>A person's email address. [valid email address as string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Institution" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="UserName" use="optional" type="xsd:string"><xsd:annotation><xsd:appinfo><xsdfu><unique/></xsdfu></xsd:appinfo><xsd:documentation>This is the username of the experimenter (in a 'unix' or 'database' sense). [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element>
The ExperimenterGroupID is required.Information should ideally be specified for at least one Leader as a contact for the group.The Leaders are themselves Experimenters.
<xsd:element name="ExperimenterGroup"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>ExperimenterGroups</plural><global/></xsdfu></xsd:appinfo><xsd:documentation>The ExperimenterGroupID is required. Information should ideally be specified for at least one Leader as a contact for the group. The Leaders are themselves Experimenters.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the group. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/><childordered/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="Leader" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Name" use="optional" type="xsd:string"><xsd:annotation><xsd:appinfo><xsdfu><unique/></xsdfu></xsd:appinfo></xsd:annotation></xsd:attribute><xsd:attribute name="ID" use="required" type="ExperimenterGroupID"/></xsd:complexType></xsd:element>
A description for the group. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the group. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
<xsd:element name="Leader"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Leaders</plural></xsdfu></xsd:appinfo><xsd:documentation>Contact information for a ExperimenterGroup leader specified using a reference to an Experimenter element defined elsewhere in the document.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="ExperimenterID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
This element describes the instrument used to capture the Image.It is primarily a container for manufacturer's model and catalognumbers for the Microscope, LightSource, Detector, Objective andFilters components.The Objective element contains the additional elements LensNA and Magnification.The Filters element can be composed either of separate excitation,emission filters and a dichroic mirror or a single filter set.Within the Image itself, a reference is made to this one Filter element.There may be multiple light sources, detectors, objectives and filters on a microscope.Each of these has their own ID attribute, which can be referred to from Channel.It is understood that the light path configuration can be differentfor each channel, but cannot be different for each timepoint oreach plane of an XYZ stack.
<xsd:element name="Instrument"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Instruments</plural></xsdfu></xsd:appinfo><xsd:documentation>This element describes the instrument used to capture the Image. It is primarily a container for manufacturer's model and catalog numbers for the Microscope, LightSource, Detector, Objective and Filters components. The Objective element contains the additional elements LensNA and Magnification. The Filters element can be composed either of separate excitation, emission filters and a dichroic mirror or a single filter set. Within the Image itself, a reference is made to this one Filter element. There may be multiple light sources, detectors, objectives and filters on a microscope. Each of these has their own ID attribute, which can be referred to from Channel. It is understood that the light path configuration can be different for each channel, but cannot be different for each timepoint or each plane of an XYZ stack.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="Microscope" minOccurs="0" maxOccurs="1"/><xsd:element ref="LightSource" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Detector" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Objective" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="FilterSet" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Filter" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="Dichroic" minOccurs="0" maxOccurs="unbounded"/><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="InstrumentID"/></xsd:complexType></xsd:element>
The lightsource for the instrument. An instrument may have several light sources.The type of lightsource is specified by one of the child-elements which are 'Laser', 'Filament', 'Arc' or 'LightEmittingDiode'.Each of the light source types has its own Type attribute to further differentiate the light source(eg, Nd-YAG for Laser or Hg for Arc).
A LightSource ID must be specified for each light source, and the individuallight sources can be referred to by their LightSource IDs (eg from Channel).
The serial number of the component. [plain text string]
Source
<xsd:element name="LightSource"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>LightSources</plural><abstractproprietary/></xsdfu></xsd:appinfo><xsd:documentation>The lightsource for the instrument. An instrument may have several light sources. The type of lightsource is specified by one of the child-elements which are 'Laser', 'Filament', 'Arc' or 'LightEmittingDiode'. Each of the light source types has its own Type attribute to further differentiate the light source (eg, Nd-YAG for Laser or Hg for Arc).</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="ManufacturerSpec"><xsd:sequence><xsd:choice minOccurs="1" maxOccurs="1"><xsd:element ref="Laser" minOccurs="1" maxOccurs="1"/><xsd:element ref="Filament" minOccurs="1" maxOccurs="1"/><xsd:element ref="Arc" minOccurs="1" maxOccurs="1"/><xsd:element ref="LightEmittingDiode" minOccurs="1" maxOccurs="1"/><xsd:element ref="GenericExcitationSource" minOccurs="1" maxOccurs="1"/></xsd:choice><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="LightSourceID"><xsd:annotation><xsd:documentation>A LightSource ID must be specified for each light source, and the individual light sources can be referred to by their LightSource IDs (eg from Channel).</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Power" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The light-source power. Units are set by PowerUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="PowerUnit" use="optional" default="mW" type="UnitsPower"><xsd:annotation><xsd:documentation>The units of the Power - default:milliwatts[mW].</xsd:documentation></xsd:annotation></xsd:attribute></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The units of the Wavelength - default:nanometres[nm].
Source
<xsd:element name="Laser"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Lasers</plural></xsdfu></xsd:appinfo><xsd:documentation>Laser types are specified using two attributes - the Type and the LaserMedium.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="Pump" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The Laser element may contain a Pump sub-element which refers to a LightSource used as a laser pump.</xsd:documentation></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>Type is the general category of laser.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="Excimer"/><xsd:enumeration value="Gas"/><xsd:enumeration value="MetalVapor"/><xsd:enumeration value="SolidState"/><xsd:enumeration value="Dye"/><xsd:enumeration value="Semiconductor"/><xsd:enumeration value="FreeElectron"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="LaserMedium" use="optional"><xsd:annotation><xsd:documentation>The Medium attribute specifies the actual lasing medium for a given laser type.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><!-- MetalVaporLaserMedia --><xsd:enumeration value="Cu"/><xsd:enumeration value="Ag"/><!-- ExcimerLaserMedia --><xsd:enumeration value="ArFl"/><xsd:enumeration value="ArCl"/><xsd:enumeration value="KrFl"/><xsd:enumeration value="KrCl"/><xsd:enumeration value="XeFl"/><xsd:enumeration value="XeCl"/><xsd:enumeration value="XeBr"/><!-- GasLaserMedia --><xsd:enumeration value="N"/><xsd:enumeration value="Ar"/><xsd:enumeration value="Kr"/><xsd:enumeration value="Xe"/><xsd:enumeration value="HeNe"/><xsd:enumeration value="HeCd"/><xsd:enumeration value="CO"/><xsd:enumeration value="CO2"/><xsd:enumeration value="H2O"/><xsd:enumeration value="HFl"/><!-- SolidStateLaserMedia --><xsd:enumeration value="NdGlass"/><xsd:enumeration value="NdYAG"/><xsd:enumeration value="ErGlass"/><xsd:enumeration value="ErYAG"/><xsd:enumeration value="HoYLF"/><xsd:enumeration value="HoYAG"/><xsd:enumeration value="Ruby"/><xsd:enumeration value="TiSapphire"/><xsd:enumeration value="Alexandrite"/><!-- DyeLaserMedia --><xsd:enumeration value="Rhodamine6G"/><xsd:enumeration value="CoumarinC30"/><!-- SemiconductorLaserMedia --><xsd:enumeration value="GaAs"/><xsd:enumeration value="GaAlAs"/><!-- FreeElectronLaserMedia --><xsd:enumeration value="EMinus"/><!-- OtherLaserMedia --><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="Wavelength" use="optional" type="PositiveFloat"><xsd:annotation><xsd:documentation>The Wavelength of the laser. Units are set by WavelengthUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="WavelengthUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the Wavelength - default:nanometres[nm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="FrequencyMultiplication" use="optional" type="PositiveInt"><xsd:annotation><xsd:documentation>FrequencyMultiplication that may be specified. [units:none]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Tuneable" use="optional" type="xsd:boolean"><xsd:annotation><xsd:documentation>Whether or not the laser is Tuneable [flag]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Pulse" use="optional"><xsd:annotation><xsd:documentation>The Pulse mode of the laser.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="CW"/><xsd:enumeration value="Single"/><xsd:enumeration value="QSwitched"/><xsd:enumeration value="Repetitive"/><xsd:enumeration value="ModeLocked"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="PockelCell" use="optional" type="xsd:boolean"><xsd:annotation><xsd:documentation>If true the laser has a PockelCell to rotate the polarization of the beam. [flag]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="RepetitionRate" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The is the rate in Hz at which the laser pulses if the Pulse type is 'Repetitive'. hertz[Hz] Units are set by RepetitionRateUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="RepetitionRateUnit" use="optional" default="Hz" type="UnitsFrequency"><xsd:annotation><xsd:documentation>The units of the RepetitionRate - default:hertz[Hz].</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element>
<xsd:element name="Pump"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Pumps</plural></xsdfu></xsd:appinfo><xsd:documentation>The Pump element is a reference to a LightSource. It is used within the Laser element to specify the light source for the laser's pump (if any).</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="LightSourceID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The Filament element is used to describe various kinds of filament bulbs such as Incadescent or Halogen.The Power of the Filament is now stored in the LightSource.
<xsd:element name="Filament"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Filaments</plural></xsdfu></xsd:appinfo><xsd:documentation>The Filament element is used to describe various kinds of filament bulbs such as Incadescent or Halogen. The Power of the Filament is now stored in the LightSource.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>The type of filament.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="Incandescent"/><xsd:enumeration value="Halogen"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute></xsd:complexType></xsd:element>
<xsd:element name="Arc"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Arcs</plural></xsdfu></xsd:appinfo><xsd:documentation>The Arc element is used to describe various kinds of Arc lamps - Hg, Xe, HgXe. The Power of the Arc is now stored in the LightSource.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>The type of Arc lamp.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="Hg"/><xsd:enumeration value="Xe"/><xsd:enumeration value="HgXe"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute></xsd:complexType></xsd:element>
The LightEmittingDiode element is used to describe various kinds of LED lamps. As the LightEmittingDiode is inside a LightSource it already has available the values from ManufacturerSpec (Manufacturer, Model, SerialNumber, LotNumber) And the values from LightSource which includes Power in milliwatts We have looked at extending this element but have had a problem producing a generic solution. Possible attributes talked about adding include: Power in lumens - but this is complicated by multi-channel devices like CoolLED where each channel's power is different Wavelength Range - not a simple value so would require multiple attributes or a child element Angle of Projection - this would be further affected by the optics used for filtering the naked LED or that combine power from multiple devices These values are further affected if you over-drive the LED resulting in a more complex system Another issue is that LED's may not be used directly for illumination but as drivers for secondary emissions from doped fiber optics. This would require the fiber optics to be modeled. Thanks to Paul Goodwin of Applied Precision of information about this topic.
<xsd:element name="LightEmittingDiode"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>LightEmittingDiodes</plural></xsdfu></xsd:appinfo><xsd:documentation>The LightEmittingDiode element is used to describe various kinds of LED lamps. As the LightEmittingDiode is inside a LightSource it already has available the values from ManufacturerSpec (Manufacturer, Model, SerialNumber, LotNumber) And the values from LightSource which includes Power in milliwatts We have looked at extending this element but have had a problem producing a generic solution. Possible attributes talked about adding include: Power in lumens - but this is complicated by multi-channel devices like CoolLED where each channel's power is different Wavelength Range - not a simple value so would require multiple attributes or a child element Angle of Projection - this would be further affected by the optics used for filtering the naked LED or that combine power from multiple devices These values are further affected if you over-drive the LED resulting in a more complex system Another issue is that LED's may not be used directly for illumination but as drivers for secondary emissions from doped fiber optics. This would require the fiber optics to be modeled. Thanks to Paul Goodwin of Applied Precision of information about this topic.</xsd:documentation></xsd:annotation></xsd:element>
The GenericExcitationSource element is used to representa source as a collection of key/value pairs, storedin a Map. The other lightsource objects shouldalways be used in preference to this if possible.
<xsd:element name="GenericExcitationSource"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>GenericExcitationSources</plural></xsdfu></xsd:appinfo><xsd:documentation>The GenericExcitationSource element is used to represent a source as a collection of key/value pairs, stored in a Map. The other lightsource objects should always be used in preference to this if possible.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="Map" minOccurs="0" maxOccurs="1"/></xsd:sequence></xsd:complexType></xsd:element>
<xsd:element name="Map"><xsd:annotation><xsd:appinfo><xsdfu><plural>Maps</plural></xsdfu></xsd:appinfo><xsd:documentation>This is a Mapping of key/value pairs.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="OME:MapPairs"/></xsd:complexContent></xsd:complexType></xsd:element>
This is a key/value pair used to build up a Mapping. TheElement and Attribute name are kept to single letters to minimize thelength at the expense of readability as they are likely to occur manytimes.
<xsd:element name="M" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><plural>Ms</plural></xsdfu></xsd:appinfo><xsd:documentation>This is a key/value pair used to build up a Mapping. The Element and Attribute name are kept to single letters to minimize the length at the expense of readability as they are likely to occur many times.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:simpleContent><xsd:extension base="xsd:string"><xsd:attribute name="K" type="xsd:string"/></xsd:extension></xsd:simpleContent></xsd:complexType></xsd:element>
The type of detector used to capture the image. The Detector ID can be used as a reference within the Channel element in the Image element. The values stored in Detector represent the fixed values, variable values modified during the acquisition go in DetectorSettings Each attribute now has an indication of what type of detector it applies to. This is preparatory work for cleaning up and possibly splitting this object into sub-types.
Gain applied to the detector signal.This is the electronic gain (as apposed to the inherent gain) that is set for the detector. [units:none] {used:EMCCD#EMGain}
The fixed Zoom for a detector. [units:none] {used:PMT}
Source
<xsd:element name="Detector"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Detectors</plural></xsdfu></xsd:appinfo><xsd:documentation>The type of detector used to capture the image. The Detector ID can be used as a reference within the Channel element in the Image element. The values stored in Detector represent the fixed values, variable values modified during the acquisition go in DetectorSettings Each attribute now has an indication of what type of detector it applies to. This is preparatory work for cleaning up and possibly splitting this object into sub-types.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="ManufacturerSpec"><xsd:sequence><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Gain" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Detector Gain for this detector, as a float. [units:none] {used:CCD,EMCCD,PMT}</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Voltage" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Voltage of the detector (e.g. PMT voltage) as a float. {used:PMT} Units are set by VoltageUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="VoltageUnit" use="optional" default="V" type="UnitsElectricPotential"><xsd:annotation><xsd:documentation>The units of the Voltage - default:volts[V].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Offset" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Detector Offset. [units:none] {used:CCD,EMCCD}</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Zoom" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The fixed Zoom for a detector. [units:none] {used:PMT}</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="AmplificationGain" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>Gain applied to the detector signal. This is the electronic gain (as apposed to the inherent gain) that is set for the detector. [units:none] {used:EMCCD#EMGain}</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="ID" use="required" type="DetectorID"/><xsd:attribute name="Type" use="optional"><xsd:annotation><xsd:documentation>The Type of detector. E.g. CCD, PMT, EMCCD etc.</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="CCD"/><!-- Charge-Coupled Device --><xsd:enumeration value="IntensifiedCCD"/><xsd:enumeration value="AnalogVideo"/><xsd:enumeration value="PMT"/><!-- Photomultiplier tube --><xsd:enumeration value="Photodiode"/><xsd:enumeration value="Spectroscopy"/><xsd:enumeration value="LifetimeImaging"/><xsd:enumeration value="CorrelationSpectroscopy"/><xsd:enumeration value="FTIR"/><!-- Fourier transform infrared spectroscopy --><xsd:enumeration value="EMCCD"/><!-- Electron Multiplying Charge Coupled Device --><xsd:enumeration value="APD"/><!-- Avalanche Photodiode --><xsd:enumeration value="CMOS"/><!-- complementary metal oxide semiconductor --><xsd:enumeration value="EBCCD"/><!-- electron-bombarded charge-coupled device --><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
A description of the microscope's objective lens.Required elements include the lens numerical aperture,and the magnification, both of which a floatingpoint (real) numbers.The values are those that are fixed for a particularobjective: either because it has been manufactured tothis specification or the value has been measured onthis particular objective.Correction: This is the type of correction coating applied to this lens.Immersion: This is the types of immersion medium the lens is designed towork with. It is not the same as 'Medium' in ObjectiveRef (asingle type) as here Immersion can have compound values like 'Multi'.LensNA: The numerical aperture of the lens (as a float)NominalMagnification: The specified magnification e.g. x10CalibratedMagnification: The measured magnification e.g. x10.3WorkingDistance: WorkingDistance of the lens.
The magnification of the lens as specified by the manufacturer - i.e. '60' is a 60X lens. [units:none]Note: The type of this has been changed from int to float to allowthe specification of additional lenses e.g. 0.5X lens
The units of the working distance - default:microns[µm].
Source
<xsd:element name="Objective"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Objectives</plural></xsdfu></xsd:appinfo><xsd:documentation>A description of the microscope's objective lens. Required elements include the lens numerical aperture, and the magnification, both of which a floating point (real) numbers. The values are those that are fixed for a particular objective: either because it has been manufactured to this specification or the value has been measured on this particular objective. Correction: This is the type of correction coating applied to this lens. Immersion: This is the types of immersion medium the lens is designed to work with. It is not the same as 'Medium' in ObjectiveRef (a single type) as here Immersion can have compound values like 'Multi'. LensNA: The numerical aperture of the lens (as a float) NominalMagnification: The specified magnification e.g. x10 CalibratedMagnification: The measured magnification e.g. x10.3 WorkingDistance: WorkingDistance of the lens.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="ManufacturerSpec"><xsd:sequence><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="ObjectiveID"/><xsd:attribute name="Correction" use="optional"><xsd:annotation><xsd:documentation>The correction applied to the lens</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="UV"/><xsd:enumeration value="PlanApo"/><xsd:enumeration value="PlanFluor"/><xsd:enumeration value="SuperFluor"/><xsd:enumeration value="VioletCorrected"/><xsd:enumeration value="Achro"/><xsd:enumeration value="Achromat"/><xsd:enumeration value="Fluor"/><xsd:enumeration value="Fl"/><xsd:enumeration value="Fluar"/><xsd:enumeration value="Neofluar"/><xsd:enumeration value="Fluotar"/><xsd:enumeration value="Apo"/><xsd:enumeration value="PlanNeofluar"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="Immersion" use="optional"><xsd:annotation><xsd:documentation>The immersion medium the lens is designed for</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="Oil"/><xsd:enumeration value="Water"/><xsd:enumeration value="WaterDipping"/><xsd:enumeration value="Air"/><xsd:enumeration value="Multi"/><xsd:enumeration value="Glycerol"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="LensNA" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The numerical aperture of the lens expressed as a floating point (real) number. Expected range 0.02 - 1.5 [units:none]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="NominalMagnification" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The magnification of the lens as specified by the manufacturer - i.e. '60' is a 60X lens. [units:none] Note: The type of this has been changed from int to float to allow the specification of additional lenses e.g. 0.5X lens</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CalibratedMagnification" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The magnification of the lens as measured by a calibration process- i.e. '59.987' for a 60X lens. [units:none]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="WorkingDistance" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The working distance of the lens expressed as a floating point (real) number. Units are set by WorkingDistanceUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="WorkingDistanceUnit" use="optional" default="µm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the working distance - default:microns[µm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Iris" use="optional" type="xsd:boolean"><xsd:annotation><xsd:documentation>Records whether or not the objective was fitted with an Iris. [flag]</xsd:documentation></xsd:annotation></xsd:attribute></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
A filter is either an excitation or emission filters.There should be one filter element specified per wavelength in the image.The channel number associated with a filter set is specified in Channel.It is based on the FilterSpec type, so has the required attributes Manufacturer, Model, and LotNumber.It may also contain a Type attribute which may be set to'LongPass', 'ShortPass', 'BandPass', 'MultiPass','Dichroic', 'NeutralDensity', 'Tuneable' or 'Other'.It can be associated with an optional FilterWheel - Note: this is not the same as a FilterSet
A filter 'wheel' in OME can refer to any arrangement of filters in a filter holder of any shape. It could, for example, be a filter slider. [plain text string]
<xsd:element name="Filter"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Filters</plural></xsdfu></xsd:appinfo><xsd:documentation>A filter is either an excitation or emission filters. There should be one filter element specified per wavelength in the image. The channel number associated with a filter set is specified in Channel. It is based on the FilterSpec type, so has the required attributes Manufacturer, Model, and LotNumber. It may also contain a Type attribute which may be set to 'LongPass', 'ShortPass', 'BandPass', 'MultiPass', 'Dichroic', 'NeutralDensity', 'Tuneable' or 'Other'. It can be associated with an optional FilterWheel - Note: this is not the same as a FilterSet</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="ManufacturerSpec"><xsd:sequence><xsd:element ref="TransmittanceRange" minOccurs="0" maxOccurs="1"/><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="Type" use="optional"><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:enumeration value="Dichroic"/><xsd:enumeration value="LongPass"/><xsd:enumeration value="ShortPass"/><xsd:enumeration value="BandPass"/><xsd:enumeration value="MultiPass"/><xsd:enumeration value="NeutralDensity"/><xsd:enumeration value="Tuneable"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="FilterWheel" use="optional" type="xsd:string"><xsd:annotation><xsd:documentation>A filter 'wheel' in OME can refer to any arrangement of filters in a filter holder of any shape. It could, for example, be a filter slider. [plain text string]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="ID" use="required" type="FilterID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The amount of light the filter transmits at a maximum [units:none]A fraction, as a value from 0.0 to 1.0.
Source
<xsd:element name="TransmittanceRange"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>TransmittanceRanges</plural></xsdfu></xsd:appinfo><xsd:documentation>This records the range of wavelengths that are transmitted by the filter. It also records the maximum amount of light transmitted.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:attribute name="CutIn" use="optional" type="PositiveFloat"><xsd:annotation><xsd:documentation>CutIn is the wavelength below which there is less than 50% transmittance for a filter. Units are set by CutInUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutInUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the CutIn - default:nanometres[nm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutOut" use="optional" type="PositiveFloat"><xsd:annotation><xsd:documentation>CutOut is the wavelength above which there is less than 50% transmittance for a filter. Units are set by CutOutUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutOutUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the CutOut - default:nanometres[nm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutInTolerance" use="optional" type="NonNegativeFloat"><xsd:annotation><xsd:documentation>CutInTolerance. Units are set by CutInToleranceUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutInToleranceUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the CutInTolerance - default:nanometres[nm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutOutTolerance" use="optional" type="NonNegativeFloat"><xsd:annotation><xsd:documentation>CutOutTolerance. Units are set by CutOutToleranceUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CutOutToleranceUnit" use="optional" default="nm" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the CutOutTolerance - default:nanometres[nm].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Transmittance" use="optional" type="PercentFraction"><xsd:annotation><xsd:documentation>The amount of light the filter transmits at a maximum [units:none] A fraction, as a value from 0.0 to 1.0.</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element>
The serial number of the component. [plain text string]
Source
<xsd:element name="Dichroic"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Dichroics</plural></xsdfu></xsd:appinfo><xsd:documentation>The dichromatic beamsplitter or dichroic mirror used for this filter combination.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="ManufacturerSpec"><xsd:sequence><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="DichroicID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
This element describes the actual image and its meta-data. The elements that are references (ending in Ref or Settings) refer to elements defined outside of the Image element. Ref elements are simple links, while Settings elements are links with additional values. If any of the required Image attributes or elements are missing, its guaranteed to be an invalid document. The required attributes and elements are ID and Pixels. ExperimenterRef is required for all Images with well formed LSIDs. ImageType is a vendor-specific designation of the type of image this is. Examples of ImageType include 'STK', 'SoftWorx', etc. The Name attributes are in all cases the name of the element instance. In this case, the name of the image, not necessarily the filename. Physical size of pixels are microns[µm].
<xsd:element name="Image"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>Images</plural></xsdfu></xsd:appinfo><xsd:documentation>This element describes the actual image and its meta-data. The elements that are references (ending in Ref or Settings) refer to elements defined outside of the Image element. Ref elements are simple links, while Settings elements are links with additional values. If any of the required Image attributes or elements are missing, its guaranteed to be an invalid document. The required attributes and elements are ID and Pixels. ExperimenterRef is required for all Images with well formed LSIDs. ImageType is a vendor-specific designation of the type of image this is. Examples of ImageType include 'STK', 'SoftWorx', etc. The Name attributes are in all cases the name of the element instance. In this case, the name of the image, not necessarily the filename. Physical size of pixels are microns[µm].</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="AcquisitionDate" minOccurs="0" maxOccurs="1" type="xsd:dateTime"><xsd:annotation><xsd:documentation>The acquisition date of the Image. The element contains an xsd:dateTime string based on the ISO 8601 format (i.e. 1988-04-07T18:39:09.359) YYYY-MM-DDTHH:mm:SS.sssZ Y - Year M - Month D - Day H - Hour m - minutes S - Seconds s - sub-seconds (optional) Z - Zone (optional) +HH:mm or -HH:mm or Z for UTC Note: xsd:dataTime supports a very wide date range with unlimited precision. The full date range and precision are not typically supported by platform- and language-specific libraries. Where the supported time precision is less than the precision used by the xsd:dateTime timestamp there will be loss of precision; this will typically occur via direct truncation or (less commonly) rounding. The year value can be large and/or negative. Any value covering the current or last century should be correctly processed, but some systems cannot process earlier dates. The sub-second value is defined as an unlimited number of digits after the decimal point. In Java a minimum of millisecond precision is guaranteed. In C++ microsecond precision is guaranteed, with nanosecond precision being available on some platforms. Time zones are supported, eg '2013-10-24T11:52:33+01:00' for Paris, but in most cases it will be converted to UTC when the timestamp is written.</xsd:documentation></xsd:annotation></xsd:element><xsd:element ref="ExperimenterRef" minOccurs="0" maxOccurs="1"/><xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the image. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element><xsd:element ref="ExperimentRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="ExperimenterGroupRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="InstrumentRef" minOccurs="0" maxOccurs="1"/><xsd:element ref="ObjectiveSettings" minOccurs="0" maxOccurs="1"/><xsd:element ref="ImagingEnvironment" minOccurs="0" maxOccurs="1"/><xsd:element ref="StageLabel" minOccurs="0" maxOccurs="1"/><xsd:element ref="Pixels" minOccurs="1" maxOccurs="1"/><xsd:element ref="ROI:ROIRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="MicrobeamManipulationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element><xsd:element ref="SA:AnnotationRef" minOccurs="0" maxOccurs="unbounded"><xsd:annotation><xsd:appinfo><xsdfu><manytomany/></xsdfu></xsd:appinfo></xsd:annotation></xsd:element></xsd:sequence><xsd:attribute name="ID" use="required" type="ImageID"/><xsd:attribute name="Name" use="optional" type="xsd:string"/></xsd:complexType></xsd:element>
The acquisition date of the Image. The element contains an xsd:dateTime string based on the ISO 8601 format (i.e. 1988-04-07T18:39:09.359) YYYY-MM-DDTHH:mm:SS.sssZ Y - Year M - Month D - Day H - Hour m - minutes S - Seconds s - sub-seconds (optional) Z - Zone (optional) +HH:mm or -HH:mm or Z for UTC Note: xsd:dataTime supports a very wide date range with unlimited precision. The full date range and precision are not typically supported by platform- and language-specific libraries. Where the supported time precision is less than the precision used by the xsd:dateTime timestamp there will be loss of precision; this will typically occur via direct truncation or (less commonly) rounding. The year value can be large and/or negative. Any value covering the current or last century should be correctly processed, but some systems cannot process earlier dates. The sub-second value is defined as an unlimited number of digits after the decimal point. In Java a minimum of millisecond precision is guaranteed. In C++ microsecond precision is guaranteed, with nanosecond precision being available on some platforms. Time zones are supported, eg '2013-10-24T11:52:33+01:00' for Paris, but in most cases it will be converted to UTC when the timestamp is written.
Diagram
Type
xsd:dateTime
Properties
content
simple
minOccurs
0
maxOccurs
1
Source
<xsd:element name="AcquisitionDate" minOccurs="0" maxOccurs="1" type="xsd:dateTime"><xsd:annotation><xsd:documentation>The acquisition date of the Image. The element contains an xsd:dateTime string based on the ISO 8601 format (i.e. 1988-04-07T18:39:09.359) YYYY-MM-DDTHH:mm:SS.sssZ Y - Year M - Month D - Day H - Hour m - minutes S - Seconds s - sub-seconds (optional) Z - Zone (optional) +HH:mm or -HH:mm or Z for UTC Note: xsd:dataTime supports a very wide date range with unlimited precision. The full date range and precision are not typically supported by platform- and language-specific libraries. Where the supported time precision is less than the precision used by the xsd:dateTime timestamp there will be loss of precision; this will typically occur via direct truncation or (less commonly) rounding. The year value can be large and/or negative. Any value covering the current or last century should be correctly processed, but some systems cannot process earlier dates. The sub-second value is defined as an unlimited number of digits after the decimal point. In Java a minimum of millisecond precision is guaranteed. In C++ microsecond precision is guaranteed, with nanosecond precision being available on some platforms. Time zones are supported, eg '2013-10-24T11:52:33+01:00' for Paris, but in most cases it will be converted to UTC when the timestamp is written.</xsd:documentation></xsd:annotation></xsd:element>
A description for the image. [plane text multi-line string]
Diagram
Type
restriction of xsd:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Facets
whiteSpace
preserve
Source
<xsd:element name="Description" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>A description for the image. [plane text multi-line string]</xsd:documentation></xsd:annotation><xsd:simpleType><xsd:restriction base="xsd:string"><xsd:whiteSpace value="preserve"/></xsd:restriction></xsd:simpleType></xsd:element>
<xsd:element name="InstrumentRef"><!-- top level definition --><xsd:annotation><xsd:documentation>This empty element can be used (via the required Instrument ID attribute) to refer to an Instrument defined within OME.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Reference"><xsd:attribute name="ID" use="required" type="InstrumentID"/></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The RefractiveIndex is that of the immersion medium. This isa ratio so it also unit-less. [units:none]
Source
<xsd:element name="ObjectiveSettings"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>ObjectiveSettingsCombinations</plural></xsdfu></xsd:appinfo><xsd:documentation>This holds the setting applied to an objective as well as a reference to the objective. The ID is the objective used in this case.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="Settings"><xsd:attribute name="ID" use="required" type="ObjectiveID"/><xsd:attribute name="CorrectionCollar" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The CorrectionCollar is normally an adjustable ring on the objective. Each has an arbitrary scale on it so the values is unit-less. [units:none]</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Medium" use="optional"><xsd:simpleType><xsd:annotation><xsd:documentation>A description of a Medium used for the lens. The Medium is the actual immersion medium used in this case.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="Air"/><xsd:enumeration value="Oil"/><xsd:enumeration value="Water"/><xsd:enumeration value="Glycerol"/><xsd:enumeration value="Other"/></xsd:restriction></xsd:simpleType></xsd:attribute><xsd:attribute name="RefractiveIndex" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The RefractiveIndex is that of the immersion medium. This is a ratio so it also unit-less. [units:none]</xsd:documentation></xsd:annotation></xsd:attribute></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The units the Temperature is in - default:Celsius[°C].
Source
<xsd:element name="ImagingEnvironment"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>ImagingEnvironments</plural></xsdfu></xsd:appinfo><xsd:documentation>This describes the environment that the biological sample was in during the experiment.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element ref="Map" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="Temperature" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Temperature is the define units.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="TemperatureUnit" use="optional" default="°C" type="UnitsTemperature"><xsd:annotation><xsd:documentation>The units the Temperature is in - default:Celsius[°C].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="AirPressure" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>AirPressure is the define units.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="AirPressureUnit" use="optional" default="mbar" type="UnitsPressure"><xsd:annotation><xsd:documentation>The units the AirPressure is in - default:millibars[mbar].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Humidity" use="optional" type="PercentFraction"><xsd:annotation><xsd:documentation>Humidity around the sample [units:none] A fraction, as a value from 0.0 to 1.0.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="CO2Percent" use="optional" type="PercentFraction"><xsd:annotation><xsd:documentation>Carbon Dioxide concentration around the sample [units:none] A fraction, as a value from 0.0 to 1.0.</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element>
The units of the Z stage position - default:[reference frame].
Source
<xsd:element name="StageLabel"><!-- top level definition --><xsd:annotation><xsd:appinfo><xsdfu><plural>StageLabels</plural></xsdfu></xsd:appinfo><xsd:documentation>The StageLabel is used to specify a name and position for a stage position in the microscope's reference frame.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:attribute name="Name" use="required" type="xsd:string"/><xsd:attribute name="X" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The X position of the stage label. Units are set by XUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="XUnit" use="optional" default="reference frame" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the X stage position - default:[reference frame].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Y" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Y position of the stage label. Units are set by YUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="YUnit" use="optional" default="reference frame" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the Y stage position - default:[reference frame].</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="Z" use="optional" type="xsd:float"><xsd:annotation><xsd:documentation>The Z position of the stage label. Units are set by ZUnit.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="ZUnit" use="optional" default="reference frame" type="UnitsLength"><xsd:annotation><xsd:documentation>The units of the Z stage position - default:[reference frame].</xsd:documentation></xsd:annotation></xsd:attribute></xsd:complexType></xsd:element>
Pixels is going to be removed in the future, but it is still required. This is just notice that the contents of Pixels will be moved up to Image in a future release. This is because there has only been 1 Pixels object in each Image for some time. The concept of multiple Pixels sets for one Image failed to take off. It is therefore redundant. The Image will be unreadable if any of the required Pixel attributes are missing. The Pixels themselves can be stored within the OME-XML compressed by plane, and encoded in Base64. Or the Pixels may be stored in TIFF format. The Pixels element should contain a list of BinData or TiffData, each containing a single plane of pixels. These Pixels elements, when read in document order, must produce a 5-D pixel array of the size specified in this element, and in the dimension order specified by 'DimensionOrder'. All of the values in the Pixels object when present should match the same value stored in any associated TIFF format (e.g. SizeX should be the same). Where there is a mismatch our readers will take the value from the TIFF structure as overriding the value in the OME-XML. This is simply a pragmatic decision as it increases the likelihood of reading data from a slightly incorrect file.
This is true if the pixels data was written in BigEndian order. If this value is present it should match the value used in BinData or TiffData. If it does not a reader should honour the value used in the BinData or TiffData. This values is useful for MetadataOnly files and is to allow for future storage solutions.