pyafm/afm.py

   1 # Copyright (C) 2009-2011 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This file is part of pyafm.
   4 #
   5 # pyafm is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by the
   7 # Free Software Foundation, either version 3 of the License, or (at your
   8 # option) any later version.
   9 #
  10 # pyafm is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with pyafm.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 """Tools for controlling atomic force microscopes.
  19
  20 Provides control of AFM postition using both short-range (piezo) and
  21 long range (stepper) vertical positioning.  There are separate modules
  22 for controlling the piezo (`pypiezo`) and stepper (`stepper`), this
  23 module only contains methods that require the capabilities of both.
  24 """
  25
  26 from pypiezo.base import convert_bits_to_meters as _convert_bits_to_meters
  27 from pypiezo.base import convert_meters_to_bits as _convert_meters_to_bits
  28 from pypiezo.base import convert_volts_to_bits as _convert_volts_to_bits
  29 from pypiezo.surface import FlatFit as _FlatFit
  30 from pypiezo.surface import SurfaceError as _SurfaceError
  31
  32 from . import LOG as _LOG
  33
  34
  35 class AFM (object):
  36     """Atomic force microscope positioning.
  37
  38     Uses a short range `piezo` and a long range `stepper` to position
  39     an AFM tip relative to the surface.
  40
  41     Parameters
  42     ----------
  43     piezo | pypiezo.afm.AFMpiezo instance
  44         Fine positioning and deflection measurements.
  45     stepper | stepper.Stepper instance
  46         Coarse positioning.
  47     temperature | temperature.Controller instance or None
  48         Optional temperature monitoring and control.
  49     """
  50     def __init__(self, piezo, stepper, temperature=None, axis_name='z'):
  51         self.piezo = piezo
  52         self.stepper = stepper
  53         self.temperature = temperature
  54         self.axis_name = axis_name
  55
  56     def get_temperature(self):
  57         """Measure the sample temperature.
  58
  59         Return the sample temperature in Kelvin or `None` if such a
  60         measurement is not possible.
  61         """
  62         if hasattr(self.temperature, 'get_temperature'):
  63             return self.temperature.get_temperature()
  64
  65     def move_just_onto_surface(self, depth=-50e-9, setpoint=2,
  66                                min_slope_ratio=10, far=200):
  67         """Position the AFM tip close to the surface.
  68
  69         Uses `.piezo.get_surface_position()` to pinpoint the position
  70         of the surface.  Adjusts the stepper position as required via
  71         `.stepper.step_relative()` to get within
  72         `2*.stepper.step_size` meters of the surface.  Then adjusts
  73         the piezo to place the cantilever `depth` meters onto the
  74         surface.  Negative `depth`\s place the tip off the surface
  75
  76         If `.piezo.get_surface_position()` fails to find the surface,
  77         backs off `far` half steps (for safety) and steps in (without
  78         moving the zpiezo) until deflection voltage is greater than
  79         `setpoint`.
  80         """
  81         _LOG.info('moving to %g onto the surface' % depth)
  82
  83         stepper_tolerance = 2*self.stepper.step_size
  84
  85         axis = self.piezo.axis_by_name(self.axis_name)
  86
  87         zero = _convert_volts_to_bits(axis.config['channel'], 0)
  88         target_def = _convert_volts_to_bits(axis.config['channel'], setpoint)
  89
  90         _LOG.debug('zero the %s piezo output' % self.axis_name)
  91         self.piezo.jump(axis_name=self.axis_name, position=zero)
  92
  93         _LOG.debug("see if we're starting near the surface")
  94         try:
  95             pos = self.piezo.get_surface_position(
  96                 axis_name=self.axis_name, max_deflection=target_def,
  97                 min_slope_ratio=min_slope_ratio)
  98         except _FlatFit, e:
  99             _LOG.info(e)
 100             pos = self._stepper_approach_again(
 101                 target_deflection=target_def, min_slope_ratio=min_slope_ratio,
 102                 far=far)
 103         except _SurfaceError, e:
 104             _LOG.info(e)
 105             pos = self._stepper_approach_again(
 106                 target_deflection=target_def, min_slope_ratio=min_slope_ratio,
 107                 far=far)
 108
 109         pos_m = _convert_bits_to_meters(axis.config, pos)
 110         _LOG.debug('located surface at stepper %d, piezo %d (%g m)'
 111                   % (self.stepper.position, pos, pos_m))
 112
 113         _LOG.debug('fine tune the stepper position')
 114         while pos_m < -stepper_tolerance:  # step back if we need to
 115             _LOG.debug('step back')
 116             self.stepper.step_relative(-1, backlash_safe=True)
 117             try:
 118                 pos = self.piezo.get_surface_position(
 119                     axis_name=self.axis_name, max_deflection=target_def,
 120                     min_slope_ratio=min_slope_ratio)
 121             except _FlatFit, e:
 122                 _LOG.debug(e)
 123                 continue
 124             pos_m = _convert_bits_to_meters(axis.config, pos)
 125             _LOG.debug('located surface at stepper %d, piezo %d (%g m)'
 126                       % (self.stepper.position, pos, pos_m))
 127         while pos_m > stepper_tolerance:  # step forward if we need to
 128             _LOG.debug('step forward')
 129             self.stepper.step_relative(1)
 130             try:
 131                 pos = self.piezo.get_surface_position(
 132                     axis_name=self.axis_name, max_deflection=target_def,
 133                     min_slope_ratio=min_slope_ratio)
 134             except _FlatFit, e:
 135                 _LOG.debug(e)
 136                 continue
 137             pos_m = _convert_bits_to_meters(axis.config, pos)
 138             _LOG.debug('located surface at stepper %d, piezo %d (%g m)'
 139                       % (self.stepper.position, pos, pos_m))
 140
 141         _LOG.debug('adjust the %s piezo to place us just onto the surface'
 142                   % self.axis_name)
 143         target_m = pos_m + depth
 144         target = _convert_meters_to_bits(axis.config, target_m)
 145         self.piezo.jump(self.axis_name, target)
 146
 147         _LOG.debug(
 148             'positioned %g m into the surface at stepper %d, piezo %d (%g m)'
 149             % (depth, self.stepper.position, target, target_m))
 150
 151
 152     def _stepper_approach_again(self, target_deflection, min_slope_ratio, far):
 153         _LOG.info('back off %d half steps and approach until deflection > %g'
 154                  % (far, target_deflection))
 155         # back away
 156         self.stepper.step_relative(-far, backlash_safe=True)
 157         self.stepper_approach(target_deflection=target_deflection)
 158         for i in range(2*max(1, self.stepper.backlash)):
 159             _LOG.debug(
 160                 'additional surface location attempt (stepping backwards)')
 161             try:
 162                 pos = self.piezo.get_surface_position(
 163                     axis_name=self.axis_name, max_deflection=target_deflection,
 164                     min_slope_ratio=min_slope_ratio)
 165                 return pos
 166             except _SurfaceError, e:
 167                 _LOG.info(e)
 168             self.stepper.single_step(-1)  # step out
 169         _LOG.debug('giving up on finding the surface')
 170         _LOG.warn(e)
 171         raise e
 172
 173     def stepper_approach(self, target_deflection):
 174         _LOG.info('approach with stepper until deflection > {}'.format(
 175                 target_deflection))
 176         cd = self.piezo.read_deflection()  # cd = current deflection in bits
 177         _LOG.debug('single stepping approach')
 178         while cd < target_deflection:
 179             _LOG.debug('deflection {} < setpoint {}.  step closer'.format(
 180                     cd, target_deflection))
 181             self.stepper.single_step(1)  # step in
 182             cd = self.piezo.read_deflection()