Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of in qt3scan #94

Open
gadamc opened this issue Mar 13, 2023 · 3 comments
Open

Documentation of in qt3scan #94

gadamc opened this issue Mar 13, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@gadamc
Copy link
Collaborator

gadamc commented Mar 13, 2023

qt3scan documentation only consists of the help file.

Need full doc explaining all of the components.
Pay special attention to the meaning of N samples in DAQ section. Experimenter needs to understand clock rate, number of samples -- essentially the total time to observe per pixel.

@gadamc gadamc added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 13, 2023
@gadamc
Copy link
Collaborator Author

gadamc commented Jun 14, 2023

Would be great to have an image of the GUI and accompanying documentation describing each of the parts of the GUI. Would be a great way for new developer of this code to become familiar!

@gadamc gadamc added the good first issue Good for newcomers label Jun 14, 2023
@gadamc
Copy link
Collaborator Author

gadamc commented Nov 18, 2023

Thanks to @Waffelz

Pointed out that there is no documentation that describes the output data from qt3scan.

When you open a compressed numpy array from qt3scan you will see the following keys: raw_counts, count_rate, scan_range, step_size and daq_clock_rate.

@Waffelz
Copy link

Waffelz commented Nov 18, 2023

When loading the confocal scan files saved as a compressed numpy array(.npz) can use these lines to load

from numpy import load
confocals=your list of file names

#load one scan at once

data = load(confocals[0])

showing the keys of the data file

lst = data.files
print(lst)
['raw_counts', 'count_rate', 'scan_range', 'step_size', 'daq_clock_rate']

'count_rate' is a 2d array with the photon counts per second for each index. Can plot the scan with

axes.imshow(data['count_rate'], origin='lower', extent=data['scan_range'])

the data under the first key 'raw_counts' has the same dimension as that of 'count_rate', but for each index the clock cycle has been saved together with the raw count in the form data['raw_counts'][0,0]=[raw count, clock cycle]. count rate/s=raw count/clock rate*clock cycle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants