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

Propose method and client-level specification of desired units for input/output #150

Open bdpedigo opened 4 months ago

bdpedigo commented 4 months ago

we discussed two interfaces for specifying the units for dimensions for inputs and outputs:

  1. methods could implement a units/resolution/etc. flag which denotes what units a user is inputting (e.g. for a bounding box) or expecting (e.g. for a spatial location return value). the default would be None which would not change the current behavior
  2. the CAVEClient class could also implement the same flag, and would also be None by default. specifying this would lead to all subsequent calls being in those units, unless overridden at the method level
bdpedigo commented 4 months ago

Functions/methods with some kind of spatial input/return: