Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
bdpedigo committed Jan 19, 2024
1 parent d3ce3b5 commit 886860e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
15 changes: 9 additions & 6 deletions docs/tutorials/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ client.annotation.create_table(table_name='test_table',
```

The voxel resolution is the units your position columns will be uploaded
in. \[1,1,1\] would imply a nm location, where as \[4,4,40\] would
in [1,1,1] would imply a nm location, where as [4,4,40] would
correspond to voxels of that size. If you are uploading points from a
neuroglancer session, you want this to match the units of that
neuroglancer view.
Expand Down Expand Up @@ -107,9 +107,12 @@ client.annotation.update_metadata(table_name='test_table',

New data can be generated as a dict or list of dicts following the
schema and uploaded with `post_annotation`. For example, a
`microns_func_coreg` point needs to have: \* `type` set to
`microns_func_coreg` \* `pt` set to a dict with `position` as a key and
the xyz location as a value. \* `func_id` set to an integer.
`microns_func_coreg` point needs to have:

- `type` set to `microns_func_coreg`
- `pt` set to a dict with `position` as a key and
the xyz location as a value.
- `func_id` set to an integer.

The following could would create a new annotation and then upload it to
the service. Note that you get back the annotation id(s) of what you
Expand Down Expand Up @@ -141,7 +144,7 @@ client.annotation.post_annotation_df('test_table', df)
```

Note that here I specified the IDs of my annotations, which you can do,
but then its up to you to assure that the IDs don\'t collide with other
but then its up to you to assure that the IDs don't collide with other
IDs. If you leave them blank then the service will assign the IDs for
you.

Expand All @@ -158,7 +161,7 @@ for a given table, then add annotations to it individually or as a
group, and finally upload to the annotation table.

To get a StagedAnnotation object, you can start with either a table name
or a schema name. Here, we\'ll assume that there\'s already a table
or a schema name. Here, we'll assume that there's already a table
called "my_table" that is running a "cell_type_local" schema. If we
want to add new annotations to the table, we simply use the table name
with [stage_annotations()]({{ client_api_paths.annotation }}.stage_annotations).
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/l2cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ The statistics that are available are:
chunk, and whose values represent how many
voxels border that side of the chunk. Meant to
help understand significant the borders with
other chunks are. Ordering is the \[\[x_bottom,
y_bottom, z_bottom\],\[x_top, y_top, z_top\]\]
where {xyz}\_bottom refers to the face which
other chunks are. Ordering is the [[x_bottom,
y_bottom, z_bottom],[x_top, y_top, z_top]]
where {xyz}_bottom refers to the face which
has the smallest values for that dimension, and
{xyz}\_top refers to the face which has the
{xyz}_top refers to the face which has the
largest.
- **pca** A 3x3 matrix representing the principal
components of the xyz point cloud of voxels for
Expand Down

0 comments on commit 886860e

Please sign in to comment.