Skip to content

Commit

Permalink
improves docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
gadamc committed Feb 7, 2023
1 parent 63278ff commit 2b79eca
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/qt3utils/datagenerators/daqsamplers.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,15 @@ def yield_count_rate(self):


class RandomRateCounter(RateCounterBase):

'''
"""
This random source acts like a light source with variable intensity.
This is similar to a PL source moving in and out of focus.
'''
When 'simulated_single_light_source' is True at instantiation,
this will simulate a sample with isolated bright spots, like NV centers in diamond and
is used when testing the CounterAndScanner class in piezoscanner.py module.
"""
def __init__(self, simulate_single_light_source=False, num_data_samples_per_batch=10):
super().__init__()
self.default_offset = 100
Expand Down

0 comments on commit 2b79eca

Please sign in to comment.