Replace .config rather than reconstructing plugins, drivers, and UIs.
[hooke.git] / hooke / experiment.py
1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
2 #
3 # This file is part of Hooke.
4 #
5 # Hooke is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
9 #
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
13 # Public License for more details.
14 #
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke.  If not, see
17 # <http://www.gnu.org/licenses/>.
18
19 """Define :class:`Experiment` and assorted subclasses.
20
21 This allows :class:`hooke.plugin.Plugin`\s to specify the types of
22 experiments they can handle.
23 """
24
25 class Experiment (object):
26     """Base class for experiment classification.
27     """
28     pass
29
30 class ForceClamp (Experiment):
31     """Constant force force spectroscopy [#fernandez2004]_.
32
33     .. [#fernandez2004] J.M. Fernandez, H. Li.
34       "Force-Clamp Spectroscopy Monitors the Folding Trajectory of a
35       Single Protein."
36       Science, 2004.
37       doi: `10.1126/science.1092497 <http://dx.doi.org/10.1126/science.1092497>`_
38     """
39     pass
40
41 class VelocityClamp (Experiment):
42     """Constant piezo velocity force spectroscopy [#rief1997]_.
43     
44     .. [#rief1997] M. Rief, M. Gautel, F. Oesterhelt, J.M. Fernandez,
45       H.E. Gaub.
46       "Reversible Unfolding of Individual Titin Immunoglobulin Domains by AFM."
47       Science, 1997.
48       doi: `10.1126/science.276.5315.1109 <http://dx.doi.org/10.1126/science.276.5315.1109>`_
49     """
50     pass
51
52 class TwoColorCoincidenceDetection (Experiment):
53     """Two-color fluorescence coincidence spectroscopy [#clarke2007]_.
54
55     .. [#clarke2007] R.W. Clarke, A. Orte, D. Klenerman.
56       "Optimized Threshold Selection for Single-Molecule Two-Color
57       Fluorescence Coincidence Spectroscopy."
58       Anal. Chem., 2007.
59       doi: `10.1021/ac062188w <http://dx.doi.org/10.1021/ac062188w>`_
60     """
61     pass