Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Skeletonised cells

Cells are often described in skeletonised form, as a rooted tree graph. The root SHOULD be the cell body.

Parent schemas

This schema inherits all fields and metadata from the following schemas:

Schema metadata

These metadata keys are defined in addition to those defined by any parent schemas.

Required schema metadata

These metadata MUST exist in the schema’s metadata.

  • None

Optional schema metadata

These metadata MAY exist in the schema’s metadata.

  • None

Fields

These fields are defined in addition to those defined by any parent classes.

Required fields

These fields MUST exist in the file.

parent_id

  • data type: uint64
  • nullable: yes
    • exactly one sample per fragment MUST be null, which MUST the root; conventionally the cell body or nearest node to it

The ID of the parent node for this sample. MUST be defined elsewhere in the file.

Optional fields

These fields MAY exist in the file.

radius

  • data type: float64
  • nullable: yes
    • where radius is not known

An approximation of the radius of the cell around this sample, in the units given in the schema metadata.

Derived fields

These fields MAY exist in the file, but MUST be calculable from other fields, and MAY be invalidated if the source fields are updated.

child_ids

  • data type: list[uint64]
  • nullable: yes
    • where children are not calculated
    • nodes known to be leaves (no children) SHOULD use an empty list instead of null

The IDs of samples which have this sample as a parent.

n_children

  • data type: uint32
  • nullable: yes
    • where children are not calculated
    • notes known to be leaves (no children) SHOULD use 0 instead of null

How many child nodes a particular sample has.

strahler

  • data type: uint32
  • nullable: yes
    • where strahler index is not calculated

The Strahler number of this sample.