# <http://www.gnu.org/licenses/>.
"""Driver for JPK ForceRobot's velocity clamp data format.
+
+This driver is based on JPK's :file:`JPKForceSpec.txt` version 0.12.
+The specs are freely available from JPK, just email support@jpk.com.
"""
import os.path
import numpy
from .. import curve as curve
-from .. import experiment as experiment
from ..util.util import Closing as Closing
from ..util.si import join_data_label, split_data_label
from . import Driver as Driver
for i in range(len([p for p in f.namelist()
if p.endswith('segment-header.properties')])):
segments.append(self._zip_segment(f, path, info, zip_info, i))
- if zip_info['file-format-version'] not in ['0.5']:
+ if zip_info['file-format-version'] not in ['0.%d' % i
+ for i in range(12)]:
raise NotImplementedError(
'JPK file version %s not supported (yet).'
% zip_info['file-format-version'])
- for name in ['approach', 'retract']:
- if len([s for s in segments if s.info['name'] == name]) == 0:
- raise ValueError(
- 'No segment for %s in %s, only %s'
- % (name, path, [s.info['name'] for s in segments]))
curve_info = self._zip_translate_params(zip_info,
segments[0].info['raw info'])
- for segment in segments:
+ for segment in segments: # HACK, should use curve-level spring constant
segment.info['spring constant (N/m)'] = \
curve_info['spring constant (N/m)']
return (segments, curve_info)
def _zip_translate_params(self, params, chan_info):
info = {
'raw info':params,
- 'filetype':self.name,
#'time':self._time_from_TODO(raw_info[]),
}
- # TODO: distinguish between force clamp and velocity clamp
- # experiments. Note that the JPK file format is flexible
- # enough to support mixed experiments (i.e. both force clamp
- # and velocity clamp segments in a single experiment), but I
- # have no idea what sort of analysis such experiments would
- # require ;).
- info['experiment'] = experiment.VelocityClamp
force_unit = chan_info['channel']['vDeflection']['conversion-set']['conversion']['force']['scaling']['unit']['unit']
assert force_unit == 'N', force_unit
force_base = chan_info['channel']['vDeflection']['conversion-set']['conversion']['force']['base-calibration-slot']
return info
def _read_old(self, path, info):
- raise NotImplementedError('No old-style JPK files were available for testing, please send us yours: %s' % path)
+ raise NotImplementedError(
+ "Early JPK files (pre-zip) are not supported by Hooke. Please "
+ "use JPK's `out2jpk-force` script to convert your old files "
+ "to a more recent format before loading them with Hooke.")