autodeer.criteria

Module Contents

Classes

Criteria

A class for defining criteria for terminating experiments. This should

TimeCriteria

A class for defining criteria for terminating experiments. This should

SNRCriteria

A class for defining criteria for terminating experiments. This should

DEERCriteria

A class for defining criteria for terminating experiments. This should

Attributes

log

autodeer.criteria.log[source]
class autodeer.criteria.Criteria(name, test, description='', end_signal=None)[source]

A class for defining criteria for terminating experiments. This should only be subclassed and not used directly.

Parameters:

  • name (str)

  • description (str)

name[source]
description[source]
test[source]
end_signal[source]
__add__(__o)[source]
Parameters:

__o (object)

class autodeer.criteria.TimeCriteria(name, end_time, description='', night_hours=None, **kwargs)[source]

Bases: Criteria

A class for defining criteria for terminating experiments. This should only be subclassed and not used directly.

Criteria testing for a specific finishing time. The finishing time is given as absolute time in the locale of the computer, it is not how the long the measurment continues for.

Parameters:
namestr

Name of the criteria

end_timefloat

Finishing time in seconds since epoch

descriptionstr, optional

A description of the criteria, by default None

night_hourstuple, optional

A tuple of two integers specifying the start and end of night hours. The criteria will always return False during these hours, by default None

Parameters:

  • name (str)

  • end_time (float)

  • description (str)

  • night_hours (tuple)

class autodeer.criteria.SNRCriteria(SNR_target, description='', verbosity=0, **kwargs)[source]

Bases: Criteria

A class for defining criteria for terminating experiments. This should only be subclassed and not used directly.

Criteria testing for signal to noise ratio. This checks the SNR of the normalised absolute data using the deerlab SNR noise estimation which is based on the work by Stoher et. al. [1]

Parameters:
namestr

_description_

SNR_targetint

The mimimum SNR value.

descriptionstr, optional

_description_, by default None

Parameters:

  • SNR_target (int)

  • description (str)

References

[1] F. Stoehr, R. White, M. Smith, I. Kamp, R. Thompson, D. Durand, W. Freudling, D. Fraquelli, J. Haase, R. Hook, T. Kimball, M. Kummel, K. Levay, M. Lombardi, A. Micol, T. Rogers DERSNR: A Simple & General Spectroscopic Signal-to-Noise Measurement Algorithm Astronomical Data Analysis Software and Systems XVII, ASP Conference Series, Vol. 30, 2008, p5.4

class autodeer.criteria.DEERCriteria(mode='Speed', model=None, verbosity=0, update_func=None, **kwargs)[source]

Bases: Criteria

A class for defining criteria for terminating experiments. This should only be subclassed and not used directly.

Criteria for running DEER experiments.

Parameters:
tau1_type_

_description_

tau2_type_

_description_

tau3_type_, optional

_description_, by default None

modestr, optional

_description_, by default “Speed”

Returns:
_type_

_description_