fafbseg.flywire.is_proofread

fafbseg.flywire.is_proofread(x, table=('proofreading_status_public_v1', 'proofread_neurons'), materialization='auto', cache=True, validate=True, *, dataset=None)[source]

Test if neuron has been set to proofread.

Parameters:

  • x (int | list of int) – Root IDs to check.

  • table (str | tupple) –

    Which CAVE table(s) to use. There are currently two tables:

    • ”proofreading_status_public_v1” contains everything that has been set to proofread by the community and includes some things that aren’t actual neurons; this table is automatically updated and should be up-to-date for the production dataset

    • ”proofread_neurons” is a sanitized version of the above and should contain only neurons; note though that this table is not automatically updated and will lag behind

      the “proofreading_status_public_v1” table

    Unfortunately, the “proofreading_status_public_v1” table is currently only available in the production but not the public dataset - which makes sense since the public dataset is a static snapshot. To make this function robust, we default to using “proofreading_status_public_v1” and fall back to “proofread_neurons” if the former is not available.

  • materialization ("latest" | "live" | "auto" | int) – Which materialization to check. If “latest” will use the latest available one in the CAVE client.

  • validate (bool) – Whether to validate IDs.

  • cache (bool) – Use and update a locally cached version of the proofreading table. Setting this to False will force fetching the full table which is considerably slower. Does not apply if materialization=’live’.

  • 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:

proofread – Boolean array.

Return type:

np.ndarray