hooke/driver/tutorial.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 """Tutorial driver for Hooke.
  20
  21 This example driver explains driver construction.
  22 """
  23
  24 """
  25 Here we define a simple file format that is read by this driver. The
  26 file format is as following::
  27
  28     TUTORIAL_FILE
  29     PLOT1
  30     X1
  31     n1   <- ?
  32     n2
  33     ...
  34     nN
  35     Y1
  36     n1
  37     n2
  38     ...
  39     nN
  40     X2
  41     n1
  42     n2
  43     ..
  44     nN
  45     Y2
  46     n1
  47     n2
  48     ..
  49     nN
  50     PLOT2
  51     X1
  52     ...
  53     Y1
  54     ...
  55     X2
  56     ...
  57     Y2
  58     ...
  59     END
  60
  61 that is, two plots with two datasets each.
  62 """
  63
  64 # The following are relative imports.  See PEP 328 for details
  65 #   http://www.python.org/dev/peps/pep-0328/
  66 from .. import curve as curve # this module defines data containers.
  67 from .. import experiment as experiment # this module defines expt. types
  68 from ..config import Setting # configurable setting class
  69 from . import Driver as Driver # this is the Driver base class
  70
  71 # The driver must inherit from the parent
  72 # :class:`hooke.driver.Driver` (which we have imported as `Driver`).
  73 class TutorialDriver (Driver):
  74     """Handle simple text data as an example Driver.
  75     """
  76     def __init__(self):
  77         """YOU MUST OVERRIDE Driver.__init__.
  78
  79         Here you set a value for `name` to identify your driver.  It
  80         should match the module name.
  81         """
  82         super(TutorialDriver, self).__init__(name='tutorial')
  83
  84     def default_settings(self):
  85         """Return a list of any configurable settings for your driver.
  86
  87         If your driver does not have any configurable settings, there
  88         is no need to override this method.
  89         """
  90         return [
  91             Setting(section=self.setting_section, help=self.__doc__),
  92             Setting(section=self.setting_section, option='x units', value='nm',
  93                     help='Set the units used for the x data.'),
  94             ]
  95
  96     def is_me(self, path):
  97         """YOU MUST OVERRIDE Driver.is_me.
  98
  99         RETURNS: Boolean (`True` or `False`)
 100
 101         This method is a heuristic that looks at the file content and
 102         decides if the file can be opened by the driver itself.  It
 103         returns `True` if the file opened can be interpreted by the
 104         current driver, `False` otherwise.  Defining this method allows
 105         Hooke to understand what kind of files we're looking at
 106         automatically.
 107         """
 108
 109         f = open(path, 'r')
 110         header = f.readline() # we only need the first line
 111         f.close()
 112
 113         """Our "magic fingerprint" is the TUTORIAL_FILE header. Of
 114         course, depending on the data file, you can have interesting
 115         headers, or patterns, etc. that you can use to guess the data
 116         format. What matters is successful recognition and the boolean
 117         (True/False) return.
 118         """
 119         if header.startswith('TUTORIAL_FILE'):
 120             return True
 121         return False
 122
 123     def read(self, path, info=None):
 124         f = open(path,'r') # open the file for reading
 125         """In this case, we have a data format that is just a list of
 126         ASCII values, so we can just divide that in rows, and generate
 127         a list with each item being a row.  Of course if your data
 128         files are binary, or follow a different approach, do whatever
 129         you need. :)
 130         """
 131         self.data = list(self.filedata)
 132         f.close() # remember to close the file
 133
 134         data = curve.Data()
 135         info = {'filetype':'tutorial', 'experiment':experiment.Experiment}
 136         return (data, info)