Coordinates schemas
Coordinate systems describe where a procedure, an experimental interface or a piece of equipment is placed. Each system is a schema; the record stores the system code and the values in the frame it defines.
Table of contents
- How to use this family
- Quick type map
- External coordinates
- Stereotaxic coordinates
- Landmark-referenced coordinates
- Spinal coordinates
- Standardized reference spaces
- Brain/MINDS Marmoset Atlas 2.0 XYZ Absolute Coordinates
- Allen Mouse CCFv3 XYZ Absolute Coordinates
- JRC2018 Unisex Fly Brain XYZ Absolute Coordinates
- MNI152 ICBM 2009c Human XYZ Absolute Coordinates
- mapzebrain Larval Zebrafish XYZ Absolute Coordinates
- NIMH Macaque Template v2 XYZ Absolute Coordinates
- Waxholm Space Rat Brain Atlas v4 XYZ Absolute Coordinates
- Specimen coordinates
- Container coordinates
How to use this family
equipment: setcoordinates_systemto a type code below and send its properties incoordinates_details.experimentalinterface: setcoordinatesto a type code below and send its properties incoordinates_json.experimentalinterfacetemplate: setcoordinatesto a type code below and send its properties incoordinates_json.procedure: setcoordinates_systemto a type code below and send its properties incoordinates_details.proceduretemplate: setcoordinates_systemto a type code below and send its properties incoordinates_details.- Every version is published at
https://www.brainstem.org/schemas/Coordinates/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/Coordinates/<Type>.jsonis the current version andhttps://www.brainstem.org/schemas/Coordinates/<Type>/lists the versions. See Public schemas. - Quantities are objects
{"value": <number>, "unit": "<code>"}. Property paths with[]are inside a repeatable list of rows. The server sets the schema version field itself.
Quick type map
| Type code | Title | Group | Version | Required properties | Schema |
|---|---|---|---|---|---|
BMA_XYZ_Absolute | Brain/MINDS Marmoset Atlas 2.0 XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
CCF_XYZ_Absolute | Allen Mouse CCFv3 XYZ Absolute Coordinates | Standardized reference spaces | 2.1.0 | none | 2.1.0.json |
ContainerGrid_RC | Container Grid Well Coordinates | Container coordinates | 1.0.0 | none | 1.0.0.json |
ContainerLocal_XYZ | Container-Local XYZ Coordinates | Container coordinates | 1.0.0 | none | 1.0.0.json |
External_XYZ_Euler | External XYZ Coordinates with Euler Orientation | External coordinates | 2.0.0 | referenceFrameName, referenceFrameDescription | 2.0.0.json |
External_XYZ_Quaternion | External XYZ Coordinates with Quaternion Orientation | External coordinates | 1.0.0 | referenceFrameName, referenceFrameDescription, quaternionW, quaternionX, quaternionY, quaternionZ | 1.0.0.json |
JRC2018U_XYZ_Absolute | JRC2018 Unisex Fly Brain XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
Landmark_APMLDV_Absolute | Landmark-Referenced AP/ML/DV Absolute Coordinates | Landmark-referenced coordinates | 1.0.0 | none | 1.0.0.json |
Landmark_APML_SurfaceDepth | Landmark-Referenced AP/ML Surface Coordinates with Depth | Landmark-referenced coordinates | 1.0.0 | none | 1.0.0.json |
MNI152_XYZ_Absolute | MNI152 ICBM 2009c Human XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
MapZebrain_XYZ_Absolute | mapzebrain Larval Zebrafish XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
NMT_XYZ_Absolute | NIMH Macaque Template v2 XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
SpecimenSurface_XY | Specimen Surface XY Coordinates | Specimen coordinates | 1.0.0 | none | 1.0.0.json |
SpecimenSurface_XYDepth | Specimen Surface XY Coordinates with Depth | Specimen coordinates | 1.0.0 | none | 1.0.0.json |
SpecimenVolume_XYZ | Specimen Volume XYZ Coordinates | Specimen coordinates | 1.0.0 | none | 1.0.0.json |
Spinal_RCMLDV_Absolute | Spinal RC/ML/DV Absolute Coordinates | Spinal coordinates | 1.0.0 | none | 1.0.0.json |
Spinal_RCML_SurfaceDepth | Spinal RC/ML Surface Coordinates with Depth | Spinal coordinates | 1.0.0 | none | 1.0.0.json |
Stereotaxic_BregmaAbsolute | Stereotaxic Bregma-Based Absolute Coordinates | Stereotaxic coordinates | 2.0.0 | none | 2.0.0.json |
Stereotaxic_BregmaBrainSurface | Stereotaxic Bregma-Based Surface Coordinates with Depth | Stereotaxic coordinates | 2.0.0 | none | 2.0.0.json |
Stereotaxic_LambdaAbsolute | Stereotaxic Lambda-Based Absolute Coordinates | Stereotaxic coordinates | 2.0.0 | none | 2.0.0.json |
Stereotaxic_LambdaBrainSurface | Stereotaxic Lambda-Based Surface Coordinates with Depth | Stereotaxic coordinates | 2.0.0 | none | 2.0.0.json |
WHS_XYZ_Absolute | Waxholm Space Rat Brain Atlas v4 XYZ Absolute Coordinates | Standardized reference spaces | 1.0.0 | none | 1.0.0.json |
External coordinates
External XYZ Coordinates with Euler Orientation
- type code
External_XYZ_Euler· version 2.0.0 · schema
Position in a declared external reference frame, such as a rig or stage frame, whose origin, axes, handedness and unrotated pose are defined in the record, with orientation as fixed-frame X, Y then Z rotations. Use it when no anatomical or atlas frame applies.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
referenceFrameName | Reference frame name | text | yes | Short name identifying the external coordinate frame used for this point. | |
referenceFrameDescription | Reference frame description | text (multi-line) | yes | Define the frame origin, +X/+Y/+Z directions, handedness, and unrotated object pose. | |
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical X position in the declared external reference frame. | |
xAngle | X angle | quantity with unit | units °; default {"unit": "°"} | First fixed-frame X rotation; positive is counter-clockwise viewed from +X toward origin. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical Y position in the declared external reference frame. | |
yAngle | Y angle | quantity with unit | units °; default {"unit": "°"} | Second fixed-frame Y rotation after X; positive is counter-clockwise viewed from +Y toward origin. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical Z position in the declared external reference frame. | |
zAngle | Z angle | quantity with unit | units °; default {"unit": "°"} | Third fixed-frame Z rotation after X then Y; positive is counter-clockwise viewed from +Z toward origin. |
Illustrative payload:
{
"referenceFrameName": "text",
"referenceFrameDescription": "text",
"x": {
"value": 1,
"unit": "m"
},
"xAngle": {
"value": 1,
"unit": "°"
}
}
External XYZ Coordinates with Quaternion Orientation
- type code
External_XYZ_Quaternion· version 1.0.0 · schema
Physical position and device orientation in a declared external reference frame. Quaternion values use the canonical Hamilton convention and rotate the declared device-local zero pose into the external frame.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
referenceFrameName | Reference frame name | text | yes | Short name identifying the external coordinate frame used for this pose. | |
referenceFrameDescription | Reference frame description | text (multi-line) | yes | Define the origin, +X/+Y/+Z directions, handedness, and device-local zero pose. | |
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical X position in the declared external reference frame. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical Y position in the declared external reference frame. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "m"} | Physical Z position in the declared external reference frame. | |
quaternionW | Quaternion W | number | yes | ≥ -1 and ≤ 1 | Scalar W component of the canonical unit Hamilton quaternion. |
quaternionX | Quaternion X | number | yes | ≥ -1 and ≤ 1 | X vector component of the canonical unit Hamilton quaternion. |
quaternionY | Quaternion Y | number | yes | ≥ -1 and ≤ 1 | Y vector component of the canonical unit Hamilton quaternion. |
quaternionZ | Quaternion Z | number | yes | ≥ -1 and ≤ 1 | Z vector component of the canonical unit Hamilton quaternion. |
Illustrative payload:
{
"referenceFrameName": "text",
"referenceFrameDescription": "text",
"quaternionW": 1.0,
"quaternionX": 1.0,
"quaternionY": 1.0,
"quaternionZ": 1.0,
"x": {
"value": 1,
"unit": "m"
},
"y": {
"value": 1,
"unit": "m"
}
}
Stereotaxic coordinates
Stereotaxic Bregma-Based Absolute Coordinates
- type code
Stereotaxic_BregmaAbsolute· version 2.0.0 · schema
Absolute AP/ML/DV position measured from Bregma, with +AP anterior, +ML anatomical right and +DV ventral, plus AP and ML tilts and an axial rotation. Use it when DV is given from Bregma rather than as depth from the brain surface.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed AP position of the absolute point from Bregma; positive is anterior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed ML position of the absolute point from Bregma; positive is anatomical right. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
dvCoordinate | DV coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed DV position of the absolute point from Bregma; positive is ventral. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"apCoordinate": {
"value": 1,
"unit": "mm"
},
"apAngle": {
"value": 1,
"unit": "°"
}
}
Stereotaxic Bregma-Based Surface Coordinates with Depth
- type code
Stereotaxic_BregmaBrainSurface· version 2.0.0 · schema
Insertion point given as AP/ML from Bregma (+AP anterior, +ML anatomical right) plus a non-negative depth along the final approach axis from brain-surface contact, not from the skull. Use it when depth is measured from where the device touches the brain.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed AP position of the brain-surface insertion point from Bregma; positive is anterior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed ML position of the brain-surface insertion point from Bregma; positive is anatomical right. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
depth | Depth | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Non-negative insertion depth along the final depth axis from brain-surface contact at the insertion point, not from the skull surface. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"apCoordinate": {
"value": 1,
"unit": "mm"
},
"apAngle": {
"value": 1,
"unit": "°"
}
}
Stereotaxic Lambda-Based Absolute Coordinates
- type code
Stereotaxic_LambdaAbsolute· version 2.0.0 · schema
Absolute AP/ML/DV position measured from Lambda, with +AP anterior, +ML anatomical right and +DV ventral, plus AP and ML tilts and an axial rotation. Use it when DV is given from Lambda rather than as depth from the brain surface.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed AP position of the absolute point from Lambda; positive is anterior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed ML position of the absolute point from Lambda; positive is anatomical right. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
dvCoordinate | DV coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed DV position of the absolute point from Lambda; positive is ventral. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"apCoordinate": {
"value": 1,
"unit": "mm"
},
"apAngle": {
"value": 1,
"unit": "°"
}
}
Stereotaxic Lambda-Based Surface Coordinates with Depth
- type code
Stereotaxic_LambdaBrainSurface· version 2.0.0 · schema
Insertion point given as AP/ML from Lambda (+AP anterior, +ML anatomical right) plus a non-negative depth along the final approach axis from brain-surface contact, not from the skull. Use it when depth is measured from where the device touches the brain.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed AP position of the brain-surface insertion point from Lambda; positive is anterior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Signed ML position of the brain-surface insertion point from Lambda; positive is anatomical right. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
depth | Depth | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Non-negative insertion depth along the final depth axis from brain-surface contact at the insertion point, not from the skull surface. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"apCoordinate": {
"value": 1,
"unit": "mm"
},
"apAngle": {
"value": 1,
"unit": "°"
}
}
Landmark-referenced coordinates
Landmark-Referenced AP/ML/DV Absolute Coordinates
- type code
Landmark_APMLDV_Absolute· version 1.0.0 · schema
Absolute AP/ML/DV position from a declared landmark that defines the zeros and axes, with +AP anterior, +ML right and +DV ventral, plus tilts and an axial rotation. Use it for landmarks other than Bregma and Lambda, such as the obex or a cranial window center.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
landmarkReference | Landmark reference | choice | one of obex, interaural_zero, anterior_commissure, midcommissural_point, cranial_window_center, surface_landmark, custom, other | Landmark defining complete AP, ML, and DV zeros and axes for the absolute frame. | |
landmarkDescription | Landmark description | text | Concise definition of the identity, 3-D origin, and AP/ML/DV axes of a surface, custom, or other landmark. | ||
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | AP position of the absolute point from the frame origin; positive is anterior. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | ML position of the absolute point from the frame origin; positive is anatomical right. | |
dvCoordinate | DV coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | DV position of the absolute point from the frame origin; positive is ventral. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"landmarkReference": "obex",
"landmarkDescription": "text"
}
Landmark-Referenced AP/ML Surface Coordinates with Depth
- type code
Landmark_APML_SurfaceDepth· version 1.0.0 · schema
Insertion point given as AP/ML from a declared landmark (+AP anterior, +ML anatomical right) plus a non-negative insertion depth along the final approach axis from a declared surface. Use it for landmark-referenced insertions where depth is measured from the contacted surface.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
landmarkReference | Landmark reference | choice | one of obex, interaural_zero, anterior_commissure, midcommissural_point, cranial_window_center, surface_landmark, custom, other | Landmark defining AP and ML zeros and axes for the insertion-point frame. | |
landmarkDescription | Landmark description | text | Concise definition of the identity, origin, and AP/ML axes of a surface, custom, or other landmark. | ||
surfaceReference | Insertion-depth reference surface | choice | one of skull_surface, dura_surface, pia_surface, brain_surface, brainstem_surface, cord_surface, custom | Physical interface at the insertion point from which insertion depth begins. | |
surfaceReferenceDescription | Surface reference description | text | Concise physical definition of the custom surface used as insertion-depth zero. | ||
apCoordinate | AP coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | AP position of the surface insertion point from the landmark; positive is anterior. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | ML position of the surface insertion point from the landmark; positive is anatomical right. | |
depth | Insertion depth | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Non-negative insertion depth along the final depth axis from contact with the selected surface at the insertion point. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"landmarkReference": "obex",
"landmarkDescription": "text"
}
Spinal coordinates
Spinal RC/ML/DV Absolute Coordinates
- type code
Spinal_RCMLDV_Absolute· version 1.0.0 · schema
Absolute spinal position from an origin on the cord central axis at a declared segment or vertebral level, with +RC rostral along the cord centerline, +ML right of midline and +DV ventral, plus RC and ML tilts and an axial rotation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
referenceMode | Reference mode | choice | one of spinal_segment, vertebral_level, custom | The anatomical convention anchoring the frame; vertebral references project onto the cord central axis. | |
referenceLevel | Reference level | text | The spinal segment or vertebral level containing the rostrocaudal origin. | ||
referenceFeature | Reference feature | choice | one of rostral_boundary, center, caudal_boundary, interlevel_junction, observed_landmark, custom | The feature fixing the frame origin: the point on the cord central axis at this rostrocaudal position. | |
referenceDescription | Reference description | text | A concise physical definition of the custom or observed reference point in all three axes. | ||
rcCoordinate | RC coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Rostral-positive position from the declared origin along the local cord centerline. | |
rcAngle | RC angle | quantity with unit | units °; default {"unit": "°"} | First approach rotation around ML; 0° follows the depth axis and positive tilts rostrally. | |
mlCoordinate | ML coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Right-positive position from the spinal cord midline. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second approach rotation around RC after RC tilt; positive tilts to anatomical right. | |
dvCoordinate | DV coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Ventral-positive absolute position from the cord central axis at the declared origin. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"referenceMode": "spinal_segment",
"referenceLevel": "text"
}
Spinal RC/ML Surface Coordinates with Depth
- type code
Spinal_RCML_SurfaceDepth· version 1.0.0 · schema
Spinal insertion point given as RC/ML from a declared segment or vertebral reference (+RC rostral, +ML right of midline) plus a non-negative insertion depth from a declared surface. Use it for spinal injections or electrode insertions with depth measured from the contacted surface.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
referenceMode | Reference mode | choice | one of spinal_segment, vertebral_level, custom | The anatomical convention used to anchor the spinal frame. | |
referenceLevel | Reference level | text | The spinal segment or vertebral level containing the rostrocaudal origin. | ||
referenceFeature | Reference feature | choice | one of rostral_boundary, center, caudal_boundary, interlevel_junction, observed_landmark, custom | The exact feature within or between levels that defines rostrocaudal zero. | |
referenceDescription | Reference description | text | A concise physical definition of a custom or observed spinal reference. | ||
surfaceReference | Depth reference surface | choice | one of dura_surface, pia_surface, cord_surface, custom | Physical interface at the insertion point from which insertion depth begins. | |
surfaceReferenceDescription | Surface reference description | text | A concise physical definition of a custom depth-reference surface. | ||
rcCoordinate | RC insertion coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Rostral-positive insertion-point position from the declared origin along the local cord centerline. | |
rcAngle | RC angle | quantity with unit | units °; default {"unit": "°"} | First approach rotation around ML; 0° follows the depth axis and positive tilts rostrally. | |
mlCoordinate | ML insertion coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Right-positive insertion-point position from the spinal cord midline. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second approach rotation around RC after RC tilt; positive tilts to anatomical right. | |
depth | Insertion depth | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Non-negative insertion depth along the final depth axis from contact with the selected surface at the insertion point. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise rotation around the object’s depth axis when viewed from above; 0° aligns the major feature defined for the selected anchor type with the coronal plane. |
Illustrative payload:
{
"referenceMode": "spinal_segment",
"referenceLevel": "text"
}
Standardized reference spaces
Brain/MINDS Marmoset Atlas 2.0 XYZ Absolute Coordinates
- type code
BMA_XYZ_Absolute· version 1.0.0 · schema
Absolute position in Brain/MINDS Marmoset Atlas 2.0 space, measured from the atlas origin between the commissures (not ear bar zero), with +X anatomical right, +Y anterior and +Z superior, plus AP and ML tilts and an axial roll. Use it for marmoset targets.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the BMA 2.0 atlas origin (between the commissures, not ear bar zero); positive X is anatomical right. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the BMA 2.0 atlas origin (between the commissures, not ear bar zero); positive Y is anterior. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the BMA 2.0 atlas origin (between the commissures, not ear bar zero); positive Z is superior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First tilt from inferior vertical; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second tilt after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "mm"
},
"y": {
"value": 1,
"unit": "mm"
}
}
Allen Mouse CCFv3 XYZ Absolute Coordinates
- type code
CCF_XYZ_Absolute· version 2.1.0 · schema
Absolute position in Allen Mouse CCFv3 space, measured from the anterior-superior-left origin with +X posterior, +Y ventral and +Z right, plus two tilts and an axial roll. Use it for mouse targets planned in or registered to the Allen atlas.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the CCFv3 anterior-superior-left origin; positive X is posterior. | |
xAngle | X angle | quantity with unit | units °; default {"unit": "°"} | First tilt from +Y in the X-Y sagittal plane; positive tilts toward anterior (-X). | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the CCFv3 anterior-superior-left origin; positive Y is inferior or ventral. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the CCFv3 anterior-superior-left origin; positive Z is rightward. | |
zAngle | Z angle | quantity with unit | units °; default {"unit": "°"} | Second tilt in the Y-Z coronal plane after X tilt; positive tilts toward right (+Z). | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll: clockwise from above; 0° aligns the anchor type’s major feature with coronal plane. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "mm"
},
"xAngle": {
"value": 1,
"unit": "°"
}
}
JRC2018 Unisex Fly Brain XYZ Absolute Coordinates
- type code
JRC2018U_XYZ_Absolute· version 1.0.0 · schema
Absolute position in the JRC2018 Unisex Drosophila brain template, measured from the volume corner with +X toward the fly’s left, +Y ventral and +Z posterior (anterior-view stack convention), plus two tilts and an axial roll. Use it for fly brain targets.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the JRC2018U volume corner; positive X is toward the fly’s left. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the JRC2018U volume corner; positive Y is ventral per the anterior-view stack convention. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the JRC2018U volume corner; positive Z is posterior per the anterior-view stack convention. | |
zAngle | Z angle | quantity with unit | units °; default {"unit": "°"} | First tilt from ventral vertical in the Y-Z sagittal plane; positive tilts toward anterior (-Z). | |
xAngle | X angle | quantity with unit | units °; default {"unit": "°"} | Second tilt in the X-Y coronal plane after the Z tilt; positive tilts toward the fly’s right (-X). | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "µm"
},
"y": {
"value": 1,
"unit": "µm"
}
}
MNI152 ICBM 2009c Human XYZ Absolute Coordinates
- type code
MNI152_XYZ_Absolute· version 1.0.0 · schema
Absolute position in MNI152 ICBM 2009c human template space, measured from the anterior-commissure origin with +X anatomical right, +Y anterior and +Z superior, plus AP and ML tilts and an axial roll. Use it for human targets in MNI space.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the MNI anterior-commissure origin; positive X is anatomical right. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the MNI anterior-commissure origin; positive Y is anterior. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the MNI anterior-commissure origin; positive Z is superior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First tilt from inferior vertical; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second tilt after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "mm"
},
"y": {
"value": 1,
"unit": "mm"
}
}
mapzebrain Larval Zebrafish XYZ Absolute Coordinates
- type code
MapZebrain_XYZ_Absolute· version 1.0.0 · schema
Absolute position in the mapzebrain larval zebrafish atlas, measured from the volume corner with +X anatomical right, +Y posterior and +Z superior, plus two tilts and an axial roll. Use it for larval zebrafish brain targets.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the mapzebrain volume corner; positive X is anatomical right. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the mapzebrain volume corner; positive Y is posterior. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Physical distance from the mapzebrain volume corner; positive Z is superior per the BrainGlobe source-orientation record. | |
yAngle | Y angle | quantity with unit | units °; default {"unit": "°"} | First tilt from inferior vertical in the Y-Z sagittal plane; positive tilts toward anterior (-Y). | |
xAngle | X angle | quantity with unit | units °; default {"unit": "°"} | Second tilt in the X-Z coronal plane after the Y tilt; positive tilts toward right (+X). | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "µm"
},
"y": {
"value": 1,
"unit": "µm"
}
}
NIMH Macaque Template v2 XYZ Absolute Coordinates
- type code
NMT_XYZ_Absolute· version 1.0.0 · schema
Absolute position in NIMH Macaque Template v2 space, measured from ear bar zero with +X anatomical right, +Y anterior and +Z superior, plus AP and ML tilts and an axial roll. Use it for macaque targets in NMT v2.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from ear bar zero; positive X is anatomical right. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from ear bar zero; positive Y is anterior. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from ear bar zero; positive Z is superior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First tilt from inferior vertical; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second tilt after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "mm"
},
"y": {
"value": 1,
"unit": "mm"
}
}
Waxholm Space Rat Brain Atlas v4 XYZ Absolute Coordinates
- type code
WHS_XYZ_Absolute· version 1.0.0 · schema
Absolute position in Waxholm Space rat brain atlas v4, measured from the WHS origin with +X anatomical right, +Y anterior and +Z superior, plus AP and ML tilts and an axial roll. Use it for rat targets in WHS space.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the WHS origin; positive X is anatomical right. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the WHS origin; positive Y is anterior. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical distance from the WHS origin; positive Z is superior. | |
apAngle | AP angle | quantity with unit | units °; default {"unit": "°"} | First tilt from inferior vertical; positive tilts anteriorly. | |
mlAngle | ML angle | quantity with unit | units °; default {"unit": "°"} | Second tilt after the AP tilt; positive tilts to anatomical right. | |
rotation | Rotation | quantity with unit | units °; default {"unit": "°"} | Final axial roll around the placed object’s approach axis. |
Illustrative payload:
{
"x": {
"value": 1,
"unit": "mm"
},
"y": {
"value": 1,
"unit": "mm"
}
}
Specimen coordinates
Specimen Surface XY Coordinates
- type code
SpecimenSurface_XY· version 1.0.0 · schema
Two-dimensional position on a specimen surface, with a declared origin, a mapping of specimen directions to +X and +Y and a clockwise in-plane rotation. Use it for surface locations on ex-vivo specimens, such as slices or whole mounts, where depth is not needed.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
originType | Origin | choice | one of center, top_left, top_right, bottom_left, bottom_right, landmark, embedding_block_origin, custom | Origin convention for the specimen-surface XY frame. | |
originDescription | Origin description | text | Define the physical point and axes for a landmark or custom origin. | ||
specimenOrientation | Specimen orientation | text | Map specimen anatomical or preparation directions to positive X and Y. | ||
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical X position on the declared specimen surface. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Y position on the declared specimen surface. | |
rotation | In-plane rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise viewed toward the surface; 0° aligns the anchor major feature with +Y. |
Illustrative payload:
{
"originType": "center",
"originDescription": "text"
}
Specimen Surface XY Coordinates with Depth
- type code
SpecimenSurface_XYDepth· version 1.0.0 · schema
Insertion point on a specimen surface, given as X/Y from a declared origin, plus insertion depth from a declared surface and an axial rotation. Use it for electrodes or pipettes entering an ex-vivo specimen from its surface.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
originType | XY origin | choice | one of center, top_left, top_right, bottom_left, bottom_right, landmark, embedding_block_origin, custom | Origin convention for the specimen-surface XY frame. | |
originDescription | XY origin description | text | Define the physical point and axes for a landmark or custom origin. | ||
specimenOrientation | Specimen orientation | text | Map specimen anatomical or preparation directions to positive X and Y. | ||
surfaceReference | Insertion-depth reference surface | choice | one of exposed_specimen_surface, cut_face, slice_surface, pia_surface, coverslip_surface, custom | Physical interface at the insertion point where insertion depth begins. | |
surfaceReferenceDescription | Surface reference description | text | For a custom surface, define the physical interface used as insertion-depth zero. | ||
x | X insertion coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical X position of the specimen-surface insertion point. | |
y | Y insertion coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Y position of the specimen-surface insertion point. | |
depth | Insertion depth | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Insertion distance along the final depth axis from the selected surface at entry. | |
rotation | Axial rotation | quantity with unit | units °; default {"unit": "°"} | Clockwise about final depth axis from above; 0° aligns the anchor major feature with +Y. |
Illustrative payload:
{
"originType": "center",
"originDescription": "text"
}
Specimen Volume XYZ Coordinates
- type code
SpecimenVolume_XYZ· version 1.0.0 · schema
Three-dimensional position within a specimen, with a declared origin, a mapping of specimen directions to +X, +Y and +Z, and orientation as fixed-frame X, Y then Z rotations. Use it for locations inside cleared tissue, explants or other volumetric specimens.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
originType | Origin | choice | one of center, rostral_dorsal_left_corner, embedding_block_origin, landmark, custom | Origin convention for the specimen-volume XYZ frame. | |
originDescription | Origin description | text | Define the physical point and axes for a landmark or custom origin. | ||
specimenOrientation | Specimen orientation | text | Map specimen directions to +X/+Y/+Z; with the anchor major feature, this defines zero pose. | ||
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical X position in the declared specimen-volume frame. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Y position in the declared specimen-volume frame. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Z position in the declared specimen-volume frame. | |
xAngle | X angle | quantity with unit | units °; default {"unit": "°"} | First fixed-frame X rotation from zero; positive is counter-clockwise viewed from +X toward origin. | |
yAngle | Y angle | quantity with unit | units °; default {"unit": "°"} | Second fixed-frame Y rotation after X; positive is counter-clockwise viewed from +Y toward origin. | |
zAngle | Z angle | quantity with unit | units °; default {"unit": "°"} | Third fixed-frame Z rotation after X then Y; positive is counter-clockwise viewed from +Z toward origin. |
Illustrative payload:
{
"originType": "center",
"originDescription": "text"
}
Container coordinates
Container Grid Well Coordinates
- type code
ContainerGrid_RC· version 1.0.0 · schema
Location in a multiwell plate or gridded container, given as a well ID (A1 top-left, rows increasing back or down, columns increasing right) and an X/Y offset from the well center. Use it for specimens held in labware wells.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
well | Well | text | Well ID such as A1: A1 is top-left; rows increase back/down and columns increase right. | ||
offsetX | X offset from well center | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical offset from well center; positive X is right in the labware view. | |
offsetY | Y offset from well center | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical offset from well center; positive Y is back/down in the labware view. |
Illustrative payload:
{
"well": "text",
"offsetX": {
"value": 1,
"unit": "mm"
}
}
Container-Local XYZ Coordinates
- type code
ContainerLocal_XYZ· version 1.0.0 · schema
Position in an XYZ frame attached to a container, with a declared origin and a mapping of container +X, +Y and +Z to the preparation or setup. Use it when a location is best given relative to the container rather than the specimen.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
originType | Origin | choice | one of center, dish_center, insert_center, well_center, custom | Origin convention for the container-local XYZ frame. | |
originDescription | Origin description | text | Define the physical point and axes for a custom container origin. | ||
containerOrientation | Container orientation | text | Map container-local positive X, Y, and Z to the preparation or setup. | ||
x | X coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical X position in the declared container-local frame. | |
y | Y coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Y position in the declared container-local frame. | |
z | Z coordinate | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Physical Z position in the declared container-local frame. |
Illustrative payload:
{
"originType": "center",
"originDescription": "text"
}