search

qt3uw / qt3-utils

Data Acquisition for Confocal Microscope and Spin Control Experiments
https://sites.google.com/uw.edu/qt3-lab/projects
BSD 3-Clause "New" or "Revised" License
3 stars 6 forks source link

134 Adds hyper spectral imaging to qt3scan #140

Closed gadamc closed 8 months ago

gadamc commented 9 months ago

Adds hyper spectral imaging to qt3scan --> #134

gadamc commented 9 months ago

Also, we need to add documentation to the README

gadamc commented 8 months ago

Overall, this is a good implementation of hyper spectral scans. I will submit a second round of reviews, once I see this in action today. One thing I would like to see is an explanation of who a person would go about adding their own spectrometer classes, and making this code easily accept different spectrometers.

@vasilisniaouris more documentation is definitely needed. The README already had some documentation around implementing support for new hardware. We did need to make a fundamental code change to split the DAQ controller interface into one that supports counters and one that supports spectra. @cmordi we should document that in the readme. I think the current documentation in README is pretty good and probably makes a lot more sense to @cmordi now. So perhaps he'll be able to provide an update to that doc.

Having said that, I know there's pressure to release something. Given that documentation is usually something that doesn't get done, I highly recommend that we at least put something in the README that explains what's happening and how to implement a new spectrometer. It should be a natural extension of the information that is currently there.

cmordi commented 8 months ago

Overall, this is a good implementation of hyper spectral scans. I will submit a second round of reviews, once I see this in action today. One thing I would like to see is an explanation of who a person would go about adding their own spectrometer classes, and making this code easily accept different spectrometers.

@vasilisniaouris more documentation is definitely needed. The README already had some documentation around implementing support for new hardware. We did need to make a fundamental code change to split the DAQ controller interface into one that supports counters and one that supports spectra. @cmordi we should document that in the readme. I think the current documentation in README is pretty good and probably makes a lot more sense to @cmordi now. So perhaps he'll be able to provide an update to that doc.

Having said that, I know there's pressure to release something. Given that documentation is usually something that doesn't get done, I highly recommend that we at least put something in the README that explains what's happening and how to implement a new spectrometer. It should be a natural extension of the information that is currently there.

@gadamc Just updated the docs. One or two of the hyperlinks are for this branch which is obviously not correct but I will change those when we update the main branch. Please let me know if I included incorrect info in the docs