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 from .util.singleton import Singleton
  26
  27
  28 class Experiment (Singleton):
  29     """Base class for experiment classification.
  30     """
  31     pass
  32
  33 class ForceClamp (Experiment):
  34     """Constant force force spectroscopy [#fernandez2004]_.
  35
  36     .. [#fernandez2004] J.M. Fernandez, H. Li.
  37       "Force-Clamp Spectroscopy Monitors the Folding Trajectory of a
  38       Single Protein."
  39       Science, 2004.
  40       doi: `10.1126/science.1092497 <http://dx.doi.org/10.1126/science.1092497>`_
  41     """
  42     pass
  43
  44 class VelocityClamp (Experiment):
  45     """Constant piezo velocity force spectroscopy [#rief1997]_.
  46
  47     .. [#rief1997] M. Rief, M. Gautel, F. Oesterhelt, J.M. Fernandez,
  48       H.E. Gaub.
  49       "Reversible Unfolding of Individual Titin Immunoglobulin Domains by AFM."
  50       Science, 1997.
  51       doi: `10.1126/science.276.5315.1109 <http://dx.doi.org/10.1126/science.276.5315.1109>`_
  52     """
  53     pass
  54
  55 class TwoColorCoincidenceDetection (Experiment):
  56     """Two-color fluorescence coincidence spectroscopy [#clarke2007]_.
  57
  58     .. [#clarke2007] R.W. Clarke, A. Orte, D. Klenerman.
  59       "Optimized Threshold Selection for Single-Molecule Two-Color
  60       Fluorescence Coincidence Spectroscopy."
  61       Anal. Chem., 2007.
  62       doi: `10.1021/ac062188w <http://dx.doi.org/10.1021/ac062188w>`_
  63     """
  64     pass