Service docs work (Steiger) #224
Conversation
|
I would appreciate a second opinion on the driver information to make sure that information is accurate. |
docs/services/bmc_dm.rst
Outdated
| @@ -1,14 +1,57 @@ | |||
| Boston Deformable Mirror | |||
| ======================== | |||
| This service operates a Boston Micromachines MEMS DM. The following Boston DMs have been tested with catkit2 thus far: | |||
There was a problem hiding this comment.
This is actually a service for a pair of Boston DMs controlled by the same driver. Since this can be a limitation in some cases, @ehpor and I started working on a new service that is more flexible in this regard in #156. While this will not alter this service here, it might be good to explain that it is for a pair of the same type of Boston DMs, with the same number of actuators, controlled by a single driver.
I will make sure to highlight the respective changes when I write the service doc page in #156.
docs/services/bmc_dm.rst
Outdated
|
|
||
| Properties | ||
| ---------- | ||
| ``channels``: List of command channel names (strings). |
docs/services/bmc_dm.rst
Outdated
|
|
||
| ``total_surface``: Map of the total amplitude of each DM actuator (meters). | ||
|
|
||
| ``channel_name``: Name of the DM channel being commanded. |
There was a problem hiding this comment.
For the DAC we used ```channels[channel_name]``: The command per virtual channel, identified by channel name.` to try to make it come through that this is a dict holding several data streams - maybe you could adapt a similar solution here?
There was a problem hiding this comment.
I agree it's a good idea to make the syntax consistent - updated.
There was a problem hiding this comment.
While working on #156, I thought of a couple more clarifications that would help to have in the docs here. Sorry to throw another round of comments at you after having already approved this.
docs/services/bmc_dm.rst
Outdated
| Datastreams | ||
| ----------- | ||
| ``total_voltage``: Map of the total voltage applied to each actuator of the DM. | ||
|
|
||
| ``total_surface``: Map of the total amplitude of each DM actuator (meters). |
There was a problem hiding this comment.
I just had a look while working on that other PR, and I am pretty sure that the units of the data frames on the total_surface data stream are in nanometers. Could you please confirm this and if it is true, update this comment?
There was a problem hiding this comment.
Ha, and maybe we could avoid the word "map" here? Emiel initiated a refactor in #123 to be a little stricter on the differentiation between "DM commands" and "DM maps", and even if this does not apply to this service here, it might help to stick to that in the docstrings too. Maybe something like "Array of the total amplitude..." would work? Same for the total_voltage data stream.
There was a problem hiding this comment.
good catch! Yes, just confirmed the units are nm and so updated that and also changed "map" to "array"
docs/services/bmc_dm.rst
Outdated
|
|
||
| ``total_surface``: Map of the total amplitude of each DM actuator (meters). | ||
|
|
||
| ``channels[channel_name]``: The command per virtual channel, identified by channel name. |
There was a problem hiding this comment.
On the same note, we should probably specify that the commands on the data streams for the individual channels are in units of nm surface.
On second thought I edited the page the FLIR docs pointed to since I found a more descriptive one. I am happy with it now though. |
This is part of the team effort to fill out the documentation pages in the services module of catkit2 (see issue #190 for more information).
service docs included in this PR: