CAVEconnectome / CAVEclient

This is the python client for accessing REST APIs within the Connectome Annotation Versioning Engine.
https://caveconnectome.github.io/CAVEclient/
MIT License
19 stars 12 forks source link

desired resolution should be more explicitly about what it means #189

Open emjoyce opened 4 weeks ago

emjoyce commented 4 weeks ago

for example the documentation string should read something like..

if you pass for example, desired_resolution = [1,1,1] then when you have a position value of [1,1,1] in your result, that means that point is located 1 nanometers from the x,y,z origin. if you pass desired_resolution=[4,4,40] then a value of [1,1,1] in you result means that point is 4 nanometers in x, 4 in y, and 40 in z from the x,y,z origin.

common usage patterns are

to get nanometer units

desired_resolution=[1,1,1]

to get microns

desired_resolution=[1000,1000,1000]

to get units compatible with the default neuroglancer view of a datastack

ngl_resolution = client.info.get_datastack_info()['viewer_resolution'] desired_resolution = ngl_resolution