XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.openmicroscopy.org/XMLschemas/OME/FC/ome.xsd
Version FC-TIFF
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
Documentation Open Microscopy Environment OME XML Schema 1.0 FC-TIFF Author: Ilya G. Goldberg Copyright 2002 - 2007 OME. All rights reserved.

Declared Namespaces

Prefix Namespace
Default namespace http://www.openmicroscopy.org/XMLschemas/OME/FC/ome.xsd
STD http://www.openmicroscopy.org/XMLschemas/STD/RC2/STD.xsd
xml http://www.w3.org/XML/1998/namespace
Bin http://www.openmicroscopy.org/XMLschemas/BinaryFile/RC1/BinaryFile.xsd
CA http://www.openmicroscopy.org/XMLschemas/CA/RC1/CA.xsd
xs http://www.w3.org/2001/XMLSchema
AML http://www.openmicroscopy.org/XMLschemas/AnalysisModule/RC1/AnalysisModule.xsd
Schema Component Representation
<xs:schema targetNamespace="http://www.openmicroscopy.org/XMLschemas/OME/FC/ome.xsd" version="FC-TIFF" elementFormDefault="qualified">
<xs:import namespace="http://www.openmicroscopy.org/XMLschemas/AnalysisModule/RC1/AnalysisModule.xsd" schemaLocation="http://www.openmicroscopy.org/XMLschemas/AnalysisModule/RC1/AnalysisModule.xsd"/>
<xs:import namespace="http://www.openmicroscopy.org/XMLschemas/STD/RC2/STD.xsd" schemaLocation="http://www.openmicroscopy.org/XMLschemas/STD/RC2/STD.xsd"/>
<xs:import namespace="http://www.openmicroscopy.org/XMLschemas/BinaryFile/RC1/BinaryFile.xsd" schemaLocation="http://www.openmicroscopy.org/XMLschemas/BinaryFile/RC1/BinaryFile.xsd"/>
<xs:import namespace="http://www.openmicroscopy.org/XMLschemas/CA/RC1/CA.xsd" schemaLocation="http://www.openmicroscopy.org/XMLschemas/CA/RC1/CA.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: Arc

Name Arc
Used by (from the same schema document) Element LightSource
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Arc element is used to describe various kinds of Arc lamps - Hg, Xe, Hg-Xe. The Power attribute is the lamp's nominal power in watts.
Logical Diagram
XML Instance Representation
<Arc
Type=" xs:string (value comes from list: {'Hg'|'Xe'|'Hg-Xe'}) [1]"
Power=" xs:float [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="Arc">
<xs:complexType>
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Hg"/>
<xs:enumeration value="Xe"/>
<xs:enumeration value="Hg-Xe"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Power" type=" xs:float "/>
</xs:complexType>
</xs:element>
top

Element: AuxLightSourceRef

Name AuxLightSourceRef
Used by (from the same schema document) Element ChannelInfo
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<AuxLightSourceRef
ID=" LightSourceID [1]"
Attenuation=" PercentFraction [0..1]"
Wavelength=" xs:positiveInteger [0..1]"
Technique=" xs:string [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="AuxLightSourceRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" LightSourceID " use="required"/>
<xs:attribute name="Attenuation" type=" PercentFraction "/>
<xs:attribute name="Wavelength" type=" xs:positiveInteger "/>
<xs:attribute name="Technique" type=" xs:string "/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: BlueChannel

Name BlueChannel
Used by (from the same schema document) Element DisplayOptions
Type ChannelSpecType
Nillable no
Abstract no
Documentation The wave number, black level, white level and optional gamma for the blue channel of an RGB image. Pixel values between BlackLevel and WhiteLevel will be assigned values 0-255, respectively. Values below BlackLevel or above WhiteLevel will be assigned 0 and 255 respectively.
Logical Diagram
XML Instance Representation
<BlueChannel
ChannelNumber=" xs:integer [1]

'Specifies the channel number in the pixel dump. Channels are numbered from 0.'

"

BlackLevel=" xs:float [1]

'The black level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value below the black value will be set to the minimum value of the scale range (0). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. Valid range of values for black level is less than the white level and within the data range for the pixel type.'

"

WhiteLevel=" xs:float [1]

'The white level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value above the white value will be set to the maximum value of the scale range (255). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. The valid range for white level is greater than the black level and within the data range for the pixel type.'

"

Gamma=" xs:float [0..1]"
isOn=" xs:boolean [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="BlueChannel" type=" ChannelSpecType "/>
top

Element: ChannelComponent

Name ChannelComponent
Used by (from the same schema document) Element ChannelInfo
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Logical Channels are composed of ChannelComponents. The Index attribute is an index into the channel dimension of the 5-D pixel array. If the Logical Channel specified by ChannelInfo has a PhotometricInterpretation attribute, then the ColorDomain attribute specifies which color channel this ChannelComponent belongs to. For example 'R' for an 'RGB' PhotometricInterpretation.
Logical Diagram
XML Instance Representation
<ChannelComponent
Pixels=" PixelsID [1]"
ColorDomain=" xs:string [0..1]

'Specifies which component of Photometric Interpretation to map a channel component to. i.e. w/ RGB this could be \'R\', \'G\', \'B\' This can be null if a channel maps to a logical channel but is not included in the photometric interpretation. If this was null then the channel specified would normally be ignored.'

"

Index=" xs:nonNegativeInteger [1]

'An index into the channel dimension of the 5-D pixel array'

"
/>
Diagram
type_PixelsID
Schema Component Representation
<xs:element name="ChannelComponent">
<xs:complexType>
<xs:attribute name="Pixels" type=" PixelsID " use="required"/>
<xs:attribute name="ColorDomain" type=" xs:string "/>
<xs:attribute name="Index" type=" xs:nonNegativeInteger " use="required"/>
</xs:complexType>
</xs:element>
top

Element: ChannelInfo

Name ChannelInfo
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation There must be one per channel in the Image, even for a single-plane image. In OME, Channels (e.g. 'FITC', 'Texas Red', etc) are specified as Logical Channels, And information about how each of them was acquired is stored in the various optional *Ref elements. Each Logical Channel is composed of one or more ChannelComponents. For example, an entire spectrum in an FTIR experiment may be stored in a single Logical Channel with each discrete wavenumber of the spectrum constituting a ChannelComponent of the FTIR Logical Channel. An RGB image where the Red, Green and Blue components do not reflect discrete probes but are instead the output of a color camera would be treated similarly - one Logical channel with three ChannelComponents in this case. The total number of ChannelComponents for a set of pixels must equal SizeC. The AuxLightSourceRef 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. The SamplesPerPixel attribute is the number of channel components in the logical channel. The IlluminationType attribute is a string enumeration which may be set to 'Transmitted', 'Epifluorescence', or 'Oblique'. The optional PinholeAize attribute allows specifying adjustable pin hole diameters for confocal microscopes. The PhotometricInterpretation attribute is used to describe how to display a multi-component channel. This attribute may be set to: 'monochrome', 'RGB', 'ARGB', 'CMYK', 'HSV'. The default for single-component channels is 'monochrome'. The Model attribute describes the type of microscopy performed for each channel. This may be set to: 'Wide-field','Wide-field','Laser Scanning Microscopy','Laser Scanning Confocal','Spinning Disk Confocal','Slit Scan Confocal','Multi-Photon Microscopy', 'Structured Illumination','Single Molecule Imaging','Total Internal Reflection','Fluorescence-Lifetime','Spectral Imaging', 'Fluorescence Correlation Spectroscopy','Near Field Scanning Optical Microscopy','Second Harmonic Generation Imaging'. The ContrastMethod attribute may be set to 'Brightfield','Phase','DIC','Hoffman Modulation','Oblique Illumination','Polarized Light','Darkfield','Fluorescence'. The ExWave, EmWave and Fluor attributes allow specifying the nominal excitation and emission wavelengths and the type of fluor being imaged in a particular channel. The Fluor attribute is used for fluorescence images, while the Name attribute is used to name channels that are not imaged using fluorescence techniques. The user interface logic for labeling a given channel for the user should use the first existing attribute in the following sequence: Name -> Fluor -> EmWave -> ChannelComponent/Index. The NDfilter attribute is used to specify (in O.D. units) the combined effect of any neutral density filters used.
Logical Diagram
element_LightSourceRef element_AuxLightSourceRef element_OTFRef element_DetectorRef element_FilterRef element_ChannelComponent
XML Instance Representation
<ChannelInfo
ID=" LogicalChannelID [1]"
Name=" xs:string [0..1]"
SamplesPerPixel=" xs:integer [0..1]"
IlluminationType=" xs:string (value comes from list: {'Transmitted'|'Epifluorescence'|'Oblique'}) [0..1]"
PinholeSize=" xs:positiveInteger [0..1]"
PhotometricInterpretation=" xs:string (value comes from list: {'monochrome'|'RGB'|'ARGB'|'CMYK'|'HSV'}) [0..1]"
Mode=" xs:string (value comes from list: {'Wide-field'|'Laser Scanning Microscopy'|'Laser Scanning Confocal'|'Spinning Disk Confocal'|'Slit Scan Confocal'|'Multi-Photon Microscopy'|'Structured Illumination'|'Single Molecule Imaging'|'Total Internal Reflection'|'Fluorescence-Lifetime'|'Spectral Imaging'|'Fluorescence Correlation Spectroscopy'|'Near Field Scanning Optical Microscopy'|'Second Harmonic Generation Imaging'}) [0..1]"
ContrastMethod=" xs:string (value comes from list: {'Brightfield'|'Phase'|'DIC'|'Hoffman Modulation'|'Oblique Illumination'|'Polarized Light'|'Darkfield'|'Fluorescence'}) [0..1]"
ExWave=" xs:positiveInteger [0..1]"
EmWave=" xs:positiveInteger [0..1]"
Fluor=" xs:string [0..1]"
NDfilter=" xs:float [0..1]">
<LightSourceRef> ... </LightSourceRef> [0..1]
<AuxLightSourceRef> ... </AuxLightSourceRef> [0..1]
<OTFRef> ... </OTFRef> [0..1]
<DetectorRef> ... </DetectorRef> [0..1]
<FilterRef> ... </FilterRef> [0..1]
<ChannelComponent> ... </ChannelComponent> [1..*]
</ChannelInfo>
Diagram
element_LightSourceRef element_AuxLightSourceRef element_OTFRef element_DetectorRef element_FilterRef element_ChannelComponent type_LogicalChannelID
Schema Component Representation
<xs:element name="ChannelInfo">
<xs:complexType>
<xs:sequence>
<xs:element ref=" LightSourceRef " minOccurs="0"/>
<xs:element ref=" AuxLightSourceRef " minOccurs="0"/>
<xs:element ref=" OTFRef " minOccurs="0"/>
<xs:element ref=" DetectorRef " minOccurs="0"/>
<xs:element ref=" FilterRef " minOccurs="0"/>
<xs:element ref=" ChannelComponent " maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ID" type=" LogicalChannelID " use="required"/>
<xs:attribute name="Name" type=" xs:string "/>
<xs:attribute name="SamplesPerPixel" type=" xs:integer "/>
<xs:attribute name="IlluminationType">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Transmitted"/>
<xs:enumeration value="Epifluorescence"/>
<xs:enumeration value="Oblique"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="PinholeSize" type=" xs:positiveInteger "/>
<xs:attribute name="PhotometricInterpretation" default="monochrome">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="monochrome"/>
<xs:enumeration value="RGB"/>
<xs:enumeration value="ARGB"/>
<xs:enumeration value="CMYK"/>
<xs:enumeration value="HSV"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Mode">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Wide-field"/>
<xs:enumeration value="Laser Scanning Microscopy"/>
<xs:enumeration value="Laser Scanning Confocal"/>
<xs:enumeration value="Spinning Disk Confocal"/>
<xs:enumeration value="Slit Scan Confocal"/>
<xs:enumeration value="Multi-Photon Microscopy"/>
<xs:enumeration value="Structured Illumination"/>
<xs:enumeration value="Single Molecule Imaging"/>
<xs:enumeration value="Total Internal Reflection"/>
<xs:enumeration value="Fluorescence-Lifetime"/>
<xs:enumeration value="Spectral Imaging"/>
<xs:enumeration value="Fluorescence Correlation Spectroscopy"/>
<xs:enumeration value="Near Field Scanning Optical Microscopy"/>
<xs:enumeration value="Second Harmonic Generation Imaging"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ContrastMethod">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Brightfield"/>
<xs:enumeration value="Phase"/>
<xs:enumeration value="DIC"/>
<xs:enumeration value="Hoffman Modulation"/>
<xs:enumeration value="Oblique Illumination"/>
<xs:enumeration value="Polarized Light"/>
<xs:enumeration value="Darkfield"/>
<xs:enumeration value="Fluorescence"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ExWave" type=" xs:positiveInteger "/>
<xs:attribute name="EmWave" type=" xs:positiveInteger "/>
<xs:attribute name="Fluor" type=" xs:string "/>
<xs:attribute name="NDfilter" type=" xs:float "/>
</xs:complexType>
</xs:element>
top

Element: Contact

Name Contact
Used by (from the same schema document) Element Group
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Contact element describes the contact person for a group of experimenters - typically a project leader or lab manager. This person is specified as a reference to an OME experimenter.
Logical Diagram
XML Instance Representation
<Contact
ID=" ExperimenterID [1]"/>
Diagram
Schema Component Representation
<xs:element name="Contact">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ExperimenterID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: CreationDate

Name CreationDate
Used by (from the same schema document) Element Image
Type xs:dateTime
Nillable no
Abstract no
Documentation The creation date of the Image - when the Image was acquired. The element contains a string in the ISO 8601 dateTime format (i.e. 1988-04-07T18:39:09)
Logical Diagram
XML Instance Representation
<CreationDate> xs:dateTime </CreationDate>
Diagram
Schema Component Representation
<xs:element name="CreationDate" type=" xs:dateTime "/>
top

Element: Dataset

Name Dataset
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
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. Wether or not the list of Images in this dataset can be altered is specified by the Locked attribute. The ExperimenterRef and GroupRef 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 ProjectRef elements within the Dataset element.
Logical Diagram
element_Description element_ExperimenterRef element_GroupRef element_ProjectRef element_CustomAttributes
XML Instance Representation
<Dataset
Name=" xs:string [1]"
ID=" DatasetID [1]"
Locked=" xs:boolean [0..1]">
<Description> ... </Description> [0..1]
<ExperimenterRef> ... </ExperimenterRef> [0..1]
<GroupRef> ... </GroupRef> [0..1]
<ProjectRef> ... </ProjectRef> [0..*]
<CA:CustomAttributes> ... </CA:CustomAttributes> [0..1]
</Dataset>
Diagram
element_Description element_ExperimenterRef element_GroupRef element_ProjectRef element_CustomAttributes type_DatasetID
Schema Component Representation
<xs:element name="Dataset">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Description " minOccurs="0"/>
<xs:element ref=" ExperimenterRef " minOccurs="0"/>
<xs:element ref=" GroupRef " minOccurs="0"/>
<xs:element ref=" ProjectRef " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" CA:CustomAttributes " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="ID" type=" DatasetID " use="required"/>
<xs:attribute name="Locked" type=" xs:boolean " default="false"/>
</xs:complexType>
</xs:element>
top

Element: DatasetRef

Name DatasetRef
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
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.
Logical Diagram
XML Instance Representation
<DatasetRef
ID=" DatasetID [1]"/>
Diagram
type_DatasetID
Schema Component Representation
<xs:element name="DatasetRef">
<xs:complexType>
<xs:attribute name="ID" type=" DatasetID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: Description

Name Description
Used by (from the same schema document) Element Image , Element Experiment , Element Screen , Element Project , Element Dataset
Type anyType
Nillable no
Abstract no
Documentation Just some free-form text to describe Images, Screens and Projects. The content model is currently ANY, but this is going to change to String in the future releases. This is no longer the correct place for an XML sub-document - use CustomAttributes instead.
Logical Diagram
XML Instance Representation
<Description> ... </Description>
Diagram
Schema Component Representation
<xs:element name="Description"/>
top

Element: Detector

Name Detector
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The type of detector used to capture the image. The Detector ID can be used as a reference within the ChannelInfo element in the Image element. The Type attribute can be set to 'CCD','Intensified-CCD','Analog-Video','PMT','Photodiode','Spectroscopy','Life-time-Imaging','Correlation-Spectroscopy','FTIR'.
Logical Diagram
XML Instance Representation
<Detector
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
SerialNumber=" xs:string [1]"
Gain=" xs:float [0..1]"
Voltage=" xs:float [0..1]"
Offset=" xs:float [0..1]"
ID=" DetectorID [1]"
Type=" xs:string (value comes from list: {'CCD'|'Intensified-CCD'|'Analog-Video'|'PMT'|'Photodiode'|'Spectroscopy'|'Life-time-Imaging'|'Correlation-Spectroscopy'|'FTIR'}) [1]"/>
Diagram
Schema Component Representation
<xs:element name="Detector">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" ManufactSpec ">
<xs:attribute name="Gain" type=" xs:float "/>
<xs:attribute name="Voltage" type=" xs:float "/>
<xs:attribute name="Offset" type=" xs:float "/>
<xs:attribute name="ID" type=" DetectorID " use="required"/>
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="CCD"/>
<xs:enumeration value="Intensified-CCD"/>
<xs:enumeration value="Analog-Video"/>
<xs:enumeration value="PMT"/>
<xs:enumeration value="Photodiode"/>
<xs:enumeration value="Spectroscopy"/>
<xs:enumeration value="Life-time-Imaging"/>
<xs:enumeration value="Correlation-Spectroscopy"/>
<xs:enumeration value="FTIR"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: DetectorRef

Name DetectorRef
Used by (from the same schema document) Element ChannelInfo
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<DetectorRef
ID=" DetectorID [1]"
Offset=" xs:float [0..1]"
Gain=" xs:float [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="DetectorRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" DetectorID " use="required"/>
<xs:attribute name="Offset" type=" xs:float "/>
<xs:attribute name="Gain" type=" xs:float "/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Dichroic

Name Dichroic
Used by (from the same schema document) Element Filter
Type FilterSpec
Nillable no
Abstract no
Documentation The dichroic mirror used for this filter combination.
Logical Diagram
XML Instance Representation
<Dichroic
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
LotNumber=" xs:string [1]"/>
Diagram
Schema Component Representation
<xs:element name="Dichroic" type=" FilterSpec "/>
top

Element: DisplayOptions

Name DisplayOptions
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation There is optionally one of these per Image. This specifies mapping of image channel components to RGB or greyscale colorspace with one byte per pixel per RGB channel. RedChannel, GreenChannel, BlueChannel, and GreyChannel specify the scaling of pixel values to 8-bit colorspace values. Display indicates to display the image as Greyscale or RGB. The Projection element specifies that the display is a maximum intensity projection. The range of Z-sections for the projection is specified with the Zstart and Zstop attributes. The Time element restricts the range of timepoints displayed. The range of timepoints to display is specified by the Tstart and Tstop attributes. The MIME type of the desired video format is specified by Movie's MIMEtype attribute. The ROI element describes a 3-D region of interest. It is up to the viewer to either display the ROI only, or to simply mark it somehow.
Logical Diagram
element_RedChannel element_GreenChannel element_BlueChannel element_GreyChannel element_Projection element_Time element_ROI
XML Instance Representation
<DisplayOptions
Zoom=" xs:float [0..1]"
ID=" DisplayOptionsID [1]"
Display=" xs:string (value comes from list: {'RGB'|'Grey'}) [1]

'Specifies to display the image as greyscale or RGB'

"
>
<RedChannel> ... </RedChannel> [1]
<GreenChannel> ... </GreenChannel> [1]
<BlueChannel> ... </BlueChannel> [1]
<GreyChannel> ... </GreyChannel> [1]
<Projection> ... </Projection> [0..1]
<Time> ... </Time> [0..1]
<ROI> ... </ROI> [0..*]
</DisplayOptions>
Diagram
element_RedChannel element_GreenChannel element_BlueChannel element_GreyChannel element_Projection element_Time element_ROI type_DisplayOptionsID
Schema Component Representation
<xs:element name="DisplayOptions">
<xs:complexType>
<xs:sequence>
<xs:element ref=" RedChannel "/>
<xs:element ref=" GreenChannel "/>
<xs:element ref=" BlueChannel "/>
<xs:element ref=" GreyChannel "/>
<xs:element ref=" Projection " minOccurs="0"/>
<xs:element ref=" Time " minOccurs="0"/>
<xs:element ref=" ROI " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="Zoom" type=" xs:float "/>
<xs:attribute name="ID" type=" DisplayOptionsID " use="required"/>
<xs:attribute name="Display" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="RGB"/>
<xs:enumeration value="Grey"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
top

Element: EmFilter

Name EmFilter
Used by (from the same schema document) Element Filter
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Emission filter manufacturer specification. The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
Logical Diagram
XML Instance Representation
<EmFilter
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
LotNumber=" xs:string [1]"
Type=" xs:string (value comes from list: {'LongPass'|'ShortPass'|'BandPass'|'MultiPass'}) [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="EmFilter">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" FilterSpec ">
<xs:attribute name="Type">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="LongPass"/>
<xs:enumeration value="ShortPass"/>
<xs:enumeration value="BandPass"/>
<xs:enumeration value="MultiPass"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Email

Name Email
Used by (from the same schema document) Complex Type ExperimenterType
Type xs:string
Nillable no
Abstract no
Documentation A person's email address.
Logical Diagram
XML Instance Representation
<Email> xs:string </Email>
Diagram
Schema Component Representation
<xs:element name="Email" type=" xs:string "/>
top

Element: ExFilter

Name ExFilter
Used by (from the same schema document) Element Filter
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Excitation filter manufacturer specification. The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
Logical Diagram
XML Instance Representation
<ExFilter
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
LotNumber=" xs:string [1]"
Type=" xs:string (value comes from list: {'LongPass'|'ShortPass'|'BandPass'|'MultiPass'}) [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="ExFilter">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" FilterSpec ">
<xs:attribute name="Type">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="LongPass"/>
<xs:enumeration value="ShortPass"/>
<xs:enumeration value="BandPass"/>
<xs:enumeration value="MultiPass"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Experiment

Name Experiment
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
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/Docuemntation is not a 'data' image. The optional Description element may contain free text to further describe the experiment.
Logical Diagram
element_Description element_ExperimenterRef
XML Instance Representation
<Experiment
Type="list of: [ xs:string (value comes from list: {'FP'|'FRET'|'Time-lapse'|'4-D+'|'Screen'|'Immunocytochemistry'|'Immunofluorescence'|'FISH'|'Electrophysiology'|'Ion-Imaging'|'Colocalization'|'PGI/Documentation'|'FRAP'|'Photoablation'|'Photoactivation'|'Uncaging'|'Optical-Trapping'|'Fluorescence-Lifetime'|'Spectral-Imaging'|'Other'}) ] [1]"
ID=" ExperimentID [1]">
<Description> ... </Description> [0..1]
<ExperimenterRef> ... </ExperimenterRef> [1]
</Experiment>
Diagram
element_Description element_ExperimenterRef type_ExperimentID
Schema Component Representation
<xs:element name="Experiment">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Description " minOccurs="0"/>
<xs:element ref=" ExperimenterRef "/>
</xs:sequence>
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:list>
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="FP"/>
<xs:enumeration value="FRET"/>
<xs:enumeration value="Time-lapse"/>
<xs:enumeration value="4-D+"/>
<xs:enumeration value="Screen"/>
<xs:enumeration value="Immunocytochemistry"/>
<xs:enumeration value="Immunofluorescence"/>
<xs:enumeration value="FISH"/>
<xs:enumeration value="Electrophysiology"/>
<xs:enumeration value="Ion-Imaging"/>
<xs:enumeration value="Colocalization"/>
<xs:enumeration value="PGI/Documentation"/>
<xs:enumeration value="FRAP"/>
<xs:enumeration value="Photoablation"/>
<xs:enumeration value="Photoactivation"/>
<xs:enumeration value="Uncaging"/>
<xs:enumeration value="Optical-Trapping"/>
<xs:enumeration value="Fluorescence-Lifetime"/>
<xs:enumeration value="Spectral-Imaging"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
</xs:list>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ID" type=" ExperimentID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: ExperimentRef

Name ExperimentRef
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<ExperimentRef
ID=" ExperimentID [1]"/>
Diagram
Schema Component Representation
<xs:element name="ExperimentRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ExperimentID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Experimenter

Name Experimenter
Used by (from the same schema document) Element OME
Type ExperimenterType
Nillable no
Abstract no
Documentation This element describes a person who performed an imaging experiment. Required elements are FirstName, LastName and Email. This person may also be a user of the OME system, in which case the OMEName element contains their login name. Experimenters may belong to one or more groups which are specified using one or more GroupRef elements.
Logical Diagram
element_FirstName element_LastName element_Email element_Institution element_OMEName element_GroupRef
XML Instance Representation
<Experimenter
ID=" ExperimenterID [1]">
<FirstName> ... </FirstName> [1]
<LastName> ... </LastName> [1]
<Email> ... </Email> [1]
<Institution> ... </Institution> [1]
<OMEName> ... </OMEName> [0..1]
<GroupRef> ... </GroupRef> [1..*]
</Experimenter>
Diagram
element_FirstName element_LastName element_Email element_Institution element_OMEName element_GroupRef type_ExperimenterID
Schema Component Representation
<xs:element name="Experimenter" type=" ExperimenterType "/>
top

Element: ExperimenterRef

Name ExperimenterRef
Used by (from the same schema document) Element Image , Element Experiment , Element Project , Element Dataset
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This empty element has a required Experimenter ID and an optional DocumentID attribute which refers to one of the Experimenters defined within OME.
Logical Diagram
XML Instance Representation
<ExperimenterRef
ID=" ExperimenterID [1]"/>
Diagram
Schema Component Representation
<xs:element name="ExperimenterRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ExperimenterID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Feature

Name Feature
Used by (from the same schema document) Element Image , Element Feature
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
element_Feature element_CustomAttributes
XML Instance Representation
<Feature
Tag=" xs:string [1]"
Name=" xs:string [0..1]"
ID=" FeatureID [1]">
<Feature> ... </Feature> [0..*]
<CA:CustomAttributes> ... </CA:CustomAttributes> [0..1]
</Feature>
Diagram
element_CustomAttributes type_FeatureID
Schema Component Representation
<xs:element name="Feature">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Feature " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" CA:CustomAttributes " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Tag" type=" xs:string " use="required"/>
<xs:attribute name="Name" type=" xs:string "/>
<xs:attribute name="ID" type=" FeatureID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: Filament

Name Filament
Used by (from the same schema document) Element LightSource
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Filament element is used to describe various kinds of filament bulbs such as Incadescent or Halogen. The Power attribute is the bulb's nominal power in watts.
Logical Diagram
XML Instance Representation
<Filament
Type=" xs:string (value comes from list: {'Incandescent'|'Halogen'}) [1]"
Power=" xs:float [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="Filament">
<xs:complexType>
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Incandescent"/>
<xs:enumeration value="Halogen"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Power" type=" xs:float "/>
</xs:complexType>
</xs:element>
top

Element: Filter

Name Filter
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Filters may be separate excitation dichroic mirror and emission filters specified by the ExFilter, Dichroic and EmFilter tags respectively. Alternatively all three components may be specified by a single filter set. There should be one filter element specified per wavelength in the image. The channel number associated with a filter set is specified in ChannelInfo's required ChannelComponent element and its Index attribute. All elements are FilterSpec type, so they have the required attributes Manufacturer, Model, and LotNumber. The ExFilter an EmFilter elements may also contain a Type attribute which may be set to 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
Logical Diagram
XML Instance Representation
<Filter
ID=" FilterID [1]">
Start Choice [1]
<ExFilter> ... </ExFilter> [1]
<Dichroic> ... </Dichroic> [1]
<EmFilter> ... </EmFilter> [1]
<FilterSet> ... </FilterSet> [1]
End Choice
</Filter>
Diagram
element_ExFilter element_Dichroic element_EmFilter element_FilterSet type_FilterID
Schema Component Representation
<xs:element name="Filter">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element ref=" ExFilter "/>
<xs:element ref=" Dichroic "/>
<xs:element ref=" EmFilter "/>
</xs:sequence>
<xs:element ref=" FilterSet "/>
</xs:choice>
</xs:sequence>
<xs:attribute name="ID" type=" FilterID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: FilterRef

Name FilterRef
Used by (from the same schema document) Element ChannelInfo , Element OTF
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<FilterRef
ID=" FilterID [1]"/>
Diagram
Schema Component Representation
<xs:element name="FilterRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" FilterID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: FilterSet

Name FilterSet
Used by (from the same schema document) Element Filter
Type FilterSpec
Nillable no
Abstract no
Documentation Filter set manufacturer specification
Logical Diagram
XML Instance Representation
<FilterSet
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
LotNumber=" xs:string [1]"/>
Diagram
Schema Component Representation
<xs:element name="FilterSet" type=" FilterSpec "/>
top

Element: FirstName

Name FirstName
Used by (from the same schema document) Complex Type ExperimenterType
Type xs:string
Nillable no
Abstract no
Documentation First name, optionally containing a middle initial.
Logical Diagram
XML Instance Representation
<FirstName> xs:string </FirstName>
Diagram
Schema Component Representation
<xs:element name="FirstName" type=" xs:string "/>
top

Element: GreenChannel

Name GreenChannel
Used by (from the same schema document) Element DisplayOptions
Type ChannelSpecType
Nillable no
Abstract no
Documentation The wave number, black level, white level and optional gamma for the green channel of an RGB image. Pixel values between BlackLevel and WhiteLevel will be assigned values 0-255, respectively. Values below BlackLevel or above WhiteLevel will be assigned 0 and 255 respectively.
Logical Diagram
XML Instance Representation
<GreenChannel
ChannelNumber=" xs:integer [1]

'Specifies the channel number in the pixel dump. Channels are numbered from 0.'

"

BlackLevel=" xs:float [1]

'The black level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value below the black value will be set to the minimum value of the scale range (0). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. Valid range of values for black level is less than the white level and within the data range for the pixel type.'

"

WhiteLevel=" xs:float [1]

'The white level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value above the white value will be set to the maximum value of the scale range (255). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. The valid range for white level is greater than the black level and within the data range for the pixel type.'

"

Gamma=" xs:float [0..1]"
isOn=" xs:boolean [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="GreenChannel" type=" ChannelSpecType "/>
top

Element: GreyChannel

Name GreyChannel
Used by (from the same schema document) Element DisplayOptions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The wave number, black level, white level and optional gamma for a greyscale image. The GreyChannel element may contain an optional ColorMap attribute, which can be set to 'Greyscale', 'Spectrum' or 'Blackbody' Pixel values between BlackLevel and WhiteLevel will be assigned values 0-255, inclusive. Values below BlackLevel or above WhiteLevel will be assigned 0 and 255 respectively.
Logical Diagram
XML Instance Representation
<GreyChannel
ChannelNumber=" xs:integer [1]

'Specifies the channel number in the pixel dump. Channels are numbered from 0.'

"

BlackLevel=" xs:float [1]

'The black level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value below the black value will be set to the minimum value of the scale range (0). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. Valid range of values for black level is less than the white level and within the data range for the pixel type.'

"

WhiteLevel=" xs:float [1]

'The white level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value above the white value will be set to the maximum value of the scale range (255). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. The valid range for white level is greater than the black level and within the data range for the pixel type.'

"

Gamma=" xs:float [0..1]"
isOn=" xs:boolean [0..1]"
ColorMap=" xs:string (value comes from list: {'Greyscale'|'Spectrum'|'Blackbody'}) [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="GreyChannel">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" ChannelSpecType ">
<xs:attribute name="ColorMap" default="Greyscale">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Greyscale"/>
<xs:enumeration value="Spectrum"/>
<xs:enumeration value="Blackbody"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Group

Name Group
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Group ID and Name attributes are required. Contact information should be specified for the leader of the group and a contact person. The Leader and/or Contact are themselves experimenters defined in OME, but they need not have OMENames.
Logical Diagram
element_Leader element_Contact
XML Instance Representation
<Group
Name=" xs:string [0..1]"
ID=" GroupID [1]">
<Leader> ... </Leader> [0..1]
<Contact> ... </Contact> [0..1]
</Group>
Diagram
element_Leader element_Contact type_GroupID
Schema Component Representation
<xs:element name="Group">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Leader " minOccurs="0"/>
<xs:element ref=" Contact " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Name" type=" xs:string "/>
<xs:attribute name="ID" type=" GroupID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: GroupRef

Name GroupRef
Used by (from the same schema document) Element Image , Element Project , Complex Type ExperimenterType , Element Dataset
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This empty element has a reference (the Group ID attribute) to a Group defined within OME.
Logical Diagram
XML Instance Representation
<GroupRef
ID=" GroupID [1]"/>
Diagram
Schema Component Representation
<xs:element name="GroupRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" GroupID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Image

Name Image
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This element describes the actual image and its meta-data. The elements that are references (ending in Ref) refer to elements defined outside of the Image element. If any of the required Image attributes are missing, its guaranteed to be an invalid document. The required elements are CreationDate 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. PixelSize* is in microns. TimeIncrement is used for time series that have a global timing specification instead of per-timepoint timing info. For example in a video stream. The unit is seconds. Similarly, WaveStart and WaveIncrement are used in spectral images like FTIR. These are both positive integers.
Logical Diagram
element_CreationDate element_ExperimenterRef element_Description element_ExperimentRef element_GroupRef element_DatasetRef element_InstrumentRef element_ObjectiveRef element_ImagingEnvironment element_Thumbnail element_ChannelInfo element_DisplayOptions element_StageLabel element_PlateRef element_Pixels element_Feature element_CustomAttributes
XML Instance Representation
<Image
ID=" ImageID [1]"
Name=" xs:string [1]"
PixelSizeX=" xs:float [0..1]

'Physical size of a pixel'

"

PixelSizeY=" xs:float [0..1]

'Physical size of a pixel'

"

PixelSizeZ=" xs:float [0..1]

'Physical size of a pixel'

"

TimeIncrement=" xs:float [0..1]"
WaveStart=" xs:positiveInteger [0..1]"
WaveIncrement=" xs:positiveInteger [0..1]"
DefaultPixels=" PixelsID [0..1]

'More than one Pixels attribute may be associated with an Image. An Image will however have one \"primary\" set of Pixels. If a PixelsID is specified with this attribute, then that will be the \"primary\" pixels for this image. If this attribute is not specified, then the FIRST <Pixels> element under <Image> will be assumed to be the \"primary\" set.'

"
>
<CreationDate> ... </CreationDate> [1]
<ExperimenterRef> ... </ExperimenterRef> [0..1]
<Description> ... </Description> [0..1]
<ExperimentRef> ... </ExperimentRef> [0..1]
<GroupRef> ... </GroupRef> [0..1]
<DatasetRef> ... </DatasetRef> [0..*]
<InstrumentRef> ... </InstrumentRef> [0..1]
<ObjectiveRef> ... </ObjectiveRef> [0..1]
<ImagingEnvironment> ... </ImagingEnvironment> [0..1]
<Thumbnail> ... </Thumbnail> [0..1]
<ChannelInfo> ... </ChannelInfo> [0..*]
<DisplayOptions> ... </DisplayOptions> [0..1]
<StageLabel> ... </StageLabel> [0..1]
<PlateRef> ... </PlateRef> [0..1]
<Pixels> ... </Pixels> [1..*]
<Feature> ... </Feature> [0..*]
<CA:CustomAttributes> ... </CA:CustomAttributes> [0..1]
</Image>
Diagram
element_CreationDate element_ExperimenterRef element_Description element_ExperimentRef element_GroupRef element_DatasetRef element_InstrumentRef element_ObjectiveRef element_ImagingEnvironment element_Thumbnail element_ChannelInfo element_DisplayOptions element_StageLabel element_PlateRef element_Pixels element_Feature element_CustomAttributes type_ImageID type_PixelsID
Schema Component Representation
<xs:element name="Image">
<xs:complexType>
<xs:sequence>
<xs:element ref=" CreationDate "/>
<xs:element ref=" ExperimenterRef " minOccurs="0"/>
<xs:element ref=" Description " minOccurs="0"/>
<xs:element ref=" ExperimentRef " minOccurs="0"/>
<xs:element ref=" GroupRef " minOccurs="0"/>
<xs:element ref=" DatasetRef " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" InstrumentRef " minOccurs="0"/>
<xs:element ref=" ObjectiveRef " minOccurs="0"/>
<xs:element ref=" ImagingEnvironment " minOccurs="0"/>
<xs:element ref=" Thumbnail " minOccurs="0"/>
<xs:element ref=" ChannelInfo " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" DisplayOptions " minOccurs="0"/>
<xs:element ref=" StageLabel " minOccurs="0"/>
<xs:element ref=" PlateRef " minOccurs="0"/>
<xs:element ref=" Pixels " maxOccurs="unbounded"/>
<xs:element ref=" Feature " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" CA:CustomAttributes " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="ID" type=" ImageID " use="required"/>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="PixelSizeX" type=" xs:float "/>
<xs:attribute name="PixelSizeY" type=" xs:float "/>
<xs:attribute name="PixelSizeZ" type=" xs:float "/>
<xs:attribute name="TimeIncrement" type=" xs:float "/>
<xs:attribute name="WaveStart" type=" xs:positiveInteger "/>
<xs:attribute name="WaveIncrement" type=" xs:positiveInteger "/>
<xs:attribute name="DefaultPixels" type=" PixelsID "/>
</xs:complexType>
</xs:element>
top

Element: ImagingEnvironment

Name ImagingEnvironment
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Temperature is in Celsius, AirPressure is in millibars, Humidity and CO2Percent are percent-fractions from 0.0 to 1.0.
Logical Diagram
XML Instance Representation
<ImagingEnvironment
Temperature=" xs:float [0..1]"
AirPressure=" xs:float [0..1]"
Humidity=" PercentFraction [0..1]"
CO2Percent=" PercentFraction [0..1]"/>
Diagram
type_PercentFraction type_PercentFraction
Schema Component Representation
<xs:element name="ImagingEnvironment">
<xs:complexType>
<xs:attribute name="Temperature" type=" xs:float "/>
<xs:attribute name="AirPressure" type=" xs:float "/>
<xs:attribute name="Humidity" type=" PercentFraction "/>
<xs:attribute name="CO2Percent" type=" PercentFraction "/>
</xs:complexType>
</xs:element>
top

Element: Institution

Name Institution
Used by (from the same schema document) Complex Type ExperimenterType
Type xs:string
Nillable no
Abstract no
Documentation 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.
Logical Diagram
XML Instance Representation
<Institution> xs:string </Institution>
Diagram
Schema Component Representation
<xs:element name="Institution" type=" xs:string "/>
top

Element: Instrument

Name Instrument
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
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. Additionally, one or more OTF elements may be specified, describing the optical transfer function under different conditions. 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. The OTF element contains an optical transfer function. The same OTF can be used for all wavelengths, or there may be one per wavelength. 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 ChannelInfo. 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.
Logical Diagram
element_Microscope element_LightSource element_Detector element_Objective element_Filter element_OTF
XML Instance Representation
<Instrument
ID=" InstrumentID [1]">
<Microscope> ... </Microscope> [1]
<LightSource> ... </LightSource> [1..*]
<Detector> ... </Detector> [1..*]
<Objective> ... </Objective> [1..*]
<Filter> ... </Filter> [1..*]
<OTF> ... </OTF> [1..*]
</Instrument>
Diagram
element_Microscope element_LightSource element_Detector element_Objective element_Filter element_OTF type_InstrumentID
Schema Component Representation
<xs:element name="Instrument">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Microscope "/>
<xs:element ref=" LightSource " maxOccurs="unbounded"/>
<xs:element ref=" Detector " maxOccurs="unbounded"/>
<xs:element ref=" Objective " maxOccurs="unbounded"/>
<xs:element ref=" Filter " maxOccurs="unbounded"/>
<xs:element ref=" OTF " maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ID" type=" InstrumentID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: InstrumentRef

Name InstrumentRef
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This empty element can be used (via the required Instrument ID attribute) to refer to an Instrument defined within OME.
Logical Diagram
XML Instance Representation
<InstrumentRef
ID=" InstrumentID [1]"/>
Diagram
Schema Component Representation
<xs:element name="InstrumentRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" InstrumentID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Laser

Name Laser
Used by (from the same schema document) Element LightSource
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Laser types are specified using two attributes - the Type and the lasing medium (Medium). Type is a string which may be set to: 'Excimer','Gas','Metal Vapor','Solid State','Dye','Semiconductor', or 'Free Electron'. The Medium attribute specifies the actual lasing medium for a given laser type (for example, 'Nd-YAG'). Additionally, the Wavelength (in nm), wether or not the laser is FrequencyDoubled or Tunable may be specified. The Pulse attribute can be set to 'CW' (Continuous Wave),','Single','Q-Switched','Repetitive','Mode-Locked'. The Power attribute specifies the nominal laser power in watts. The Laser element may contain a Pump sub-element which refers to a LightSource used as a laser pump.
Logical Diagram
element_Pump
XML Instance Representation
<Laser
Type=" xs:string (value comes from list: {'Excimer'|'Gas'|'Metal Vapor'|'Solid State'|'Dye'|'Semiconductor'|'Free Electron'}) [1]"
Medium=" LaserMedia [1]"
Wavelength=" xs:positiveInteger [0..1]"
FrequencyDoubled=" xs:boolean [0..1]"
Tunable=" xs:boolean [0..1]"
Pulse=" xs:string (value comes from list: {'CW'|'Single'|'Q-Switched'|'Repetitive'|'Mode-Locked'}) [0..1]"
Power=" xs:float [0..1]">
<Pump> ... </Pump> [0..1]
</Laser>
Diagram
element_Pump type_LaserMedia
Schema Component Representation
<xs:element name="Laser">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Pump " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Excimer"/>
<xs:enumeration value="Gas"/>
<xs:enumeration value="Metal Vapor"/>
<xs:enumeration value="Solid State"/>
<xs:enumeration value="Dye"/>
<xs:enumeration value="Semiconductor"/>
<xs:enumeration value="Free Electron"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Medium" type=" LaserMedia " use="required"/>
<xs:attribute name="Wavelength" type=" xs:positiveInteger "/>
<xs:attribute name="FrequencyDoubled" type=" xs:boolean "/>
<xs:attribute name="Tunable" type=" xs:boolean "/>
<xs:attribute name="Pulse">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="CW"/>
<xs:enumeration value="Single"/>
<xs:enumeration value="Q-Switched"/>
<xs:enumeration value="Repetitive"/>
<xs:enumeration value="Mode-Locked"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Power" type=" xs:float "/>
</xs:complexType>
</xs:element>
top

Element: LastName

Name LastName
Used by (from the same schema document) Complex Type ExperimenterType
Type xs:string
Nillable no
Abstract no
Documentation A person's last or surname.
Logical Diagram
XML Instance Representation
<LastName> xs:string </LastName>
Diagram
Schema Component Representation
<xs:element name="LastName" type=" xs:string "/>
top

Element: Leader

Name Leader
Used by (from the same schema document) Element Group
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Contact information for a Group leader specified using a reference to an Experimenter element defined elsewhere in the document.
Logical Diagram
XML Instance Representation
<Leader
ID=" ExperimenterID [1]"/>
Diagram
Schema Component Representation
<xs:element name="Leader">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ExperimenterID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: LensNA

Name LensNA
Used by (from the same schema document) Element Objective
Type xs:float
Nillable no
Abstract no
Documentation The numerical aperture of the lens expressed as a floating point (real) number.
Logical Diagram
XML Instance Representation
<LensNA> xs:float </LensNA>
Diagram
Schema Component Representation
<xs:element name="LensNA" type=" xs:float "/>
top

Element: LightSource

Name LightSource
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
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' or 'Arc'. 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 individual light sources can be referred to by their LightSource IDs (eg from ChannelInfo). Lasers may have a Pump sub-element which refers to another LightSource used as a laser pump.
Logical Diagram
element_Laser element_Filament element_Arc
XML Instance Representation
<LightSource
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
SerialNumber=" xs:string [1]"
ID=" LightSourceID [1]">
Start Choice [1]
<Laser> ... </Laser> [1]
<Filament> ... </Filament> [1]
<Arc> ... </Arc> [1]
End Choice
</LightSource>
Diagram
Schema Component Representation
<xs:element name="LightSource">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" ManufactSpec ">
<xs:choice>
<xs:element ref=" Laser "/>
<xs:element ref=" Filament "/>
<xs:element ref=" Arc "/>
</xs:choice>
<xs:attribute name="ID" type=" LightSourceID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: LightSourceRef

Name LightSourceRef
Used by (from the same schema document) Element ChannelInfo
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<LightSourceRef
ID=" LightSourceID [1]"
Attenuation=" PercentFraction [0..1]"
Wavelength=" xs:positiveInteger [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="LightSourceRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" LightSourceID " use="required"/>
<xs:attribute name="Attenuation" type=" PercentFraction "/>
<xs:attribute name="Wavelength" type=" xs:positiveInteger "/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Magnification

Name Magnification
Used by (from the same schema document) Element Objective
Type xs:float
Nillable no
Abstract no
Documentation The magnification of the lens - i.e. '60.0' is a 60X lens.
Logical Diagram
XML Instance Representation
<Magnification> xs:float </Magnification>
Diagram
Schema Component Representation
<xs:element name="Magnification" type=" xs:float "/>
top

Element: Microscope

Name Microscope
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The microscope's manufacturer specification.
Logical Diagram
XML Instance Representation
<Microscope
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
SerialNumber=" xs:string [1]"
Type=" xs:string (value comes from list: {'Upright'|'Inverted'|'Dissection'|'Electrophysiology'}) [1]"/>
Diagram
Schema Component Representation
<xs:element name="Microscope">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" ManufactSpec ">
<xs:attribute name="Type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="Upright"/>
<xs:enumeration value="Inverted"/>
<xs:enumeration value="Dissection"/>
<xs:enumeration value="Electrophysiology"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: OME

Name OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The OME element is a container for all information objects acessible 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.
Logical Diagram
element_Project element_Dataset element_Experiment element_Plate element_Screen element_Experimenter element_Group element_Instrument element_Image element_SemanticTypeDefinitions element_AnalysisModuleLibrary element_CustomAttributes
XML Instance Representation
<OME>
<Project> ... </Project> [0..*]
<Dataset> ... </Dataset> [0..*]
<Experiment> ... </Experiment> [0..*]
<Plate> ... </Plate> [0..*]
<Screen> ... </Screen> [0..*]
<Experimenter> ... </Experimenter> [0..*]
<Group> ... </Group> [0..*]
<Instrument> ... </Instrument> [0..*]
<Image> ... </Image> [0..*]
<STD:SemanticTypeDefinitions> ... </STD:SemanticTypeDefinitions> [0..1]
<AML:AnalysisModuleLibrary> ... </AML:AnalysisModuleLibrary> [0..1]
<CA:CustomAttributes> ... </CA:CustomAttributes> [0..1]
</OME>
Diagram
element_Project element_Dataset element_Experiment element_Plate element_Screen element_Experimenter element_Group element_Instrument element_Image element_SemanticTypeDefinitions element_AnalysisModuleLibrary element_CustomAttributes
Schema Component Representation
<xs:element name="OME">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Project " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Dataset " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Experiment " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Plate " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Screen " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Experimenter " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Group " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Instrument " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" Image " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" STD:SemanticTypeDefinitions " minOccurs="0"/>
<xs:element ref=" AML:AnalysisModuleLibrary " minOccurs="0"/>
<xs:element ref=" CA:CustomAttributes " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: OMEName

Name OMEName
Used by (from the same schema document) Complex Type ExperimenterType
Type xs:string
Nillable no
Abstract no
Documentation This is the username of the experimenter (in a 'unix' or 'database' sense).
Logical Diagram
XML Instance Representation
<OMEName> xs:string </OMEName>
Diagram
Schema Component Representation
<xs:element name="OMEName" type=" xs:string "/>
top

Element: OTF

Name OTF
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The optical transfer function. Filter ID refers to the set of filters used in computing the OTF. BitsPerPixel is an integer '1', '8', '16'. The OpticalAxisAvg is a boolean specifying wether or not optical axis averaging was done. SizeX, SizeY specify the width and height of the OTF. This element must contain a BinData element containing the Base64-encoded OTF. Both of these work the same way as they do for the Data element within Image.
Logical Diagram
element_ObjectiveRef element_FilterRef element_BinaryFile
XML Instance Representation
<OTF
ID=" OTFID [1]"
PixelType=" PixelTypes [1]"
OpticalAxisAvrg=" xs:boolean [1]"
SizeX=" xs:positiveInteger [1]"
SizeY=" xs:positiveInteger [1]">
<ObjectiveRef> ... </ObjectiveRef> [1]
<FilterRef> ... </FilterRef> [1]
<Bin:BinaryFile> ... </Bin:BinaryFile> [1]
</OTF>
Diagram
element_ObjectiveRef element_FilterRef element_BinaryFile type_OTFID type_PixelTypes
Schema Component Representation
<xs:element name="OTF">
<xs:complexType>
<xs:sequence>
<xs:element ref=" ObjectiveRef "/>
<xs:element ref=" FilterRef "/>
<xs:element ref=" Bin:BinaryFile "/>
</xs:sequence>
<xs:attribute name="ID" type=" OTFID " use="required"/>
<xs:attribute name="PixelType" type=" PixelTypes " use="required"/>
<xs:attribute name="OpticalAxisAvrg" type=" xs:boolean " use="required"/>
<xs:attribute name="SizeX" type=" xs:positiveInteger " use="required"/>
<xs:attribute name="SizeY" type=" xs:positiveInteger " use="required"/>
</xs:complexType>
</xs:element>
top

Element: OTFRef

Name OTFRef
Used by (from the same schema document) Element ChannelInfo
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<OTFRef
ID=" OTFID [1]"/>
Diagram
Schema Component Representation
<xs:element name="OTFRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" OTFID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Objective

Name Objective
Used by (from the same schema document) Element Instrument
Type Locally-defined complex type
Nillable no
Abstract no
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.
Logical Diagram
element_LensNA element_Magnification
XML Instance Representation
<Objective
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
SerialNumber=" xs:string [1]"
ID=" ObjectiveID [1]">
<LensNA> ... </LensNA> [1]
<Magnification> ... </Magnification> [1]
</Objective>
Diagram
Schema Component Representation
<xs:element name="Objective">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" ManufactSpec ">
<xs:sequence>
<xs:element ref=" LensNA "/>
<xs:element ref=" Magnification "/>
</xs:sequence>
<xs:attribute name="ID" type=" ObjectiveID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: ObjectiveRef

Name ObjectiveRef
Used by (from the same schema document) Element Image , Element OTF
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<ObjectiveRef
ID=" ObjectiveID [1]"/>
Diagram
Schema Component Representation
<xs:element name="ObjectiveRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ObjectiveID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Pixels

Name Pixels
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Image will be unreadable if any of the required Pixel attributes are missing. The Pixels themselves are stored within the file compressed by plane, and encoded in Base64. The Pixels element must contain a list of BinData, 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'.
Logical Diagram
XML Instance Representation
<Pixels
ID=" PixelsID [1]"
DimensionOrder=" xs:string (value comes from list: {'XYZCT'|'XYZTC'|'XYCTZ'|'XYCZT'|'XYTCZ'|'XYTZC'}) [1]"
PixelType=" PixelTypes (value comes from list: {'int8'|'int16'|'int32'|'Uint8'|'Uint16'|'Uint32'|'float'}) [1]"
BigEndian=" xs:boolean [1]

'This is true if the pixel data was written in BigEndian order. This is dependent on the system architecture of the machine that wrote the pixels. True for essentially all modern CPUs other than Intel and Alpha. All pixel data must be written in the same endian order.'

"

SizeX=" xs:positiveInteger [1]

'Dimensional size of pixel data array'

"

SizeY=" xs:positiveInteger [1]

'Dimensional size of pixel data array'

"

SizeZ=" xs:positiveInteger [1]

'Dimensional size of pixel data array'

"

SizeC=" xs:positiveInteger [1]

'Dimensional size of pixel data array'

"

SizeT=" xs:positiveInteger [1]

'Dimensional size of pixel data array'

"
>
Start Choice [1..*]
<Bin:BinData> ... </Bin:BinData> [1]
<TiffData> ... </TiffData> [1]
End Choice
</Pixels>
Diagram
element_BinData element_TiffData type_PixelsID
Schema Component Representation
<xs:element name="Pixels">
<xs:complexType>
<xs:sequence>
<xs:choice maxOccurs="unbounded">
<xs:element ref=" Bin:BinData "/>
<xs:element ref=" TiffData "/>
</xs:choice>
</xs:sequence>
<xs:attribute name="ID" type=" PixelsID " use="required"/>
<xs:attribute name="DimensionOrder" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="XYZCT"/>
<xs:enumeration value="XYZTC"/>
<xs:enumeration value="XYCTZ"/>
<xs:enumeration value="XYCZT"/>
<xs:enumeration value="XYTCZ"/>
<xs:enumeration value="XYTZC"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="PixelType" use="required">
<xs:simpleType>
<xs:restriction base=" PixelTypes ">
<xs:enumeration value="int8"/>
<xs:enumeration value="int16"/>
<xs:enumeration value="int32"/>
<xs:enumeration value="Uint8"/>
<xs:enumeration value="Uint16"/>
<xs:enumeration value="Uint32"/>
<xs:enumeration value="float"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="BigEndian" type=" xs:boolean " use="required"/>
<xs:attribute name="SizeX" type=" xs:positiveInteger " use="required"/>
<xs:attribute name="SizeY" type=" xs:positiveInteger " use="required"/>
<xs:attribute name="SizeZ" type=" xs:positiveInteger " use="required"/>
<xs:attribute name="SizeC" type=" xs:positiveInteger " use="required"/>
<xs:attribute name="SizeT" type=" xs:positiveInteger " use="required"/>
</xs:complexType>
</xs:element>
top

Element: Plate

Name Plate
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This element identifies microtiter plates within a screen. A plate can belong to more than one screen. The Screen(s) that a plate belongs to are specified by the ScreenRef element. The EternRef attribute may contain a reference to an external database. The Plate ID and Name attributes are required. The Name identifies the plate to the user. It is used much like the Plate ID, and so must be unique within the document.
Logical Diagram
element_ScreenRef
XML Instance Representation
<Plate
ID=" PlateID [1]"
Name=" xs:string [1]"
ExternRef=" ExternDBref [0..1]">
<ScreenRef> ... </ScreenRef> [1..*]
</Plate>
Diagram
element_ScreenRef type_PlateID type_ExternDBref
Schema Component Representation
<xs:element name="Plate">
<xs:complexType>
<xs:sequence>
<xs:element ref=" ScreenRef " maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ID" type=" PlateID " use="required"/>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="ExternRef" type=" ExternDBref "/>
</xs:complexType>
</xs:element>
top

Element: PlateRef

Name PlateRef
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<PlateRef
ID=" PlateID [1]"
Well=" xs:string (pattern = [A-Z]+[0-9]+) [1]"
Sample=" xs:integer [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="PlateRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" PlateID " use="required"/>
<xs:attribute name="Well" use="required">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:pattern value="[A-Z]+[0-9]+"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Sample" type=" xs:integer "/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Project

Name Project
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Project ID and Name attributes are 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.
Logical Diagram
element_Description element_ExperimenterRef element_GroupRef
XML Instance Representation
<Project
Name=" xs:string [1]"
ID=" ProjectID [1]">
<Description> ... </Description> [0..1]
<ExperimenterRef> ... </ExperimenterRef> [1]
<GroupRef> ... </GroupRef> [0..1]
</Project>
Diagram
element_Description element_ExperimenterRef element_GroupRef type_ProjectID
Schema Component Representation
<xs:element name="Project">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Description " minOccurs="0"/>
<xs:element ref=" ExperimenterRef "/>
<xs:element ref=" GroupRef " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="ID" type=" ProjectID " use="required"/>
</xs:complexType>
</xs:element>
top

Element: ProjectRef

Name ProjectRef
Used by (from the same schema document) Element Dataset
Type Locally-defined complex type
Nillable no
Abstract no
Documentation There may be one or more of these in a Dataset. This empty element has a required Project ID attribute that refers to Projects defined within the OME element.
Logical Diagram
XML Instance Representation
<ProjectRef
ID=" ProjectID [1]"/>
Diagram
Schema Component Representation
<xs:element name="ProjectRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ProjectID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: Projection

Name Projection
Used by (from the same schema document) Element DisplayOptions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The presence of this element indicates the user wants to view the Image as a maximum intensity projection. The Zstart and Zstop attributes are optional. If they are not specified, then the entire Z stack will be pro z values are index from 0 to maxZ - 1
Logical Diagram
XML Instance Representation
<Projection
Zstart=" xs:integer [0..1]"
Zstop=" xs:integer [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="Projection">
<xs:complexType>
<xs:attribute name="Zstart" type=" xs:integer "/>
<xs:attribute name="Zstop" type=" xs:integer "/>
</xs:complexType>
</xs:element>
top

Element: Pump

Name Pump
Used by (from the same schema document) Element Laser
Type Locally-defined complex type
Nillable no
Abstract no
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).
Logical Diagram
XML Instance Representation
<Pump
ID=" LightSourceID [1]"/>
Diagram
Schema Component Representation
<xs:element name="Pump">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" LightSourceID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: ROI

Name ROI
Used by (from the same schema document) Element DisplayOptions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A four dimensional 'Region of Interest'. The Z and T coordinates are optional. If they are not used, and the Image has more than one plane, the entire set of planes is assumed to be included in the ROI. Multiple ROIs may be specified - these are meant to be displayed somehow.
Logical Diagram
XML Instance Representation
<ROI
X0=" xs:integer [1]"
Y0=" xs:integer [1]"
Z0=" xs:integer [0..1]"
T0=" xs:integer [0..1]"
X1=" xs:integer [1]"
Y1=" xs:integer [1]"
Z1=" xs:integer [0..1]"
T1=" xs:integer [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="ROI">
<xs:complexType>
<xs:attribute name="X0" type=" xs:integer " use="required"/>
<xs:attribute name="Y0" type=" xs:integer " use="required"/>
<xs:attribute name="Z0" type=" xs:integer "/>
<xs:attribute name="T0" type=" xs:integer "/>
<xs:attribute name="X1" type=" xs:integer " use="required"/>
<xs:attribute name="Y1" type=" xs:integer " use="required"/>
<xs:attribute name="Z1" type=" xs:integer "/>
<xs:attribute name="T1" type=" xs:integer "/>
</xs:complexType>
</xs:element>
top

Element: RedChannel

Name RedChannel
Used by (from the same schema document) Element DisplayOptions
Type ChannelSpecType
Nillable no
Abstract no
Documentation The wave number, black level, white level and optional gamma for the red channel of an RGB image. Pixel values between BlackLevel and WhiteLevel will be assigned values 0-255, respectively. Values below BlackLevel or above WhiteLevel will be assigned 0 and 255 respectively.
Logical Diagram
XML Instance Representation
<RedChannel
ChannelNumber=" xs:integer [1]

'Specifies the channel number in the pixel dump. Channels are numbered from 0.'

"

BlackLevel=" xs:float [1]

'The black level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value below the black value will be set to the minimum value of the scale range (0). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. Valid range of values for black level is less than the white level and within the data range for the pixel type.'

"

WhiteLevel=" xs:float [1]

'The white level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value above the white value will be set to the maximum value of the scale range (255). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. The valid range for white level is greater than the black level and within the data range for the pixel type.'

"

Gamma=" xs:float [0..1]"
isOn=" xs:boolean [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="RedChannel" type=" ChannelSpecType "/>
top

Element: Screen

Name Screen
Used by (from the same schema document) Element OME
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The Screen element is a grouping for Plates. The required attribute is the Screen's Name and ID - both must be unique within the document. The Screen element may contain an ExternalRef attribute that refers to an external database. A description of the screen may be specified in the Description element. Screens may contain overlapping sets of Plates i.e. Screens and Plates have a many-to-many relationship. Plates contain one or more ScreenRef elements to specify what screens they belong to.
Logical Diagram
element_Description
XML Instance Representation
<Screen
ID=" ScreenID [1]"
Name=" xs:string [1]"
ExternRef=" ExternDBref [0..1]">
<Description> ... </Description> [0..1]
</Screen>
Diagram
element_Description type_ScreenID type_ExternDBref
Schema Component Representation
<xs:element name="Screen">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Description " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="ID" type=" ScreenID " use="required"/>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="ExternRef" type=" ExternDBref "/>
</xs:complexType>
</xs:element>
top

Element: ScreenRef

Name ScreenRef
Used by (from the same schema document) Element Plate
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The ScreenRef element is a reference to a Screen element. Plate elements may have one or more ScreenRef elements to define the screen that a plate belongs to. Plates may belong to more than one screen.
Logical Diagram
XML Instance Representation
<ScreenRef
ID=" ScreenID [1]"/>
Diagram
Schema Component Representation
<xs:element name="ScreenRef">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" Reference ">
<xs:attribute name="ID" type=" ScreenID " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: StageLabel

Name StageLabel
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The StageLabel is used to specify a name and position for a stage position in the microscope's reference frame.
Logical Diagram
XML Instance Representation
<StageLabel
Name=" xs:string [1]"
X=" xs:float [0..1]"
Y=" xs:float [0..1]"
Z=" xs:float [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="StageLabel">
<xs:complexType>
<xs:attribute name="Name" type=" xs:string " use="required"/>
<xs:attribute name="X" type=" xs:float "/>
<xs:attribute name="Y" type=" xs:float "/>
<xs:attribute name="Z" type=" xs:float "/>
</xs:complexType>
</xs:element>
top

Element: Thumbnail

Name Thumbnail
Used by (from the same schema document) Element Image
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The thumbnail may be an external URI reference specified by the href attribute, or it may contain an SVG sub-document (denoted by the #wildCard 'element'). The MIMEtype is a required attribute, and must be set to 'SVG' if the tag's contents are an SVG document.
Logical Diagram
XML Instance Representation
<Thumbnail
href=" xs:anyURI [0..1]"
MIMEtype=" MIMEtype [1]">
Allow any elements from the following namespace(s): http://www.w3.org/2000/svg (strict validation). [0..1]
</Thumbnail>
Diagram
type_MIMEtype
Schema Component Representation
<xs:element name="Thumbnail">
<xs:complexType>
<xs:sequence>
<xs:any namespace="http://www.w3.org/2000/svg" processContents="strict" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="href" type=" xs:anyURI "/>
<xs:attribute name="MIMEtype" type=" MIMEtype " use="required"/>
</xs:complexType>
</xs:element>
top

Element: TiffData

Name TiffData
Used by (from the same schema document) Element Pixels
Type Locally-defined complex type
Nillable no
Abstract no
Documentation
Logical Diagram
XML Instance Representation
<TiffData
IFD=" xs:integer [0..1]

'Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD).'

"

FirstZ=" xs:integer [0..1]

'Gives the Z position of the image plane at the specified IFD. Indexed from 0. Default is 0 (the first Z position).'

"

FirstT=" xs:integer [0..1]

'Gives the T position of the image plane at the specified IFD. Indexed from 0. Default is 0 (the first T position).'

"

FirstC=" xs:integer [0..1]

'Gives the C position of the image plane at the specified IFD. Indexed from 0. Default is 0 (the first C position).'

"

NumPlanes=" xs:integer [0..1]

'Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element\'s DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1.'

"
/>
Diagram
Schema Component Representation
<xs:element name="TiffData">
<xs:complexType>
<xs:attribute name="IFD" type=" xs:integer " default="0"/>
<xs:attribute name="FirstZ" type=" xs:integer " default="0"/>
<xs:attribute name="FirstT" type=" xs:integer " default="0"/>
<xs:attribute name="FirstC" type=" xs:integer " default="0"/>
<xs:attribute name="NumPlanes" type=" xs:integer "/>
</xs:complexType>
</xs:element>
top

Element: Time

Name Time
Used by (from the same schema document) Element DisplayOptions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The time range the user is interested in the initial viewer display. A range of timepoints indicates a movie If they are not specified, the movie is to include all timepoints. If the Time attributes point to a single time-point, that is the timepoint to be initially displayed. If the entire element is missing, the first time-point will be displayed t values are index from 0 to maxT - 1
Logical Diagram
XML Instance Representation
<Time
Tstart=" xs:integer [0..1]"
Tstop=" xs:integer [0..1]"/>
Diagram
Schema Component Representation
<xs:element name="Time">
<xs:complexType>
<xs:attribute name="Tstart" type=" xs:integer "/>
<xs:attribute name="Tstop" type=" xs:integer "/>
</xs:complexType>
</xs:element>
top

Global Definitions

Complex Type: ChannelSpecType

Super-types: None
Sub-types: None
Name ChannelSpecType
Used by (from the same schema document) Element RedChannel , Element GreenChannel , Element BlueChannel
Abstract no
XML Instance Representation
<...
ChannelNumber=" xs:integer [1]

'Specifies the channel number in the pixel dump. Channels are numbered from 0.'

"

BlackLevel=" xs:float [1]

'The black level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value below the black value will be set to the minimum value of the scale range (0). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. Valid range of values for black level is less than the white level and within the data range for the pixel type.'

"

WhiteLevel=" xs:float [1]

'The white level is used to scale pixel values to an 8 bit colorspace for display. For example, a 16 bit pixel value must be downscaled to fit an 8 bit display. Any pixel value above the white value will be set to the maximum value of the scale range (255). Because the file schema offers support for non-integer pixel types, this is stored as a floating point number to offer maximum generality. Specifying a decimal value for an integer pixel type is ill defined. The valid range for white level is greater than the black level and within the data range for the pixel type.'

"

Gamma=" xs:float [0..1]"
isOn=" xs:boolean [0..1]"/>
Diagram
Schema Component Representation
<xs:complexType name="ChannelSpecType">
<xs:attribute name="ChannelNumber" type=" xs:integer " use="required"/>
<xs:attribute name="BlackLevel" type=" xs:float " use="required"/>
<xs:attribute name="WhiteLevel" type=" xs:float " use="required"/>
<xs:attribute name="Gamma" type=" xs:float "/>
<xs:attribute name="isOn" type=" xs:boolean "/>
</xs:complexType>
top

Complex Type: ExperimenterType

Super-types: None
Sub-types: None
Name ExperimenterType
Used by (from the same schema document) Element Experimenter
Abstract no
Documentation An element type to specify an Experimenter under OME. It consists of a Person element group and a login name specified under OMEName.
XML Instance Representation
<...
ID=" ExperimenterID [1]">
<FirstName> ... </FirstName> [1]
<LastName> ... </LastName> [1]
<Email> ... </Email> [1]
<Institution> ... </Institution> [1]
<OMEName> ... </OMEName> [0..1]
<GroupRef> ... </GroupRef> [1..*]
</...>
Diagram
element_FirstName element_LastName element_Email element_Institution element_OMEName element_GroupRef type_ExperimenterID
Schema Component Representation
<xs:complexType name="ExperimenterType">
<xs:sequence>
<xs:element ref=" FirstName "/>
<xs:element ref=" LastName "/>
<xs:element ref=" Email "/>
<xs:element ref=" Institution "/>
<xs:element ref=" OMEName " minOccurs="0"/>
<xs:element ref=" GroupRef " maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ID" type=" ExperimenterID " use="required"/>
</xs:complexType>
top

Complex Type: FilterSpec

Super-types: None
Sub-types: None
Name FilterSpec
Used by (from the same schema document) Element FilterSet , Element Dichroic
Abstract no
Documentation An element type specifying a filter specification. Unlike the ManufactSpec, filters are referred to by lot number rather than serial number.
XML Instance Representation
<...
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
LotNumber=" xs:string [1]"/>
Diagram
Schema Component Representation
<xs:complexType name="FilterSpec">
<xs:attribute name="Manufacturer" type=" xs:string " use="required"/>
<xs:attribute name="Model" type=" xs:string " use="required"/>
<xs:attribute name="LotNumber" type=" xs:string " use="required"/>
</xs:complexType>
top

Complex Type: ManufactSpec

Super-types: None
Sub-types: None
Name ManufactSpec
Abstract no
XML Instance Representation
<...
Manufacturer=" xs:string [1]"
Model=" xs:string [1]"
SerialNumber=" xs:string [1]"/>
Diagram
Schema Component Representation
<xs:complexType name="ManufactSpec">
<xs:attribute name="Manufacturer" type=" xs:string " use="required"/>
<xs:attribute name="Model" type=" xs:string " use="required"/>
<xs:attribute name="SerialNumber" type=" xs:string " use="required"/>
</xs:complexType>
top

Complex Type: Reference

Super-types: None
Sub-types: None
Name Reference
Abstract no
XML Instance Representation
<.../>
Diagram
Schema Component Representation
<xs:complexType name="Reference"/>
top

Simple Type: DatasetID

Super-types: xs:string < LSID (by restriction) < DatasetID (by restriction)
Sub-types: None
Name DatasetID
Used by (from the same schema document) Element Dataset , Element DatasetRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Dataset)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="DatasetID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Dataset)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DetectorID

Super-types: xs:string < LSID (by restriction) < DetectorID (by restriction)
Sub-types: None
Name DetectorID
Used by (from the same schema document) Element Detector , Element DetectorRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Detector)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="DetectorID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Detector)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DisplayOptionsID

Super-types: xs:string < LSID (by restriction) < DisplayOptionsID (by restriction)
Sub-types: None
Name DisplayOptionsID
Used by (from the same schema document) Element DisplayOptions
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:DisplayOptions)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="DisplayOptionsID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:DisplayOptions)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DyeLaserMedia

Super-types: xs:string < DyeLaserMedia (by restriction)
Sub-types: None
Name DyeLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'Rhodamine-6G'|'Coumarin-C30'}
Diagram
Schema Component Representation
<xs:simpleType name="DyeLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="Rhodamine-6G"/>
<xs:enumeration value="Coumarin-C30"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ExcimerLaserMedia

Super-types: xs:string < ExcimerLaserMedia (by restriction)
Sub-types: None
Name ExcimerLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'ArFl'|'ArCl'|'KrFl'|'KrCl'|'XeFl'|'XeCl'|'XeBr'}
Diagram
Schema Component Representation
<xs:simpleType name="ExcimerLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="ArFl"/>
<xs:enumeration value="ArCl"/>
<xs:enumeration value="KrFl"/>
<xs:enumeration value="KrCl"/>
<xs:enumeration value="XeFl"/>
<xs:enumeration value="XeCl"/>
<xs:enumeration value="XeBr"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ExperimentID

Super-types: xs:string < LSID (by restriction) < ExperimentID (by restriction)
Sub-types: None
Name ExperimentID
Used by (from the same schema document) Element Experiment , Element ExperimentRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Experiment)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ExperimentID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Experiment)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ExperimenterID

Super-types: xs:string < LSID (by restriction) < ExperimenterID (by restriction)
Sub-types: None
Name ExperimenterID
Used by (from the same schema document) Element ExperimenterRef , Element Leader , Complex Type ExperimenterType , Element Contact
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Experimenter)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ExperimenterID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Experimenter)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ExternDBref

Super-types: xs:string < ExternDBref (by restriction)
Sub-types: None
Name ExternDBref
Used by (from the same schema document) Element Screen , Element Plate
Content
  • Base XSD Type: string
Diagram
Schema Component Representation
<xs:simpleType name="ExternDBref">
<xs:restriction base=" xs:string "/>
</xs:simpleType>
top

Simple Type: FeatureID

Super-types: xs:string < LSID (by restriction) < FeatureID (by restriction)
Sub-types: None
Name FeatureID
Used by (from the same schema document) Element Feature
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Feature)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="FeatureID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Feature)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: FilterID

Super-types: xs:string < LSID (by restriction) < FilterID (by restriction)
Sub-types: None
Name FilterID
Used by (from the same schema document) Element Filter , Element FilterRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Filter)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="FilterID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Filter)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: FreeElectronLaserMedia

Super-types: xs:string < FreeElectronLaserMedia (by restriction)
Sub-types: None
Name FreeElectronLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'e-'}
Diagram
Schema Component Representation
<xs:simpleType name="FreeElectronLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="e-"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: GasLaserMedia

Super-types: xs:string < GasLaserMedia (by restriction)
Sub-types: None
Name GasLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'Nitrogen'|'Argon'|'Krypton'|'Xenon'|'HeNe'|'HeCd'|'CO'|'CO2'|'H2O'|'HFl'}
Diagram
Schema Component Representation
<xs:simpleType name="GasLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="Nitrogen"/>
<xs:enumeration value="Argon"/>
<xs:enumeration value="Krypton"/>
<xs:enumeration value="Xenon"/>
<xs:enumeration value="HeNe"/>
<xs:enumeration value="HeCd"/>
<xs:enumeration value="CO"/>
<xs:enumeration value="CO2"/>
<xs:enumeration value="H2O"/>
<xs:enumeration value="HFl"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: GroupID

Super-types: xs:string < LSID (by restriction) < GroupID (by restriction)
Sub-types: None
Name GroupID
Used by (from the same schema document) Element Group , Element GroupRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Group)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="GroupID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Group)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Hex40

Super-types: xs:hexBinary < Hex40 (by restriction)
Sub-types: None
Name Hex40
Content
  • Base XSD Type: hexBinary
  • length = 20
Diagram
Schema Component Representation
<xs:simpleType name="Hex40">
<xs:restriction base=" xs:hexBinary ">
<xs:length value="20"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ImageID

Super-types: xs:string < LSID (by restriction) < ImageID (by restriction)
Sub-types: None
Name ImageID
Used by (from the same schema document) Element Image
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Image)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ImageID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Image)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: InstrumentID

Super-types: xs:string < LSID (by restriction) < InstrumentID (by restriction)
Sub-types: None
Name InstrumentID
Used by (from the same schema document) Element Instrument , Element InstrumentRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Instrument)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="InstrumentID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Instrument)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: LSID

Super-types: xs:string < LSID (by restriction)
Sub-types:
Name LSID
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="LSID">
<xs:restriction base=" xs:string ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: LaserMedia

Super-types: None
Sub-types: None
Name LaserMedia
Used by (from the same schema document) Element Laser
Content
Diagram
type_MetalVaporLaserMedia
Schema Component Representation
<xs:simpleType name="LaserMedia">
<xs:union memberTypes=" MetalVaporLaserMedia ExcimerLaserMedia GasLaserMedia SolidStateLaserMedia DyeLaserMedia SemiconductorLaserMedia FreeElectronLaserMedia "/>
</xs:simpleType>
top

Simple Type: LightSourceID

Super-types: xs:string < LSID (by restriction) < LightSourceID (by restriction)
Sub-types: None
Name LightSourceID
Used by (from the same schema document) Element LightSource , Element LightSourceRef , Element Pump , Element AuxLightSourceRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:LightSource)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="LightSourceID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:LightSource)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: LogicalChannelID

Super-types: xs:string < LSID (by restriction) < LogicalChannelID (by restriction)
Sub-types: None
Name LogicalChannelID
Used by (from the same schema document) Element ChannelInfo
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:LogicalChannel)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="LogicalChannelID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:LogicalChannel)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: MIMEtype

Super-types: xs:string < MIMEtype (by restriction)
Sub-types: None
Name MIMEtype
Used by (from the same schema document) Element Thumbnail
Content
  • Base XSD Type: string
Diagram
Schema Component Representation
<xs:simpleType name="MIMEtype">
<xs:restriction base=" xs:string "/>
</xs:simpleType>
top

Simple Type: MetalVaporLaserMedia

Super-types: xs:string < MetalVaporLaserMedia (by restriction)
Sub-types: None
Name MetalVaporLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'Cu'|'Ag'}
Diagram
Schema Component Representation
<xs:simpleType name="MetalVaporLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="Cu"/>
<xs:enumeration value="Ag"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ModuleID

Super-types: xs:string < LSID (by restriction) < ModuleID (by restriction)
Sub-types: None
Name ModuleID
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Module)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ModuleID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Module)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: OTFID

Super-types: xs:string < LSID (by restriction) < OTFID (by restriction)
Sub-types: None
Name OTFID
Used by (from the same schema document) Element OTF , Element OTFRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:OTF)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="OTFID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:OTF)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ObjectiveID

Super-types: xs:string < LSID (by restriction) < ObjectiveID (by restriction)
Sub-types: None
Name ObjectiveID
Used by (from the same schema document) Element Objective , Element ObjectiveRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Objective)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ObjectiveID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Objective)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PercentFraction

Super-types: xs:float < PercentFraction (by restriction)
Sub-types: None
Name PercentFraction
Used by (from the same schema document) Element ImagingEnvironment , Element ImagingEnvironment , Element LightSourceRef , Element AuxLightSourceRef
Content
  • Base XSD Type: float
  • 0.0 <= value <= 1.0
Diagram
Schema Component Representation
<xs:simpleType name="PercentFraction">
<xs:restriction base=" xs:float ">
<xs:maxInclusive value="1.0"/>
<xs:minInclusive value="0.0"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PixelTypes

Super-types: xs:string < PixelTypes (by restriction)
Sub-types: None
Name PixelTypes
Used by (from the same schema document) Element OTF
Content
  • Base XSD Type: string
  • value comes from list: {'bit'|'int8'|'int16'|'int32'|'Uint8'|'Uint16'|'Uint32'|'float'|'double'|'complex'|'double-complex'}
Diagram
Schema Component Representation
<xs:simpleType name="PixelTypes">
<xs:restriction base=" xs:string ">
<xs:enumeration value="bit"/>
<xs:enumeration value="int8"/>
<xs:enumeration value="int16"/>
<xs:enumeration value="int32"/>
<xs:enumeration value="Uint8"/>
<xs:enumeration value="Uint16"/>
<xs:enumeration value="Uint32"/>
<xs:enumeration value="float"/>
<xs:enumeration value="double"/>
<xs:enumeration value="complex"/>
<xs:enumeration value="double-complex"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PixelsID

Super-types: xs:string < LSID (by restriction) < PixelsID (by restriction)
Sub-types: None
Name PixelsID
Used by (from the same schema document) Element Image , Element Pixels , Element ChannelComponent
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Pixels)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="PixelsID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Pixels)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PlateID

Super-types: xs:string < LSID (by restriction) < PlateID (by restriction)
Sub-types: None
Name PlateID
Used by (from the same schema document) Element Plate , Element PlateRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Plate)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="PlateID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Plate)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ProjectID

Super-types: xs:string < LSID (by restriction) < ProjectID (by restriction)
Sub-types: None
Name ProjectID
Used by (from the same schema document) Element Project , Element ProjectRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Project)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ProjectID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Project)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ScreenID

Super-types: xs:string < LSID (by restriction) < ScreenID (by restriction)
Sub-types: None
Name ScreenID
Used by (from the same schema document) Element Screen , Element ScreenRef
Content
  • Base XSD Type: string
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)
  • pattern = (urn:lsid:)?(\S+\.\S+)+(:Screen)(:\S+)
Diagram
Schema Component Representation
<xs:simpleType name="ScreenID">
<xs:restriction base=" LSID ">
<xs:pattern value="(urn:lsid:)?(\S+\.\S+)+(:Screen)(:\S+)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SemiconductorLaserMedia

Super-types: xs:string < SemiconductorLaserMedia (by restriction)
Sub-types: None
Name SemiconductorLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'GaAs'|'GaAlAs'}
Diagram
Schema Component Representation
<xs:simpleType name="SemiconductorLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="GaAs"/>
<xs:enumeration value="GaAlAs"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SolidStateLaserMedia

Super-types: xs:string < SolidStateLaserMedia (by restriction)
Sub-types: None
Name SolidStateLaserMedia
Content
  • Base XSD Type: string
  • value comes from list: {'Nd-Glass'|'Nd-YAG'|'Er-Glass'|'Er-YAG'|'Ho-YLF'|'Ho-YAG'|'Ruby'|'Ti-Sapphire'|'Alexandrite'}
Diagram
Schema Component Representation
<xs:simpleType name="SolidStateLaserMedia">
<xs:restriction base=" xs:string ">
<xs:enumeration value="Nd-Glass"/>
<xs:enumeration value="Nd-YAG"/>
<xs:enumeration value="Er-Glass"/>
<xs:enumeration value="Er-YAG"/>
<xs:enumeration value="Ho-YLF"/>
<xs:enumeration value="Ho-YAG"/>
<xs:enumeration value="Ruby"/>
<xs:enumeration value="Ti-Sapphire"/>
<xs:enumeration value="Alexandrite"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top