released-schema.2012-06.ROI.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
ROIs
A four dimensional 'Region of Interest'.
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.
A description for the ROI. [plane text multi-line string]
The Name identifies the ROI to the user. [plane text string]
Shapes
The shape element contains a single specific ROI shape and links
that to any channels, and a timepoint and a z-section. It also
records any transform applied to the ROI shape.
This is a matrix used to transform the shape.
The element has 6 xsd:float attributes. If the element
is present then all 6 values must be included.
The color of the fill - encoded as RGBA
The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value)
NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.
The rule used to decide which parts of the shape to
fill. [enumeration]
The color of the stroke - encoded as RGBA
The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value)
NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.
The width of the stroke [units pixels]
e.g. "none", "10 20 30 10"
The shape of the end of the line. [enumeration]
The font family used to draw the text. [enumeration]
Note: these values are all lower case so they match
the standard HTML/CSS values. "fantasy" has been
included for completeness we do not recommended its
regular use.
Size of the font [units points]
The style and weight applied to the text. [enumeration]
This is a simplified combination of the HTML/CSS
attributes font-style AND font-weight.
Controls whether the shape is currently visible,
true is visible, false is hidden.
Controls whether the shape is locked and read only,
true is locked, false is editable.
The z-section the ROI applies to. If not specified then
the ROI applies to all the z-sections of the image. [units:none]
This is numbered from 0.
The timepoint the ROI applies to. If not specified then
the ROI applies to all the timepoints of the image. [units:none]
This is numbered from 0.
The channel the ROI applies to. If not specified then
the ROI applies to all the channels of the image. [units:none]
This is numbered from 0.
Rectangles
A simple rectangle object. If rotation is required apply a
transformation at the Shape level.
The X value of the left edge or the rectangle. [units pixels]
The y value of the top edge or the rectangle. [units pixels]
The width of the rectangle. [units pixels]
The height of the rectangle. [units pixels]
Masks
The Mask ROI shape is a link to a BIN:BinData object that is
a BIT mask drawn on top of the image as an ROI. It is applied
at the same scale, pixel to pixel, as the Image the ROI is
applied to, unless a transform is applied at the shape level.
The X coordinate of the left side of the image. [units pixels]
The Y coordinate of the top side of the image. [units pixels]
The width of the mask. [units pixels]
The height of the mask. [units pixels]
Points
The X coordinate of the point. [units pixels]
The Y coordinate of the point. [units pixels]
Ellipses
A simple ellipse object. If rotation is required apply a
transformation at the Shape level.
The X coordinate of the center of the ellipse. [units pixels]
The Y coordinate of the center of the ellipse. [units pixels]
The horizontal radius of the ellipse. [units pixels]
The vertical radius of the ellipse. [units pixels]
Lines
A straight line defined by it's end points.
The X coordinate of the start of the line. [units pixels]
The Y coordinate of the start of the line. [units pixels]
The X coordinate of the end of the line. [units pixels]
The Y coordinate of the end of the line. [units pixels]
Polylines
The Polyline defines open shapes formed of straight
lines. Note: Polyline uses counterclockwise winding (this is the
default OpenGL behavior)
The points of the polyline are defined as a list of comma
separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g.
"0,0 1,2 3,5"
Polygons
The Polygon defines closed shapes formed of straight
lines. Note: Polygon uses counterclockwise winding (this is the
default OpenGL behavior)
The points of the Polygon are defined as a list of comma
separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g.
"0,0 1,2 3,5"
Labels
The text label. Any transformation should be applied at the
shape level.
This defines the X coordinate of the current text position
of the first character in the string. [units pixels]
This defines the Y coordinate of the current text position
of the first character in the string. [units pixels]
This is a matrix used to transform the shape.
-- --
| A00, A01, A02 |
| A10, A11, A12 |
| 0, 0, 1 |
-- --
Markers
Shape of marker on the end of a line. [enumeration]