released-schema.2003-FC.ome.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of specification Show documentation
Show all versions of specification Show documentation
The OME Data Model specification
Open Microscopy Environment
OME XML Schema 1.0 FC-TIFF
Author: Ilya G. Goldberg
Copyright (C) 2002-2011 Open Microscopy Environment
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.
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.
Physical size of a pixel
Physical size of a pixel
Physical size of a pixel
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.
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)
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'.
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.
Dimensional size of pixel data array
Dimensional size of pixel data array
Dimensional size of pixel data array
Dimensional size of pixel data array
Dimensional size of pixel data array
Gives the IFD(s) for which this element is applicable.
Indexed from 0. Default is 0 (the first IFD).
Gives the Z position of the image plane at the specified IFD.
Indexed from 0. Default is 0 (the first Z position).
Gives the T position of the image plane at the specified IFD.
Indexed from 0. Default is 0 (the first T position).
Gives the C position of the image plane at the specified IFD.
Indexed from 0. Default is 0 (the first C position).
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.
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.
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.
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.
Specifies to display the image as greyscale or RGB
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.
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.
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.
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.
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
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
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.
The StageLabel is used to specify a name and position for a stage position in the microscope's reference frame.
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.
This is the username of the experimenter (in a 'unix' or 'database' sense).
First name, optionally containing a middle initial.
A person's last or surname.
A person's email address.
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.
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.
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.
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.
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'.
The magnification of the lens - i.e. '60.0' is a 60X lens.
The numerical aperture of the lens expressed as a floating point (real) number.
Excitation filter manufacturer specification.
The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
Emission filter manufacturer specification.
The optional Type attribute may contain 'LongPass', 'ShortPass', 'BandPass', or 'MultiPass'.
Filter set manufacturer specification
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'.
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.
The microscope's manufacturer specification.
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.
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.
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.
This empty element has a required Experimenter ID and an optional DocumentID attribute which refers to one of the Experimenters defined within OME.
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.
Contact information for a Group leader specified using a reference to an Experimenter element defined elsewhere in the document.
An element type to specify an Experimenter under OME.
It consists of a Person element group and a login name specified under OMEName.
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.
This empty element has a reference (the Group ID attribute) to a Group defined within OME.
This empty element can be used (via the required Instrument ID attribute) to refer to an Instrument defined within OME.
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.
The dichroic mirror used for this filter combination.
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.
An element type specifying a filter specification.
Unlike the ManufactSpec, filters are referred to by lot number rather than serial number.
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.
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.
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.
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.
The Temperature is in Celsius, AirPressure is in millibars, Humidity and CO2Percent are percent-fractions from 0.0 to 1.0.
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.
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.
An index into the channel dimension of the 5-D pixel array
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.
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.
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.
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).
Specifies the channel number in the pixel dump. Channels are numbered from 0.
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.
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.