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

  1. How to use this family
  2. Quick type map
  3. External coordinates
    1. External XYZ Coordinates with Euler Orientation
    2. External XYZ Coordinates with Quaternion Orientation
  4. Stereotaxic coordinates
    1. Stereotaxic Bregma-Based Absolute Coordinates
    2. Stereotaxic Bregma-Based Surface Coordinates with Depth
    3. Stereotaxic Lambda-Based Absolute Coordinates
    4. Stereotaxic Lambda-Based Surface Coordinates with Depth
  5. Landmark-referenced coordinates
    1. Landmark-Referenced AP/ML/DV Absolute Coordinates
    2. Landmark-Referenced AP/ML Surface Coordinates with Depth
  6. Spinal coordinates
    1. Spinal RC/ML/DV Absolute Coordinates
    2. Spinal RC/ML Surface Coordinates with Depth
  7. Standardized reference spaces
    1. Brain/MINDS Marmoset Atlas 2.0 XYZ Absolute Coordinates
    2. Allen Mouse CCFv3 XYZ Absolute Coordinates
    3. JRC2018 Unisex Fly Brain XYZ Absolute Coordinates
    4. MNI152 ICBM 2009c Human XYZ Absolute Coordinates
    5. mapzebrain Larval Zebrafish XYZ Absolute Coordinates
    6. NIMH Macaque Template v2 XYZ Absolute Coordinates
    7. Waxholm Space Rat Brain Atlas v4 XYZ Absolute Coordinates
  8. Specimen coordinates
    1. Specimen Surface XY Coordinates
    2. Specimen Surface XY Coordinates with Depth
    3. Specimen Volume XYZ Coordinates
  9. Container coordinates
    1. Container Grid Well Coordinates
    2. Container-Local XYZ Coordinates

How to use this family

  • equipment: set coordinates_system to a type code below and send its properties in coordinates_details.
  • experimentalinterface: set coordinates to a type code below and send its properties in coordinates_json.
  • experimentalinterfacetemplate: set coordinates to a type code below and send its properties in coordinates_json.
  • procedure: set coordinates_system to a type code below and send its properties in coordinates_details.
  • proceduretemplate: set coordinates_system to a type code below and send its properties in coordinates_details.
  • Every version is published at https://www.brainstem.org/schemas/Coordinates/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/Coordinates/<Type>.json is the current version and https://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 codeTitleGroupVersionRequired propertiesSchema
BMA_XYZ_AbsoluteBrain/MINDS Marmoset Atlas 2.0 XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.0.0.json
CCF_XYZ_AbsoluteAllen Mouse CCFv3 XYZ Absolute CoordinatesStandardized reference spaces2.1.0none2.1.0.json
ContainerGrid_RCContainer Grid Well CoordinatesContainer coordinates1.0.0none1.0.0.json
ContainerLocal_XYZContainer-Local XYZ CoordinatesContainer coordinates1.0.0none1.0.0.json
External_XYZ_EulerExternal XYZ Coordinates with Euler OrientationExternal coordinates2.0.0referenceFrameName, referenceFrameDescription2.0.0.json
External_XYZ_QuaternionExternal XYZ Coordinates with Quaternion OrientationExternal coordinates1.0.0referenceFrameName, referenceFrameDescription, quaternionW, quaternionX, quaternionY, quaternionZ1.0.0.json
JRC2018U_XYZ_AbsoluteJRC2018 Unisex Fly Brain XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.0.0.json
Landmark_APMLDV_AbsoluteLandmark-Referenced AP/ML/DV Absolute CoordinatesLandmark-referenced coordinates1.0.0none1.0.0.json
Landmark_APML_SurfaceDepthLandmark-Referenced AP/ML Surface Coordinates with DepthLandmark-referenced coordinates1.0.0none1.0.0.json
MNI152_XYZ_AbsoluteMNI152 ICBM 2009c Human XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.0.0.json
MapZebrain_XYZ_Absolutemapzebrain Larval Zebrafish XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.0.0.json
NMT_XYZ_AbsoluteNIMH Macaque Template v2 XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.0.0.json
SpecimenSurface_XYSpecimen Surface XY CoordinatesSpecimen coordinates1.0.0none1.0.0.json
SpecimenSurface_XYDepthSpecimen Surface XY Coordinates with DepthSpecimen coordinates1.0.0none1.0.0.json
SpecimenVolume_XYZSpecimen Volume XYZ CoordinatesSpecimen coordinates1.0.0none1.0.0.json
Spinal_RCMLDV_AbsoluteSpinal RC/ML/DV Absolute CoordinatesSpinal coordinates1.0.0none1.0.0.json
Spinal_RCML_SurfaceDepthSpinal RC/ML Surface Coordinates with DepthSpinal coordinates1.0.0none1.0.0.json
Stereotaxic_BregmaAbsoluteStereotaxic Bregma-Based Absolute CoordinatesStereotaxic coordinates2.0.0none2.0.0.json
Stereotaxic_BregmaBrainSurfaceStereotaxic Bregma-Based Surface Coordinates with DepthStereotaxic coordinates2.0.0none2.0.0.json
Stereotaxic_LambdaAbsoluteStereotaxic Lambda-Based Absolute CoordinatesStereotaxic coordinates2.0.0none2.0.0.json
Stereotaxic_LambdaBrainSurfaceStereotaxic Lambda-Based Surface Coordinates with DepthStereotaxic coordinates2.0.0none2.0.0.json
WHS_XYZ_AbsoluteWaxholm Space Rat Brain Atlas v4 XYZ Absolute CoordinatesStandardized reference spaces1.0.0none1.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.

PropertyTitleShapeRequiredAllowed valuesMeaning
referenceFrameNameReference frame nametextyes Short name identifying the external coordinate frame used for this point.
referenceFrameDescriptionReference frame descriptiontext (multi-line)yes Define the frame origin, +X/+Y/+Z directions, handedness, and unrotated object pose.
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical X position in the declared external reference frame.
xAngleX anglequantity with unit units °; default {"unit": "°"}First fixed-frame X rotation; positive is counter-clockwise viewed from +X toward origin.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical Y position in the declared external reference frame.
yAngleY anglequantity with unit units °; default {"unit": "°"}Second fixed-frame Y rotation after X; positive is counter-clockwise viewed from +Y toward origin.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical Z position in the declared external reference frame.
zAngleZ anglequantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
referenceFrameNameReference frame nametextyes Short name identifying the external coordinate frame used for this pose.
referenceFrameDescriptionReference frame descriptiontext (multi-line)yes Define the origin, +X/+Y/+Z directions, handedness, and device-local zero pose.
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical X position in the declared external reference frame.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical Y position in the declared external reference frame.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "m"}Physical Z position in the declared external reference frame.
quaternionWQuaternion Wnumberyes≥ -1 and ≤ 1Scalar W component of the canonical unit Hamilton quaternion.
quaternionXQuaternion Xnumberyes≥ -1 and ≤ 1X vector component of the canonical unit Hamilton quaternion.
quaternionYQuaternion Ynumberyes≥ -1 and ≤ 1Y vector component of the canonical unit Hamilton quaternion.
quaternionZQuaternion Znumberyes≥ -1 and ≤ 1Z 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed AP position of the absolute point from Bregma; positive is anterior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlCoordinateML coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed ML position of the absolute point from Bregma; positive is anatomical right.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
dvCoordinateDV coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed DV position of the absolute point from Bregma; positive is ventral.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed AP position of the brain-surface insertion point from Bregma; positive is anterior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlCoordinateML coordinatequantity 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.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
depthDepthquantity 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.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed AP position of the absolute point from Lambda; positive is anterior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlCoordinateML coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed ML position of the absolute point from Lambda; positive is anatomical right.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
dvCoordinateDV coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed DV position of the absolute point from Lambda; positive is ventral.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Signed AP position of the brain-surface insertion point from Lambda; positive is anterior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlCoordinateML coordinatequantity 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.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
depthDepthquantity 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.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
landmarkReferenceLandmark referencechoice one of obex, interaural_zero, anterior_commissure, midcommissural_point, cranial_window_center, surface_landmark, custom, otherLandmark defining complete AP, ML, and DV zeros and axes for the absolute frame.
landmarkDescriptionLandmark descriptiontext  Concise definition of the identity, 3-D origin, and AP/ML/DV axes of a surface, custom, or other landmark.
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}AP position of the absolute point from the frame origin; positive is anterior.
mlCoordinateML coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}ML position of the absolute point from the frame origin; positive is anatomical right.
dvCoordinateDV coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}DV position of the absolute point from the frame origin; positive is ventral.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
landmarkReferenceLandmark referencechoice one of obex, interaural_zero, anterior_commissure, midcommissural_point, cranial_window_center, surface_landmark, custom, otherLandmark defining AP and ML zeros and axes for the insertion-point frame.
landmarkDescriptionLandmark descriptiontext  Concise definition of the identity, origin, and AP/ML axes of a surface, custom, or other landmark.
surfaceReferenceInsertion-depth reference surfacechoice one of skull_surface, dura_surface, pia_surface, brain_surface, brainstem_surface, cord_surface, customPhysical interface at the insertion point from which insertion depth begins.
surfaceReferenceDescriptionSurface reference descriptiontext  Concise physical definition of the custom surface used as insertion-depth zero.
apCoordinateAP coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}AP position of the surface insertion point from the landmark; positive is anterior.
mlCoordinateML coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}ML position of the surface insertion point from the landmark; positive is anatomical right.
depthInsertion depthquantity 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.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First rotation: sagittal tilt from vertical around the ML axis; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second rotation: coronal tilt from vertical around the AP axis, after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
referenceModeReference modechoice one of spinal_segment, vertebral_level, customThe anatomical convention anchoring the frame; vertebral references project onto the cord central axis.
referenceLevelReference leveltext  The spinal segment or vertebral level containing the rostrocaudal origin.
referenceFeatureReference featurechoice one of rostral_boundary, center, caudal_boundary, interlevel_junction, observed_landmark, customThe feature fixing the frame origin: the point on the cord central axis at this rostrocaudal position.
referenceDescriptionReference descriptiontext  A concise physical definition of the custom or observed reference point in all three axes.
rcCoordinateRC coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Rostral-positive position from the declared origin along the local cord centerline.
rcAngleRC anglequantity with unit units °; default {"unit": "°"}First approach rotation around ML; 0° follows the depth axis and positive tilts rostrally.
mlCoordinateML coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Right-positive position from the spinal cord midline.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second approach rotation around RC after RC tilt; positive tilts to anatomical right.
dvCoordinateDV coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Ventral-positive absolute position from the cord central axis at the declared origin.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
referenceModeReference modechoice one of spinal_segment, vertebral_level, customThe anatomical convention used to anchor the spinal frame.
referenceLevelReference leveltext  The spinal segment or vertebral level containing the rostrocaudal origin.
referenceFeatureReference featurechoice one of rostral_boundary, center, caudal_boundary, interlevel_junction, observed_landmark, customThe exact feature within or between levels that defines rostrocaudal zero.
referenceDescriptionReference descriptiontext  A concise physical definition of a custom or observed spinal reference.
surfaceReferenceDepth reference surfacechoice one of dura_surface, pia_surface, cord_surface, customPhysical interface at the insertion point from which insertion depth begins.
surfaceReferenceDescriptionSurface reference descriptiontext  A concise physical definition of a custom depth-reference surface.
rcCoordinateRC insertion coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Rostral-positive insertion-point position from the declared origin along the local cord centerline.
rcAngleRC anglequantity with unit units °; default {"unit": "°"}First approach rotation around ML; 0° follows the depth axis and positive tilts rostrally.
mlCoordinateML insertion coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Right-positive insertion-point position from the spinal cord midline.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second approach rotation around RC after RC tilt; positive tilts to anatomical right.
depthInsertion depthquantity 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.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity 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.
yY coordinatequantity 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.
zZ coordinatequantity 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.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First tilt from inferior vertical; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second tilt after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the CCFv3 anterior-superior-left origin; positive X is posterior.
xAngleX anglequantity with unit units °; default {"unit": "°"}First tilt from +Y in the X-Y sagittal plane; positive tilts toward anterior (-X).
yY coordinatequantity 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.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the CCFv3 anterior-superior-left origin; positive Z is rightward.
zAngleZ anglequantity with unit units °; default {"unit": "°"}Second tilt in the Y-Z coronal plane after X tilt; positive tilts toward right (+Z).
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity 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.
yY coordinatequantity 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.
zZ coordinatequantity 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.
zAngleZ anglequantity with unit units °; default {"unit": "°"}First tilt from ventral vertical in the Y-Z sagittal plane; positive tilts toward anterior (-Z).
xAngleX anglequantity 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).
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the MNI anterior-commissure origin; positive X is anatomical right.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the MNI anterior-commissure origin; positive Y is anterior.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the MNI anterior-commissure origin; positive Z is superior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First tilt from inferior vertical; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second tilt after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "µm"}Physical distance from the mapzebrain volume corner; positive X is anatomical right.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "µm"}Physical distance from the mapzebrain volume corner; positive Y is posterior.
zZ coordinatequantity 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.
yAngleY anglequantity with unit units °; default {"unit": "°"}First tilt from inferior vertical in the Y-Z sagittal plane; positive tilts toward anterior (-Y).
xAngleX anglequantity with unit units °; default {"unit": "°"}Second tilt in the X-Z coronal plane after the Y tilt; positive tilts toward right (+X).
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from ear bar zero; positive X is anatomical right.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from ear bar zero; positive Y is anterior.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from ear bar zero; positive Z is superior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First tilt from inferior vertical; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second tilt after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the WHS origin; positive X is anatomical right.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the WHS origin; positive Y is anterior.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical distance from the WHS origin; positive Z is superior.
apAngleAP anglequantity with unit units °; default {"unit": "°"}First tilt from inferior vertical; positive tilts anteriorly.
mlAngleML anglequantity with unit units °; default {"unit": "°"}Second tilt after the AP tilt; positive tilts to anatomical right.
rotationRotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
originTypeOriginchoice one of center, top_left, top_right, bottom_left, bottom_right, landmark, embedding_block_origin, customOrigin convention for the specimen-surface XY frame.
originDescriptionOrigin descriptiontext  Define the physical point and axes for a landmark or custom origin.
specimenOrientationSpecimen orientationtext  Map specimen anatomical or preparation directions to positive X and Y.
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical X position on the declared specimen surface.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical Y position on the declared specimen surface.
rotationIn-plane rotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
originTypeXY originchoice one of center, top_left, top_right, bottom_left, bottom_right, landmark, embedding_block_origin, customOrigin convention for the specimen-surface XY frame.
originDescriptionXY origin descriptiontext  Define the physical point and axes for a landmark or custom origin.
specimenOrientationSpecimen orientationtext  Map specimen anatomical or preparation directions to positive X and Y.
surfaceReferenceInsertion-depth reference surfacechoice one of exposed_specimen_surface, cut_face, slice_surface, pia_surface, coverslip_surface, customPhysical interface at the insertion point where insertion depth begins.
surfaceReferenceDescriptionSurface reference descriptiontext  For a custom surface, define the physical interface used as insertion-depth zero.
xX insertion coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical X position of the specimen-surface insertion point.
yY insertion coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical Y position of the specimen-surface insertion point.
depthInsertion depthquantity with unit units nm, µm, mm, m; default {"unit": "µm"}Insertion distance along the final depth axis from the selected surface at entry.
rotationAxial rotationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
originTypeOriginchoice one of center, rostral_dorsal_left_corner, embedding_block_origin, landmark, customOrigin convention for the specimen-volume XYZ frame.
originDescriptionOrigin descriptiontext  Define the physical point and axes for a landmark or custom origin.
specimenOrientationSpecimen orientationtext  Map specimen directions to +X/+Y/+Z; with the anchor major feature, this defines zero pose.
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical X position in the declared specimen-volume frame.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical Y position in the declared specimen-volume frame.
zZ coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical Z position in the declared specimen-volume frame.
xAngleX anglequantity with unit units °; default {"unit": "°"}First fixed-frame X rotation from zero; positive is counter-clockwise viewed from +X toward origin.
yAngleY anglequantity with unit units °; default {"unit": "°"}Second fixed-frame Y rotation after X; positive is counter-clockwise viewed from +Y toward origin.
zAngleZ anglequantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
wellWelltext  Well ID such as A1: A1 is top-left; rows increase back/down and columns increase right.
offsetXX offset from well centerquantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical offset from well center; positive X is right in the labware view.
offsetYY offset from well centerquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
originTypeOriginchoice one of center, dish_center, insert_center, well_center, customOrigin convention for the container-local XYZ frame.
originDescriptionOrigin descriptiontext  Define the physical point and axes for a custom container origin.
containerOrientationContainer orientationtext  Map container-local positive X, Y, and Z to the preparation or setup.
xX coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical X position in the declared container-local frame.
yY coordinatequantity with unit units nm, µm, mm, m; default {"unit": "mm"}Physical Y position in the declared container-local frame.
zZ coordinatequantity 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"
}