CAcatmaid
skeletons

Get a compact treenode representation of a skeleton, optionally with the

Changed on

Get a compact treenode representation of a skeleton, optionally with the history of individual nodes and connectors.

Returns, in JSON, [[nodes], [connectors], {nodeID: [tags]}], with connectors and tags being empty when 0 == with_connectors and 0 == with_tags, respectively.

Each element in the [nodes] array has the following form:

[id, parent_id, user_id, location_x, location_y, location_z, radius, confidence].

Each element in the [connectors] array has the following form, with the third element representing the connector link as 0 = presynaptic, 1 = postsynaptic, 2 = gap junction, 3 = mitochondria, -1 = other:

[treenode_id, connector_id, 0|1|2|-1, location_x, location_y, location_z]

If history data is requested, each row contains a validity interval. Note that for the live table entry (the currently valid version), there are special semantics for this interval: The upper bound is older than or the same as the lower bound. This is done to encode the information of this row being the most recent version and including the original creation time at the same time, plus it requires less queries on the back-end to retireve data. This requires the client to do slightly more work, but unfortunately the original creation time is needed for data that was created without history tables enabled.

gethttp://localhost:8000/{project_id}/skeletons/{skeleton_id}/compact-detail

Request

Path parameters

project_idstring required
skeleton_idstring required

Request body application/x-www-form-urlencoded

with_connectorsstring

Whether linked connectors should be returned.

with_tagsstring

Whether tags should be returned.

with_historystring

Whether history information should be returned for each treenode and connector.

with_merge_historystring

Whether the history of arbors merged into the requested skeleton should be returned. Only used if history is returned.

with_reviewsstring

Whether a node index should be returned that maps node IDs to the list of reviews done on them, respects history parameter.

with_annotationsstring

Whether the list of linked annotations should be returned. If history should be returned, returns all link versions.

with_user_infostring

Whether all result elements should contain also the creator ID.

orderedstring

Whether result skeletons should be ordered by ID.

Response

OK

Changes