fafbseg.flywire.create_cave_table#

fafbseg.flywire.create_cave_table(name, schema, description, voxel_resolution=[1, 1, 1], *, dataset=None)[source]#

Create CAVE annotation table.

This is just a thin-wrapper around CAVEclient.annotation.create_table.

Note that newly created tables will not show up as materialized until the next round of materialization. Unfortuntately, there is currently no way to query un-materialized tables.

Existing tables can be browsed here.

Parameters:

  • name (str) – Name of the table.

  • schema (str) –

    Name of the schema. This determines what data we can put in the table. Here are some useful ones:

    • ”bound_tag” contains a location (“pt”) and a text “tag”

    • ”contact” contains two locations (“sidea_pt” and “sideb_pt”), a “size” (int) and a “ctr_pt” point

    • ”proofread_status” contains a location (“pt”), a “valid_id” (int) and a “status” (str) field

    • ”cell_type_local” contains a location (“pt”), and “cell_type” (str) and “classification_system” (str) fields

    See here <https://globalv1.daf-apis.com/schema/views/> for a detailed list of all available schemas.

  • description (str) – Human-readable description of what’s in the table.

  • voxel_resolution (list of ints [x, y, z]) –

    Voxel resolution points will be uploaded in. For example:

    • [1,1,1] = coordinates are in nanometers

    • [4,4,40] = coordinates are 4nm, 4nm, 40nm voxels

  • dataset ("public" | "production" | "sandbox", optional) – Against which FlyWire dataset to query. If None will fall back to the default dataset (see set_default_dataset()).

Returns:

Server response if something went wrong.

Return type:

response