Document Co-ordinate systems better

DiamondLightSource / mx-bluesky

Bluesky plans, plan stubs, and utilities for MX beamlines

https://diamondlightsource.github.io/mx-bluesky/

Apache License 2.0

0 stars 2 forks source link

Document Co-ordinate systems better #441

Open DominicOram opened 2 years ago

DominicOram commented 2 years ago

As developers on Artemis it will be good to be as specific as possible in the code about what every variable means. Specifically this is important for co-ordinate systems where the units and definition of the zero point are required.

Acceptance Criteria

Go through the codebase and add comments to any variable that is ambiguous in it's definition

DominicOram commented 2 years ago

Some specific variables that need more documentation:

ISpyB Parameters:
- upper_left
- position
- undulator_gap
- beam_size_x/beam_size_y
- pixels_per_micron_x/pixels_per_micron_y - Additionally confirm that we mean actual pixels not the GDA standard normalised to old image formats, if it is the odd pixel format then we need to discuss widely to correct