test/data/vclamp_jpk/README: Document sample versions
[hooke.git] / test / convert_distance_to_force.py
1 # Copyright (C) 2010-2012 W. Trevor King <wking@tremily.us>
2 #
3 # This file is part of Hooke.
4 #
5 # Hooke is free software: you can redistribute it and/or modify it under the
6 # terms of the GNU Lesser General Public License as published by the Free
7 # Software Foundation, either version 3 of the License, or (at your option) any
8 # later version.
9 #
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
13 # details.
14 #
15 # You should have received a copy of the GNU Lesser General Public License
16 # along with Hooke.  If not, see <http://www.gnu.org/licenses/>.
17
18 """
19 >>> from hooke.hooke import Hooke, HookeRunner
20 >>> h = Hooke()
21 >>> r = HookeRunner()
22 >>> h = r.run_lines(h, ['load_playlist test/data/test']) # doctest: +ELLIPSIS
23 <FilePlaylist test.hkp>
24 Success
25 <BLANKLINE>
26 >>> h = r.run_lines(h,
27 ...     ['convert_distance_to_force --deflection_column "deflection (m)"']
28 ...     ) # doctest: +ELLIPSIS, +REPORT_UDIFF
29 Success
30 <BLANKLINE>
31 >>> curve = h.playlists.current().current()
32 >>> approach = curve.data[0]
33 >>> approach.info['columns']
34 ['z piezo (m)', 'deflection (m)', 'deflection (N)']
35 >>> approach[:5,-1]  # doctest: +ELLIPSIS
36 Data([  4.997...-09,   5.017...e-09,   5.032...e-09,
37          5.049...e-09,   5.067...e-09])
38 >>> approach[-5:,-1]  # doctest: +ELLIPSIS
39 Data([  6.987...e-09,   6.999...e-09,   6.979...e-09,
40          6.962...e-09,   6.967...e-09])
41
42 Note that the rediculously high forces are because the deflection has
43 not been zeroed (e.g. with 'zero surface contact point').
44 """