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