XML Schema : ome.xsd
Target namespace: http://www.openmicroscopy.org/XMLschemas/OME/FC/ome.xsd
Schema Comments: Open Microscopy Environment OME XML Schema 1.0 FC Author: Ilya G. Goldberg Copyright 2002 - 2004 OME. All rights reserved. Generated by Turbo XML 2.3.1.100. Conforms to w3c http://www.w3.org/2001/XMLSchema
Imports namespace:http://www.openmicroscopy.org/XMLschemas/AnalysisModule/RC1/AnalysisModule.xsd schemaLocation: http://www.openmicroscopy.org/XMLschemas/AnalysisModule/RC1/AnalysisModule.xsd namespace:http://www.openmicroscopy.org/XMLschemas/STD/RC2/STD.xsd schemaLocation: http://www.openmicroscopy.org/XMLschemas/STD/RC2/STD.xsd namespace:http://www.openmicroscopy.org/XMLschemas/BinaryFile/RC1/BinaryFile.xsd schemaLocation: http://www.openmicroscopy.org/XMLschemas/BinaryFile/RC1/BinaryFile.xsd namespace:http://www.openmicroscopy.org/XMLschemas/CA/RC1/CA.xsd schemaLocation: http://www.openmicroscopy.org/XMLschemas/CA/RC1/CA.xsd
Processing Instructions
Schema has: 69element definitions,  0 global attribute definitions,  121 element attribute definitions,  1 datatype definitions.
Possible root elements: OME

Element list

Element Arc
 
diagram
description 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.
uses attributes Arc/Power, Arc/Type
 
used by elementsLightSource
substitution hierarchy Arc
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Type {} required possible values: Hg | Xe | Hg-Xe
Power xs:float optional (default)

Element AuxLightSourceRef
 
diagram
description
uses attributes AuxLightSourceRef/Attenuation, AuxLightSourceRef/ID, AuxLightSourceRef/Technique, AuxLightSourceRef/Wavelength
 
used by elementsChannelInfo
substitution hierarchy Reference --> AuxLightSourceRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID LightSourceID required
Attenuation PercentFraction optional (default)
Wavelength xs:positiveInteger optional (default)
Technique xs:string optional (default)

Element BlueChannel
 
diagram
description 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.
 
used by elementsDisplayOptions
content sequence (default)
type ChannelSpecType

Element ChannelComponent
 
diagram
description 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.
uses attributes ChannelComponent/ColorDomain, ChannelComponent/Index, ChannelComponent/Pixels
 
used by elementsChannelInfo
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Pixels PixelsID required
ColorDomain xs:string optional (default) 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 required An index into the channel dimension of the 5-D pixel array

Element ChannelInfo
 
diagram
description 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.
uses elements AuxLightSourceRef, ChannelComponent, DetectorRef, FilterRef, LightSourceRef, OTFRef
uses attributes ChannelInfo/ContrastMethod, ChannelInfo/EmWave, ChannelInfo/ExWave, ChannelInfo/Fluor, ChannelInfo/ID, ChannelInfo/IlluminationType, ChannelInfo/Mode, ChannelInfo/Name, ChannelInfo/NDfilter, ChannelInfo/PhotometricInterpretation, ChannelInfo/PinholeSize, ChannelInfo/SamplesPerPixel
 
used by elementsImage
substitution hierarchy ChannelInfo
content sequence
 
Attribute Datatype Use Values Default Comments
ID LogicalChannelID required
Name xs:string optional (default)
SamplesPerPixel xs:integer optional (default)
IlluminationType {} optional (default) possible values: Transmitted | Epifluorescence | Oblique
PinholeSize xs:positiveInteger optional (default)
PhotometricInterpretation {} optional (default) possible values: monochrome | RGB | ARGB | CMYK | HSV monochrome
Mode {} optional (default) possible values: 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
ContrastMethod {} optional (default) possible values: Brightfield | Phase | DIC | Hoffman Modulation | Oblique Illumination | Polarized Light | Darkfield | Fluorescence
ExWave xs:positiveInteger optional (default)
EmWave xs:positiveInteger optional (default)
Fluor xs:string optional (default)
NDfilter xs:float optional (default)

Element Contact
 
diagram
description 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.
uses attributes Contact/ID
 
used by elementsGroup
substitution hierarchy Reference --> Contact
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ExperimenterID required

Element CreationDate
 
diagram
description 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)
 
used by elementsImage
content sequence (default)
type xs:dateTime

Element Dataset
 
diagram
description 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.
uses elements CA:CustomAttributes, Description, ExperimenterRef, GroupRef, ProjectRef
uses attributes Dataset/ID, Dataset/Locked, Dataset/Name
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
Name xs:string required
ID DatasetID required
Locked xs:boolean optional (default) false

Element DatasetRef
 
diagram
description 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.
uses attributes DatasetRef/ID
 
used by elementsImage
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID DatasetID required

Element Description
 
diagram
description Just some free-form text to describe Images, Screens and Projects. The content model is ANY, which means that en entire XML sub-document can be placed here.
 
used by elementsDataset, Experiment, Image, Project, Screen
content sequence (default)

Element Detector
 
diagram
description 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'.
uses attributes Detector/Gain, Detector/ID, Detector/Offset, Detector/Type, Detector/Voltage
 
used by elementsInstrument
substitution hierarchy ManufactSpec --> Detector
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Gain xs:float optional (default)
Voltage xs:float optional (default)
Offset xs:float optional (default)
ID DetectorID required
Type {} required possible values: CCD | Intensified-CCD | Analog-Video | PMT | Photodiode | Spectroscopy | Life-time-Imaging | Correlation-Spectroscopy | FTIR

Element DetectorRef
 
diagram
description
uses attributes DetectorRef/Gain, DetectorRef/ID, DetectorRef/Offset
 
used by elementsChannelInfo
substitution hierarchy Reference --> DetectorRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID DetectorID required
Offset xs:float optional (default)
Gain xs:float optional (default)

Element Dichroic
 
diagram
description The dichroic mirror used for this filter combination.
 
used by elementsFilter
content sequence (default)
type FilterSpec

Element DisplayOptions
 
diagram
description 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.
uses elements BlueChannel, GreenChannel, GreyChannel, Projection, RedChannel, ROI, Time
uses attributes DisplayOptions/Display, DisplayOptions/ID, DisplayOptions/Zoom
 
used by elementsImage
substitution hierarchy DisplayOptions
content sequence
 
Attribute Datatype Use Values Default Comments
Zoom xs:float optional (default)
ID DisplayOptionsID required
Display {} required possible values: RGB | Grey Specifies to display the image as greyscale or RGB

Element Email
 
diagram
description A person's email address.
 
used by typeExperimenterType
content sequence (default)
type xs:string

Element EmFilter
 
diagram
description Emission filter manufacturer specification. The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
uses attributes EmFilter/Type
 
used by elementsFilter
substitution hierarchy FilterSpec --> EmFilter
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Type {} optional (default) possible values: LongPass | ShortPass | BandPass | MultiPass

Element ExFilter
 
diagram
description Excitation filter manufacturer specification. The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
uses attributes ExFilter/Type
 
used by elementsFilter
substitution hierarchy FilterSpec --> ExFilter
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Type {} optional (default) possible values: LongPass | ShortPass | BandPass | MultiPass

Element Experiment
 
diagram
description 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.
uses elements Description, ExperimenterRef
uses attributes Experiment/ID, Experiment/Type
 
used by elementsOME
substitution hierarchy Experiment
content sequence
 
Attribute Datatype Use Values Default Comments
Type {} required possible values: 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
ID ExperimentID required

Element Experimenter
 
diagram
description 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.
 
used by elementsOME
content sequence (default)
type ExperimenterType

Element ExperimenterRef
 
diagram
description This empty element has a required Experimenter ID and an optional DocumentID attribute which refers to one of the Experimenters defined within OME.
uses attributes ExperimenterRef/ID
 
used by elementsDataset, Experiment, Image, Project
substitution hierarchy Reference --> ExperimenterRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ExperimenterID required

Element ExperimentRef
 
diagram
description
uses attributes ExperimentRef/ID
 
used by elementsImage
substitution hierarchy Reference --> ExperimentRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ExperimentID required

Element Feature
 
diagram
description
uses elements CA:CustomAttributes, Feature
uses attributes Feature/ID, Feature/Name, Feature/Tag
 
used by elementsFeature, Image
content sequence
 
Attribute Datatype Use Values Default Comments
Tag xs:string required
Name xs:string optional (default)
ID FeatureID required

Element Filament
 
diagram
description 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.
uses attributes Filament/Power, Filament/Type
 
used by elementsLightSource
substitution hierarchy Filament
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Type {} required possible values: Incandescent | Halogen
Power xs:float optional (default)

Element Filter
 
diagram
description 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'.
uses elements Dichroic, EmFilter, ExFilter, FilterSet
uses attributes Filter/ID
 
used by elementsInstrument
content sequence
 
Attribute Datatype Use Values Default Comments
ID FilterID required

Element FilterRef
 
diagram
description
uses attributes FilterRef/ID
 
used by elementsChannelInfo, OTF
substitution hierarchy Reference --> FilterRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID FilterID required

Element FilterSet
 
diagram
description Filter set manufacturer specification
 
used by elementsFilter
content sequence (default)
type FilterSpec

Element FirstName
 
diagram
description First name, optionally containing a middle initial.
 
used by typeExperimenterType
content sequence (default)
type xs:string

Element GreenChannel
 
diagram
description 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.
 
used by elementsDisplayOptions
content sequence (default)
type ChannelSpecType

Element GreyChannel
 
diagram
description 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.
uses attributes GreyChannel/ColorMap
 
used by elementsDisplayOptions
substitution hierarchy ChannelSpecType --> GreyChannel
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ColorMap {} optional (default) possible values: Greyscale | Spectrum | Blackbody Greyscale

Element Group
 
diagram
description 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.
uses elements Contact, Leader
uses attributes Group/ID, Group/Name
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
Name xs:string optional (default)
ID GroupID required

Element GroupRef
 
diagram
description This empty element has a reference (the Group ID attribute) to a Group defined within OME.
uses attributes GroupRef/ID
 
used by elementsDataset, Image, Project
used by typeExperimenterType
substitution hierarchy Reference --> GroupRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID GroupID required

Element Image
 
diagram
description 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.
uses elements ChannelInfo, CreationDate, CA:CustomAttributes, DatasetRef, Description, DisplayOptions, ExperimenterRef, ExperimentRef, Feature, GroupRef, ImagingEnvironment, InstrumentRef, ObjectiveRef, Pixels, PlateRef, StageLabel, Thumbnail
uses attributes Image/DefaultPixels, Image/ID, Image/Name, Image/PixelSizeX, Image/PixelSizeY, Image/PixelSizeZ, Image/TimeIncrement, Image/WaveIncrement, Image/WaveStart
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
ID ImageID required
Name xs:string required
PixelSizeX xs:float optional (default) Physical size of a pixel
PixelSizeY xs:float optional (default) Physical size of a pixel
PixelSizeZ xs:float optional (default) Physical size of a pixel
TimeIncrement xs:float optional (default)
WaveStart xs:positiveInteger optional (default)
WaveIncrement xs:positiveInteger optional (default)
DefaultPixels PixelsID optional (default) 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.

Element ImagingEnvironment
 
diagram
description The Temperature is in Celsius, AirPressure is in millibars, Humidity and CO2Percent are percent-fractions from 0.0 to 1.0.
uses attributes ImagingEnvironment/AirPressure, ImagingEnvironment/CO2Percent, ImagingEnvironment/Humidity, ImagingEnvironment/Temperature
 
used by elementsImage
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Temperature xs:float optional (default)
AirPressure xs:float optional (default)
Humidity PercentFraction optional (default)
CO2Percent PercentFraction optional (default)

Element Institution
 
diagram
description 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.
 
used by typeExperimenterType
content sequence (default)
type xs:string

Element Instrument
 
diagram
description 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.
uses elements Detector, Filter, LightSource, Microscope, Objective, OTF
uses attributes Instrument/ID
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
ID InstrumentID required

Element InstrumentRef
 
diagram
description This empty element can be used (via the required Instrument ID attribute) to refer to an Instrument defined within OME.
uses attributes InstrumentRef/ID
 
used by elementsImage
substitution hierarchy Reference --> InstrumentRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID InstrumentID required

Element Laser
 
diagram
description 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.
uses elements Pump
uses attributes Laser/FrequencyDoubled, Laser/Medium, Laser/Power, Laser/Pulse, Laser/Tunable, Laser/Type, Laser/Wavelength
 
used by elementsLightSource
substitution hierarchy Laser
content sequence
 
Attribute Datatype Use Values Default Comments
Type {} required possible values: Excimer | Gas | Metal Vapor | Solid State | Dye | Semiconductor | Free Electron
Medium LaserMedia required
Wavelength xs:positiveInteger optional (default)
FrequencyDoubled xs:boolean optional (default)
Tunable xs:boolean optional (default)
Pulse {} optional (default) possible values: CW | Single | Q-Switched | Repetitive | Mode-Locked
Power xs:float optional (default)

Element LastName
 
diagram
description A person's last or surname.
 
used by typeExperimenterType
content sequence (default)
type xs:string

Element Leader
 
diagram
description Contact information for a Group leader specified using a reference to an Experimenter element defined elsewhere in the document.
uses attributes Leader/ID
 
used by elementsGroup
substitution hierarchy Reference --> Leader
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ExperimenterID required

Element LensNA
 
diagram
description The numerical aperture of the lens expressed as a floating point (real) number.
 
used by elementsObjective
content sequence (default)
type xs:float

Element LightSource
 
diagram
description 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.
uses elements Arc, Filament, Laser
uses attributes LightSource/ID
 
used by elementsInstrument
substitution hierarchy ManufactSpec --> LightSource
content choice
 
Attribute Datatype Use Values Default Comments
ID LightSourceID required

Element LightSourceRef
 
diagram
description
uses attributes LightSourceRef/Attenuation, LightSourceRef/ID, LightSourceRef/Wavelength
 
used by elementsChannelInfo
substitution hierarchy Reference --> LightSourceRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID LightSourceID required
Attenuation PercentFraction optional (default)
Wavelength xs:positiveInteger optional (default)

Element Magnification
 
diagram
description The magnification of the lens - i.e. '60.0' is a 60X lens.
 
used by elementsObjective
content sequence (default)
type xs:float

Element Microscope
 
diagram
description The microscope's manufacturer specification.
uses attributes Microscope/Type
 
used by elementsInstrument
substitution hierarchy ManufactSpec --> Microscope
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Type {} required possible values: Upright | Inverted | Dissection | Electrophysiology

Element Objective
 
diagram
description 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.
uses elements LensNA, Magnification
uses attributes Objective/ID
 
used by elementsInstrument
substitution hierarchy ManufactSpec --> Objective
content sequence
 
Attribute Datatype Use Values Default Comments
ID ObjectiveID required

Element ObjectiveRef
 
diagram
description
uses attributes ObjectiveRef/ID
 
used by elementsImage, OTF
substitution hierarchy Reference --> ObjectiveRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ObjectiveID required

Element OME
 
diagram
description 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.
uses elements AML:AnalysisModuleLibrary, CA:CustomAttributes, Dataset, Experiment, Experimenter, Group, Image, Instrument, Plate, Project, Screen, STD:SemanticTypeDefinitions
 
content sequence

Element OMEName
 
diagram
description This is the username of the experimenter (in a 'unix' or 'database' sense).
 
used by typeExperimenterType
content sequence (default)
type xs:string

Element OTF
 
diagram
description 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.
uses elements Bin:BinaryFile, FilterRef, ObjectiveRef
uses attributes OTF/ID, OTF/OpticalAxisAvrg, OTF/PixelType, OTF/SizeX, OTF/SizeY
 
used by elementsInstrument
content sequence
 
Attribute Datatype Use Values Default Comments
ID OTFID required
PixelType PixelTypes required
OpticalAxisAvrg xs:boolean required
SizeX xs:positiveInteger required
SizeY xs:positiveInteger required

Element OTFRef
 
diagram
description
uses attributes OTFRef/ID
 
used by elementsChannelInfo
substitution hierarchy Reference --> OTFRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID OTFID required

Element Pixels
 
diagram
description 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'.
uses elements Bin:BinData
uses attributes Pixels/BigEndian, Pixels/DimensionOrder, Pixels/ID, Pixels/PixelType, Pixels/SizeC, Pixels/SizeT, Pixels/SizeX, Pixels/SizeY, Pixels/SizeZ
 
used by elementsImage
substitution hierarchy Pixels
content sequence
 
Attribute Datatype Use Values Default Comments
ID PixelsID required
DimensionOrder {} required possible values: XYZCT | XYZTC | XYCTZ | XYCZT | XYTCZ | XYTZC
PixelType {} required possible values: int8 | int16 | int32 | Uint8 | Uint16 | Uint32 | float
BigEndian xs:boolean required 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 required Dimensional size of pixel data array
SizeY xs:positiveInteger required Dimensional size of pixel data array
SizeZ xs:positiveInteger required Dimensional size of pixel data array
SizeC xs:positiveInteger required Dimensional size of pixel data array
SizeT xs:positiveInteger required Dimensional size of pixel data array

Element Plate
 
diagram
description 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.
uses elements ScreenRef
uses attributes Plate/ExternRef, Plate/ID, Plate/Name
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
ID PlateID required
Name xs:string required
ExternRef ExternDBref optional (default)

Element PlateRef
 
diagram
description
uses attributes PlateRef/ID, PlateRef/Sample, PlateRef/Well
 
used by elementsImage
substitution hierarchy Reference --> PlateRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID PlateID required
Well {} required pattern:[A-Z]+[0-9]+
Sample xs:integer optional (default)

Element Project
 
diagram
description 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.
uses elements Description, ExperimenterRef, GroupRef
uses attributes Project/ID, Project/Name
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
Name xs:string required
ID ProjectID required

Element Projection
 
diagram
description 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
uses attributes Projection/Zstart, Projection/Zstop
 
used by elementsDisplayOptions
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Zstart xs:integer optional (default)
Zstop xs:integer optional (default)

Element ProjectRef
 
diagram
description 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.
uses attributes ProjectRef/ID
 
used by elementsDataset
substitution hierarchy Reference --> ProjectRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ProjectID required

Element Pump
 
diagram
description 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).
uses attributes Pump/ID
 
used by elementsLaser
substitution hierarchy Reference --> Pump
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID LightSourceID required

Element RedChannel
 
diagram
description 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.
 
used by elementsDisplayOptions
content sequence (default)
type ChannelSpecType

Element ROI
 
diagram
description 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.
uses attributes ROI/T0, ROI/T1, ROI/X0, ROI/X1, ROI/Y0, ROI/Y1, ROI/Z0, ROI/Z1
 
used by elementsDisplayOptions
content sequence (default)
 
Attribute Datatype Use Values Default Comments
X0 xs:integer required
Y0 xs:integer required
Z0 xs:integer optional (default)
T0 xs:integer optional (default)
X1 xs:integer required
Y1 xs:integer required
Z1 xs:integer optional (default)
T1 xs:integer optional (default)

Element Screen
 
diagram
description 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.
uses elements Description
uses attributes Screen/ExternRef, Screen/ID, Screen/Name
 
used by elementsOME
content sequence
 
Attribute Datatype Use Values Default Comments
ID ScreenID required
Name xs:string required
ExternRef ExternDBref optional (default)

Element ScreenRef
 
diagram
description 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.
uses attributes ScreenRef/ID
 
used by elementsPlate
substitution hierarchy Reference --> ScreenRef
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ID ScreenID required

Element StageLabel
 
diagram
description The StageLabel is used to specify a name and position for a stage position in the microscope's reference frame.
uses attributes StageLabel/Name, StageLabel/X, StageLabel/Y, StageLabel/Z
 
used by elementsImage
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Name xs:string required
X xs:float optional (default)
Y xs:float optional (default)
Z xs:float optional (default)

Element Thumbnail
 
diagram
description 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.
uses attributes Thumbnail/href, Thumbnail/MIMEtype
 
used by elementsImage
content sequence
 
Attribute Datatype Use Values Default Comments
href xs:anyURI optional (default)
MIMEtype MIMEtype required

Element Time
 
diagram
description 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
uses attributes Time/Tstart, Time/Tstop
 
used by elementsDisplayOptions
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Tstart xs:integer optional (default)
Tstop xs:integer optional (default)

Complex Types

Complex Type ChannelSpecType
 
diagram
description
uses attributes ChannelSpecType(type)/BlackLevel, ChannelSpecType(type)/ChannelNumber, ChannelSpecType(type)/Gamma, ChannelSpecType(type)/isOn, ChannelSpecType(type)/WhiteLevel
 
GreyChannel   ,  
content sequence (default)
 
Attribute Datatype Use Values Default Comments
ChannelNumber xs:integer required Specifies the channel number in the pixel dump. Channels are numbered from 0.
BlackLevel xs:float required 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 required 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 optional (default)
isOn xs:boolean optional (default)

Complex Type ExperimenterType
 
diagram
description An element type to specify an Experimenter under OME. It consists of a Person element group and a login name specified under OMEName.
uses elements Email, FirstName, GroupRef, Institution, LastName, OMEName
uses attributes ExperimenterType(type)/ID
 
content sequence
 
Attribute Datatype Use Values Default Comments
ID ExperimenterID required

Complex Type FilterSpec
 
diagram
description An element type specifying a filter specification. Unlike the ManufactSpec, filters are referred to by lot number rather than serial number.
uses attributes FilterSpec(type)/LotNumber, FilterSpec(type)/Manufacturer, FilterSpec(type)/Model
 
ExFilter   ,   ,EmFilter  
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Manufacturer xs:string required
Model xs:string required
LotNumber xs:string required

Complex Type ManufactSpec
 
diagram
description
uses attributes ManufactSpec(type)/Manufacturer, ManufactSpec(type)/Model, ManufactSpec(type)/SerialNumber
 
Objective   ,   ,Detector   ,Microscope   ,LightSource  
content sequence (default)
 
Attribute Datatype Use Values Default Comments
Manufacturer xs:string required
Model xs:string required
SerialNumber xs:string required

Complex Type Reference
 
diagram
description
 
ExperimentRef   ,   ,ScreenRef   ,ProjectRef   ,ExperimenterRef   ,Leader   ,Contact   ,GroupRef   ,InstrumentRef   ,LightSourceRef   ,FilterRef   ,OTFRef   ,DetectorRef   ,Pump   ,PlateRef   ,AuxLightSourceRef   ,ObjectiveRef  
content sequence (default)

DataType definitions

Datatype DatasetID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Dataset)(:\S+)

Datatype DetectorID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Detector)(:\S+)

Datatype DisplayOptionsID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:DisplayOptions)(:\S+)

Datatype DyeLaserMedia   defined by restriction
 
dt base xs:string
possible values Rhodamine-6G | Coumarin-C30

Datatype ExcimerLaserMedia   defined by restriction
 
dt base xs:string
possible values ArFl | ArCl | KrFl | KrCl | XeFl | XeCl | XeBr

Datatype ExperimenterID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Experimenter)(:\S+)

Datatype ExperimentID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Experiment)(:\S+)

Datatype ExternDBref   defined by restriction
 
dt base xs:string

Datatype FeatureID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Feature)(:\S+)

Datatype FilterID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Filter)(:\S+)

Datatype FreeElectronLaserMedia   defined by restriction
 
dt base xs:string
possible values e-

Datatype GasLaserMedia   defined by restriction
 
dt base xs:string
possible values Nitrogen | Argon | Krypton | Xenon | HeNe | HeCd | CO | CO2 | H2O | HFl

Datatype GroupID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Group)(:\S+)

Datatype Hex40   defined by restriction
 
dt base xs:hexBinary
length 20

Datatype ImageID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Image)(:\S+)

Datatype InstrumentID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Instrument)(:\S+)

Datatype LaserMedia   defined by union
 
member of type MetalVaporLaserMedia ExcimerLaserMedia GasLaserMedia SolidStateLaserMedia DyeLaserMedia SemiconductorLaserMedia FreeElectronLaserMedia

Datatype LightSourceID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:LightSource)(:\S+)

Datatype LogicalChannelID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:LogicalChannel)(:\S+)

Datatype LSID   defined by restriction
 
dt base xs:string
pattern (urn:lsid:)?(\S+\.\S+)+(:\S+)(:\S+)

Datatype MetalVaporLaserMedia   defined by restriction
 
dt base xs:string
possible values Cu | Ag

Datatype MIMEtype   defined by restriction
 
dt base xs:string

Datatype ModuleID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Module)(:\S+)

Datatype ObjectiveID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Objective)(:\S+)

Datatype OTFID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:OTF)(:\S+)

Datatype PercentFraction   defined by restriction
 
dt base xs:float
range [0.0, 1.0]

Datatype PixelsID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Pixels)(:\S+)

Datatype PixelTypes   defined by restriction
 
dt base xs:string
possible values bit | int8 | int16 | int32 | Uint8 | Uint16 | Uint32 | float | double | complex | double-complex

Datatype PlateID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Plate)(:\S+)

Datatype ProjectID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Project)(:\S+)

Datatype ScreenID   defined by restriction
 
dt base LSID
pattern (urn:lsid:)?(\S+\.\S+)+(:Screen)(:\S+)

Datatype SemiconductorLaserMedia   defined by restriction
 
dt base xs:string
possible values GaAs | GaAlAs

Datatype SolidStateLaserMedia   defined by restriction
 
dt base xs:string
possible values Nd-Glass | Nd-YAG | Er-Glass | Er-YAG | Ho-YLF | Ho-YAG | Ruby | Ti-Sapphire | Alexandrite