-# Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
+# Copyright (C) 2010-2012 W. Trevor King <wking@tremily.us>
#
-# This file is part of Hooke.
+# This file is part of igor.
#
-# Hooke is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
+# igor is free software: you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
#
-# Hooke is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
-# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details.
+# igor is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
#
-# You should have received a copy of the GNU Lesser General Public
-# License along with Hooke. If not, see
-# <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU Lesser General Public License
+# along with igor. If not, see <http://www.gnu.org/licenses/>.
"Read IGOR Binary Wave files into Numpy arrays."
# share. We hope IGOR Technical Notes will provide you with lots of
# valuable information while you are developing IGOR applications.
-import array
-import struct
-import sys
-import types
+from __future__ import absolute_import
+import array as _array
+import struct as _struct
+import sys as _sys
+import types as _types
-import numpy
+import numpy as _numpy
-
-class Field (object):
- """Represent a Structure field.
-
- See Also
- --------
- Structure
- """
- def __init__(self, format, name, default=None, help=None, count=1):
- self.format = format # See the struct documentation
- self.name = name
- self.default = None
- self.help = help
- self.count = count
- self.total_count = numpy.prod(count)
-
-class Structure (struct.Struct):
- """Represent a C structure.
-
- A convenient wrapper around struct.Struct that uses Fields and
- adds dict-handling methods for transparent name assignment.
-
- See Also
- --------
- Field
-
- Examples
- --------
-
- Represent the C structure::
-
- struct thing {
- short version;
- long size[3];
- }
-
- As
-
- >>> from pprint import pprint
- >>> thing = Structure(name='thing',
- ... fields=[Field('h', 'version'), Field('l', 'size', count=3)])
- >>> thing.set_byte_order('>')
- >>> b = array.array('b', range(2+4*3))
- >>> d = thing.unpack_dict_from(buffer=b)
- >>> pprint(d)
- {'size': array([ 33752069, 101124105, 168496141]), 'version': 1}
- >>> [hex(x) for x in d['size']]
- ['0x2030405L', '0x6070809L', '0xa0b0c0dL']
-
- You can even get fancy with multi-dimensional arrays.
-
- >>> thing = Structure(name='thing',
- ... fields=[Field('h', 'version'), Field('l', 'size', count=(3,2))])
- >>> thing.set_byte_order('>')
- >>> b = array.array('b', range(2+4*3*2))
- >>> d = thing.unpack_dict_from(buffer=b)
- >>> d['size'].shape
- (3, 2)
- >>> pprint(d)
- {'size': array([[ 33752069, 101124105],
- [168496141, 235868177],
- [303240213, 370612249]]),
- 'version': 1}
- """
- def __init__(self, name, fields, byte_order='='):
- # '=' for native byte order, standard size and alignment
- # See http://docs.python.org/library/struct for details
- self.name = name
- self.fields = fields
- self.set_byte_order(byte_order)
-
- def __str__(self):
- return self.name
-
- def set_byte_order(self, byte_order):
- """Allow changing the format byte_order on the fly.
- """
- if (hasattr(self, 'format') and self.format != None
- and self.format.startswith(byte_order)):
- return # no need to change anything
- format = []
- for field in self.fields:
- format.extend([field.format]*field.total_count)
- struct.Struct.__init__(self, format=byte_order+''.join(format).replace('P', 'L'))
-
- def _flatten_args(self, args):
- # handle Field.count > 0
- flat_args = []
- for a,f in zip(args, self.fields):
- if f.total_count > 1:
- flat_args.extend(a)
- else:
- flat_args.append(a)
- return flat_args
-
- def _unflatten_args(self, args):
- # handle Field.count > 0
- unflat_args = []
- i = 0
- for f in self.fields:
- if f.total_count > 1:
- data = numpy.array(args[i:i+f.total_count])
- data = data.reshape(f.count)
- unflat_args.append(data)
- else:
- unflat_args.append(args[i])
- i += f.total_count
- return unflat_args
-
- def pack(self, *args):
- return struct.Struct.pack(self, *self._flatten_args(args))
-
- def pack_into(self, buffer, offset, *args):
- return struct.Struct.pack_into(self, buffer, offset,
- *self._flatten_args(args))
-
- def _clean_dict(self, dict):
- for f in self.fields:
- if f.name not in dict:
- if f.default != None:
- dict[f.name] = f.default
- else:
- raise ValueError('{} field not set for {}'.format(
- f.name, self.__class__.__name__))
- return dict
-
- def pack_dict(self, dict):
- dict = self._clean_dict(dict)
- return self.pack(*[dict[f.name] for f in self.fields])
-
- def pack_dict_into(self, buffer, offset, dict={}):
- dict = self._clean_dict(dict)
- return self.pack_into(buffer, offset,
- *[dict[f.name] for f in self.fields])
-
- def unpack(self, string):
- return self._unflatten_args(struct.Struct.unpack(self, string))
-
- def unpack_from(self, buffer, offset=0):
- return self._unflatten_args(
- struct.Struct.unpack_from(self, buffer, offset))
-
- def unpack_dict(self, string):
- return dict(zip([f.name for f in self.fields],
- self.unpack(string)))
-
- def unpack_dict_from(self, buffer, offset=0):
- return dict(zip([f.name for f in self.fields],
- self.unpack_from(buffer, offset)))
+from . import LOG as _LOG
+from .struct import Structure as _Structure
+from .struct import DynamicStructure as _DynamicStructure
+from .struct import Field as _Field
+from .struct import DynamicField as _DynamicField
+from .util import assert_null as _assert_null
+from .util import byte_order as _byte_order
+from .util import need_to_reorder_bytes as _need_to_reorder_bytes
+from .util import checksum as _checksum
# Numpy doesn't support complex integers by default, see
# So we roll our own types. See
# http://docs.scipy.org/doc/numpy/user/basics.rec.html
# http://docs.scipy.org/doc/numpy/reference/generated/numpy.dtype.html
-complexInt8 = numpy.dtype([('real', numpy.int8), ('imag', numpy.int8)])
-complexInt16 = numpy.dtype([('real', numpy.int16), ('imag', numpy.int16)])
-complexInt32 = numpy.dtype([('real', numpy.int32), ('imag', numpy.int32)])
-complexUInt8 = numpy.dtype([('real', numpy.uint8), ('imag', numpy.uint8)])
-complexUInt16 = numpy.dtype([('real', numpy.uint16), ('imag', numpy.uint16)])
-complexUInt32 = numpy.dtype([('real', numpy.uint32), ('imag', numpy.uint32)])
+complexInt8 = _numpy.dtype([('real', _numpy.int8), ('imag', _numpy.int8)])
+complexInt16 = _numpy.dtype([('real', _numpy.int16), ('imag', _numpy.int16)])
+complexInt32 = _numpy.dtype([('real', _numpy.int32), ('imag', _numpy.int32)])
+complexUInt8 = _numpy.dtype([('real', _numpy.uint8), ('imag', _numpy.uint8)])
+complexUInt16 = _numpy.dtype(
+ [('real', _numpy.uint16), ('imag', _numpy.uint16)])
+complexUInt32 = _numpy.dtype(
+ [('real', _numpy.uint32), ('imag', _numpy.uint32)])
+
+
+class StaticStringField (_DynamicField):
+ _null_terminated = False
+ _array_size_field = None
+ def __init__(self, *args, **kwargs):
+ if 'array' not in kwargs:
+ kwargs['array'] = True
+ super(StaticStringField, self).__init__(*args, **kwargs)
+
+ def post_unpack(self, parents, data):
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ d = self._normalize_string(wave_data[self.name])
+ wave_data[self.name] = d
+
+ def _normalize_string(self, d):
+ if isinstance(d, bytes):
+ pass
+ elif hasattr(d, 'tobytes'):
+ d = d.tobytes()
+ elif hasattr(d, 'tostring'): # Python 2 compatibility
+ d = d.tostring()
+ else:
+ d = b''.join(d)
+ if self._array_size_field:
+ start = 0
+ strings = []
+ for count in self.counts:
+ end = start + count
+ if end > start:
+ strings.append(d[start:end])
+ if self._null_terminated:
+ strings[-1] = strings[-1].split(b'\x00', 1)[0]
+ start = end
+ elif self._null_terminated:
+ d = d.split(b'\x00', 1)[0]
+ return d
+
+
+class NullStaticStringField (StaticStringField):
+ _null_terminated = True
# Begin IGOR constants and typedefs from IgorBin.h
# From IgorMath.h
-TYPE_TABLE = { # (key: integer flag, value: numpy dtype)
- 0:None, # Text wave, not handled in ReadWave.c
- 1:numpy.complex, # NT_CMPLX, makes number complex.
- 2:numpy.float32, # NT_FP32, 32 bit fp numbers.
- 3:numpy.complex64,
- 4:numpy.float64, # NT_FP64, 64 bit fp numbers.
- 5:numpy.complex128,
- 8:numpy.int8, # NT_I8, 8 bit signed integer. Requires Igor Pro
- # 2.0 or later.
+TYPE_TABLE = { # (key: integer flag, value: numpy dtype)
+ 0:None, # Text wave, not handled in ReadWave.c
+ 1:_numpy.complex, # NT_CMPLX, makes number complex.
+ 2:_numpy.float32, # NT_FP32, 32 bit fp numbers.
+ 3:_numpy.complex64,
+ 4:_numpy.float64, # NT_FP64, 64 bit fp numbers.
+ 5:_numpy.complex128,
+ 8:_numpy.int8, # NT_I8, 8 bit signed integer. Requires Igor Pro
+ # 2.0 or later.
9:complexInt8,
- 0x10:numpy.int16,# NT_I16, 16 bit integer numbers. Requires Igor
- # Pro 2.0 or later.
+ 0x10:_numpy.int16,# NT_I16, 16 bit integer numbers. Requires Igor
+ # Pro 2.0 or later.
0x11:complexInt16,
- 0x20:numpy.int32,# NT_I32, 32 bit integer numbers. Requires Igor
- # Pro 2.0 or later.
+ 0x20:_numpy.int32,# NT_I32, 32 bit integer numbers. Requires Igor
+ # Pro 2.0 or later.
0x21:complexInt32,
-# 0x40:None, # NT_UNSIGNED, Makes above signed integers
-# # unsigned. Requires Igor Pro 3.0 or later.
- 0x48:numpy.uint8,
+# 0x40:None, # NT_UNSIGNED, Makes above signed integers
+# # unsigned. Requires Igor Pro 3.0 or later.
+ 0x48:_numpy.uint8,
0x49:complexUInt8,
- 0x50:numpy.uint16,
+ 0x50:_numpy.uint16,
0x51:complexUInt16,
- 0x60:numpy.uint32,
+ 0x60:_numpy.uint32,
0x61:complexUInt32,
}
MAXDIMS = 4
# From binary.h
-BinHeaderCommon = Structure( # WTK: this one is mine.
- name='BinHeaderCommon',
- fields=[
- Field('h', 'version', help='Version number for backwards compatibility.'),
- ])
-
-BinHeader1 = Structure(
+BinHeader1 = _Structure( # `version` field pulled out into Wave
name='BinHeader1',
fields=[
- Field('h', 'version', help='Version number for backwards compatibility.'),
- Field('l', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
- Field('h', 'checksum', help='Checksum over this header and the wave header.'),
+ _Field('l', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
+ _Field('h', 'checksum', help='Checksum over this header and the wave header.'),
])
-BinHeader2 = Structure(
+BinHeader2 = _Structure( # `version` field pulled out into Wave
name='BinHeader2',
fields=[
- Field('h', 'version', help='Version number for backwards compatibility.'),
- Field('l', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
- Field('l', 'noteSize', help='The size of the note text.'),
- Field('l', 'pictSize', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('h', 'checksum', help='Checksum over this header and the wave header.'),
+ _Field('l', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
+ _Field('l', 'noteSize', help='The size of the note text.'),
+ _Field('l', 'pictSize', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('h', 'checksum', help='Checksum over this header and the wave header.'),
])
-BinHeader3 = Structure(
+BinHeader3 = _Structure( # `version` field pulled out into Wave
name='BinHeader3',
fields=[
- Field('h', 'version', help='Version number for backwards compatibility.'),
- Field('h', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
- Field('l', 'noteSize', help='The size of the note text.'),
- Field('l', 'formulaSize', help='The size of the dependency formula, if any.'),
- Field('l', 'pictSize', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('h', 'checksum', help='Checksum over this header and the wave header.'),
+ _Field('l', 'wfmSize', help='The size of the WaveHeader2 data structure plus the wave data plus 16 bytes of padding.'),
+ _Field('l', 'noteSize', help='The size of the note text.'),
+ _Field('l', 'formulaSize', help='The size of the dependency formula, if any.'),
+ _Field('l', 'pictSize', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('h', 'checksum', help='Checksum over this header and the wave header.'),
])
-BinHeader5 = Structure(
+BinHeader5 = _Structure( # `version` field pulled out into Wave
name='BinHeader5',
fields=[
- Field('h', 'version', help='Version number for backwards compatibility.'),
- Field('h', 'checksum', help='Checksum over this header and the wave header.'),
- Field('l', 'wfmSize', help='The size of the WaveHeader5 data structure plus the wave data.'),
- Field('l', 'formulaSize', help='The size of the dependency formula, if any.'),
- Field('l', 'noteSize', help='The size of the note text.'),
- Field('l', 'dataEUnitsSize', help='The size of optional extended data units.'),
- Field('l', 'dimEUnitsSize', help='The size of optional extended dimension units.', count=MAXDIMS),
- Field('l', 'dimLabelsSize', help='The size of optional dimension labels.', count=MAXDIMS),
- Field('l', 'sIndicesSize', help='The size of string indicies if this is a text wave.'),
- Field('l', 'optionsSize1', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('l', 'optionsSize2', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('h', 'checksum', help='Checksum over this header and the wave header.'),
+ _Field('l', 'wfmSize', help='The size of the WaveHeader5 data structure plus the wave data.'),
+ _Field('l', 'formulaSize', help='The size of the dependency formula, if any.'),
+ _Field('l', 'noteSize', help='The size of the note text.'),
+ _Field('l', 'dataEUnitsSize', help='The size of optional extended data units.'),
+ _Field('l', 'dimEUnitsSize', help='The size of optional extended dimension units.', count=MAXDIMS, array=True),
+ _Field('l', 'dimLabelsSize', help='The size of optional dimension labels.', count=MAXDIMS, array=True),
+ _Field('l', 'sIndicesSize', help='The size of string indicies if this is a text wave.'),
+ _Field('l', 'optionsSize1', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('l', 'optionsSize2', default=0, help='Reserved. Write zero. Ignore on read.'),
])
# Header to an array of waveform data.
-WaveHeader2 = Structure(
+# `wData` field pulled out into DynamicWaveDataField1
+WaveHeader2 = _DynamicStructure(
name='WaveHeader2',
fields=[
- Field('h', 'type', help='See types (e.g. NT_FP64) above. Zero for text waves.'),
- Field('P', 'next', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('c', 'bname', help='Name of wave plus trailing null.', count=MAX_WAVE_NAME2+2),
- Field('h', 'whVersion', default=0, help='Write 0. Ignore on read.'),
- Field('h', 'srcFldr', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('P', 'fileName', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('c', 'dataUnits', default=0, help='Natural data units go here - null if none.', count=MAX_UNIT_CHARS+1),
- Field('c', 'xUnits', default=0, help='Natural x-axis units go here - null if none.', count=MAX_UNIT_CHARS+1),
- Field('l', 'npnts', help='Number of data points in wave.'),
- Field('h', 'aModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('d', 'hsA', help='X value for point p = hsA*p + hsB'),
- Field('d', 'hsB', help='X value for point p = hsA*p + hsB'),
- Field('h', 'wModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('h', 'swModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('h', 'fsValid', help='True if full scale values have meaning.'),
- Field('d', 'topFullScale', help='The min full scale value for wave.'), # sic, 'min' should probably be 'max'
- Field('d', 'botFullScale', help='The min full scale value for wave.'),
- Field('c', 'useBits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('c', 'kindBits', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('P', 'formula', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('l', 'depID', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('L', 'creationDate', help='DateTime of creation. Not used in version 1 files.'),
- Field('c', 'wUnused', default=0, help='Reserved. Write zero. Ignore on read.', count=2),
- Field('L', 'modDate', help='DateTime of last modification.'),
- Field('P', 'waveNoteH', help='Used in memory only. Write zero. Ignore on read.'),
- Field('f', 'wData', help='The start of the array of waveform data.', count=4),
+ _Field('h', 'type', help='See types (e.g. NT_FP64) above. Zero for text waves.'),
+ _Field('P', 'next', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ NullStaticStringField('c', 'bname', help='Name of wave plus trailing null.', count=MAX_WAVE_NAME2+2),
+ _Field('h', 'whVersion', default=0, help='Write 0. Ignore on read.'),
+ _Field('h', 'srcFldr', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('P', 'fileName', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('c', 'dataUnits', default=0, help='Natural data units go here - null if none.', count=MAX_UNIT_CHARS+1, array=True),
+ _Field('c', 'xUnits', default=0, help='Natural x-axis units go here - null if none.', count=MAX_UNIT_CHARS+1, array=True),
+ _Field('l', 'npnts', help='Number of data points in wave.'),
+ _Field('h', 'aModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('d', 'hsA', help='X value for point p = hsA*p + hsB'),
+ _Field('d', 'hsB', help='X value for point p = hsA*p + hsB'),
+ _Field('h', 'wModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('h', 'swModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('h', 'fsValid', help='True if full scale values have meaning.'),
+ _Field('d', 'topFullScale', help='The min full scale value for wave.'), # sic, 'min' should probably be 'max'
+ _Field('d', 'botFullScale', help='The min full scale value for wave.'),
+ _Field('c', 'useBits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('c', 'kindBits', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('P', 'formula', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('l', 'depID', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('L', 'creationDate', help='DateTime of creation. Not used in version 1 files.'),
+ _Field('c', 'wUnused', default=0, help='Reserved. Write zero. Ignore on read.', count=2, array=True),
+ _Field('L', 'modDate', help='DateTime of last modification.'),
+ _Field('P', 'waveNoteH', help='Used in memory only. Write zero. Ignore on read.'),
])
-WaveHeader5 = Structure(
+# `sIndices` pointer unset (use Wave5_data['sIndices'] instead). This
+# field is filled in by DynamicStringIndicesDataField.
+# `wData` field pulled out into DynamicWaveDataField5
+WaveHeader5 = _DynamicStructure(
name='WaveHeader5',
fields=[
- Field('P', 'next', help='link to next wave in linked list.'),
- Field('L', 'creationDate', help='DateTime of creation.'),
- Field('L', 'modDate', help='DateTime of last modification.'),
- Field('l', 'npnts', help='Total number of points (multiply dimensions up to first zero).'),
- Field('h', 'type', help='See types (e.g. NT_FP64) above. Zero for text waves.'),
- Field('h', 'dLock', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('c', 'whpad1', default=0, help='Reserved. Write zero. Ignore on read.', count=6),
- Field('h', 'whVersion', default=1, help='Write 1. Ignore on read.'),
- Field('c', 'bname', help='Name of wave plus trailing null.', count=MAX_WAVE_NAME5+1),
- Field('l', 'whpad2', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('P', 'dFolder', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('P', 'next', help='link to next wave in linked list.'),
+ _Field('L', 'creationDate', help='DateTime of creation.'),
+ _Field('L', 'modDate', help='DateTime of last modification.'),
+ _Field('l', 'npnts', help='Total number of points (multiply dimensions up to first zero).'),
+ _Field('h', 'type', help='See types (e.g. NT_FP64) above. Zero for text waves.'),
+ _Field('h', 'dLock', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('c', 'whpad1', default=0, help='Reserved. Write zero. Ignore on read.', count=6, array=True),
+ _Field('h', 'whVersion', default=1, help='Write 1. Ignore on read.'),
+ NullStaticStringField('c', 'bname', help='Name of wave plus trailing null.', count=MAX_WAVE_NAME5+1),
+ _Field('l', 'whpad2', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('P', 'dFolder', default=0, help='Used in memory only. Write zero. Ignore on read.'),
# Dimensioning info. [0] == rows, [1] == cols etc
- Field('l', 'nDim', help='Number of of items in a dimension -- 0 means no data.', count=MAXDIMS),
- Field('d', 'sfA', help='Index value for element e of dimension d = sfA[d]*e + sfB[d].', count=MAXDIMS),
- Field('d', 'sfB', help='Index value for element e of dimension d = sfA[d]*e + sfB[d].', count=MAXDIMS),
+ _Field('l', 'nDim', help='Number of of items in a dimension -- 0 means no data.', count=MAXDIMS, array=True),
+ _Field('d', 'sfA', help='Index value for element e of dimension d = sfA[d]*e + sfB[d].', count=MAXDIMS, array=True),
+ _Field('d', 'sfB', help='Index value for element e of dimension d = sfA[d]*e + sfB[d].', count=MAXDIMS, array=True),
# SI units
- Field('c', 'dataUnits', default=0, help='Natural data units go here - null if none.', count=MAX_UNIT_CHARS+1),
- Field('c', 'dimUnits', default=0, help='Natural dimension units go here - null if none.', count=(MAXDIMS, MAX_UNIT_CHARS+1)),
- Field('h', 'fsValid', help='TRUE if full scale values have meaning.'),
- Field('h', 'whpad3', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('d', 'topFullScale', help='The max and max full scale value for wave'), # sic, probably "max and min"
- Field('d', 'botFullScale', help='The max and max full scale value for wave.'), # sic, probably "max and min"
- Field('P', 'dataEUnits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('P', 'dimEUnits', default=0, help='Used in memory only. Write zero. Ignore on read.', count=MAXDIMS),
- Field('P', 'dimLabels', default=0, help='Used in memory only. Write zero. Ignore on read.', count=MAXDIMS),
- Field('P', 'waveNoteH', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('l', 'whUnused', default=0, help='Reserved. Write zero. Ignore on read.', count=16),
+ _Field('c', 'dataUnits', default=0, help='Natural data units go here - null if none.', count=MAX_UNIT_CHARS+1, array=True),
+ _Field('c', 'dimUnits', default=0, help='Natural dimension units go here - null if none.', count=(MAXDIMS, MAX_UNIT_CHARS+1), array=True),
+ _Field('h', 'fsValid', help='TRUE if full scale values have meaning.'),
+ _Field('h', 'whpad3', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('d', 'topFullScale', help='The max and max full scale value for wave'), # sic, probably "max and min"
+ _Field('d', 'botFullScale', help='The max and max full scale value for wave.'), # sic, probably "max and min"
+ _Field('P', 'dataEUnits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('P', 'dimEUnits', default=0, help='Used in memory only. Write zero. Ignore on read.', count=MAXDIMS, array=True),
+ _Field('P', 'dimLabels', default=0, help='Used in memory only. Write zero. Ignore on read.', count=MAXDIMS, array=True),
+ _Field('P', 'waveNoteH', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('l', 'whUnused', default=0, help='Reserved. Write zero. Ignore on read.', count=16, array=True),
# The following stuff is considered private to Igor.
- Field('h', 'aModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('h', 'wModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('h', 'swModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('c', 'useBits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('c', 'kindBits', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('P', 'formula', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('l', 'depID', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('h', 'whpad4', default=0, help='Reserved. Write zero. Ignore on read.'),
- Field('h', 'srcFldr', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('P', 'fileName', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('P', 'sIndices', default=0, help='Used in memory only. Write zero. Ignore on read.'),
- Field('f', 'wData', help='The start of the array of data. Must be 64 bit aligned.', count=1),
+ _Field('h', 'aModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('h', 'wModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('h', 'swModified', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('c', 'useBits', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('c', 'kindBits', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('P', 'formula', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('l', 'depID', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('h', 'whpad4', default=0, help='Reserved. Write zero. Ignore on read.'),
+ _Field('h', 'srcFldr', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('P', 'fileName', default=0, help='Used in memory only. Write zero. Ignore on read.'),
+ _Field('P', 'sIndices', default=0, help='Used in memory only. Write zero. Ignore on read.'),
])
-# End IGOR constants and typedefs from IgorBin.h
-# Begin functions from ReadWave.c
-
-def need_to_reorder_bytes(version):
- # If the low order byte of the version field of the BinHeader
- # structure is zero then the file is from a platform that uses
- # different byte-ordering and therefore all data will need to be
- # reordered.
- return version & 0xFF == 0
-
-def byte_order(needToReorderBytes):
- little_endian = sys.byteorder == 'little'
- if needToReorderBytes:
- little_endian = not little_endian
- if little_endian:
- return '<' # little-endian
- return '>' # big-endian
-
-def version_structs(version, byte_order):
- if version == 1:
- bin = BinHeader1
- wave = WaveHeader2
- elif version == 2:
- bin = BinHeader2
- wave = WaveHeader2
- elif version == 3:
- bin = BinHeader3
- wave = WaveHeader2
- elif version == 5:
- bin = BinHeader5
- wave = WaveHeader5
- else:
- raise ValueError(
- ('This does not appear to be a valid Igor binary wave file. '
- 'The version field = {}.\n').format(version))
- checkSumSize = bin.size + wave.size
- if version == 5:
- checkSumSize -= 4 # Version 5 checksum does not include the wData field.
- bin.set_byte_order(byte_order)
- wave.set_byte_order(byte_order)
- return (bin, wave, checkSumSize)
-
-def checksum(buffer, byte_order, oldcksum, numbytes):
- x = numpy.ndarray(
- (numbytes/2,), # 2 bytes to a short -- ignore trailing odd byte
- dtype=numpy.dtype(byte_order+'h'),
- buffer=buffer)
- oldcksum += x.sum()
- if oldcksum > 2**31: # fake the C implementation's int rollover
- oldcksum %= 2**32
- if oldcksum > 2**31:
- oldcksum -= 2**31
- return oldcksum & 0xffff
-
-# Translated from ReadWave()
-def loadibw(filename, strict=True):
- if hasattr(filename, 'read'):
- f = filename # filename is actually a stream object
- else:
- f = open(filename, 'rb')
- try:
- b = buffer(f.read(BinHeaderCommon.size))
- version = BinHeaderCommon.unpack_dict_from(b)['version']
- needToReorderBytes = need_to_reorder_bytes(version)
- byteOrder = byte_order(needToReorderBytes)
-
- if needToReorderBytes:
- BinHeaderCommon.set_byte_order(byteOrder)
- version = BinHeaderCommon.unpack_dict_from(b)['version']
- bin_struct,wave_struct,checkSumSize = version_structs(version, byteOrder)
-
- b = buffer(b + f.read(bin_struct.size + wave_struct.size - BinHeaderCommon.size))
- c = checksum(b, byteOrder, 0, checkSumSize)
- if c != 0:
- raise ValueError(
- ('This does not appear to be a valid Igor binary wave file. '
- 'Error in checksum: should be 0, is {}.').format(c))
- bin_info = bin_struct.unpack_dict_from(b)
- wave_info = wave_struct.unpack_dict_from(b, offset=bin_struct.size)
- if wave_info['type'] == 0:
- raise NotImplementedError('Text wave')
- if version in [1,2,3]:
- tail = 16 # 16 = size of wData field in WaveHeader2 structure
- waveDataSize = bin_info['wfmSize'] - wave_struct.size
- # = bin_info['wfmSize']-16 - (wave_struct.size - tail)
- else:
- assert version == 5, version
- tail = 4 # 4 = size of wData field in WaveHeader5 structure
- waveDataSize = bin_info['wfmSize'] - (wave_struct.size - tail)
+class DynamicWaveDataField1 (_DynamicField):
+ def pre_pack(self, parents, data):
+ raise NotImplementedError()
+
+ def pre_unpack(self, parents, data):
+ full_structure = parents[0]
+ wave_structure = parents[-1]
+ wave_header_structure = wave_structure.fields[1].format
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ version = data['version']
+ bin_header = wave_data['bin_header']
+ wave_header = wave_data['wave_header']
+
+ self.count = wave_header['npnts']
+ self.data_size = self._get_size(bin_header, wave_header_structure.size)
+
+ type_ = TYPE_TABLE.get(wave_header['type'], None)
+ if type_:
+ self.shape = self._get_shape(bin_header, wave_header)
+ else: # text wave
+ type_ = _numpy.dtype('S1')
+ self.shape = (self.data_size,)
# dtype() wrapping to avoid numpy.generic and
- # getset_descriptor issues with the builtin Numpy types
+ # getset_descriptor issues with the builtin numpy types
# (e.g. int32). It has no effect on our local complex
# integers.
- t = numpy.dtype(TYPE_TABLE[wave_info['type']])
- assert waveDataSize == wave_info['npnts'] * t.itemsize, (
- '{}, {}, {}, {}'.format(
- waveDataSize, wave_info['npnts'], t.itemsize, t))
- tail_data = array.array('f', b[-tail:])
- data_b = buffer(buffer(tail_data) + f.read(waveDataSize-tail))
- if version == 5:
- shape = [n for n in wave_info['nDim'] if n > 0]
+ self.dtype = _numpy.dtype(type_).newbyteorder(
+ wave_structure.byte_order)
+ if (version == 3 and
+ self.count > 0 and
+ bin_header['formulaSize'] > 0 and
+ self.data_size == 0):
+ """From TN003:
+
+ Igor Pro 2.00 included support for dependency formulae. If
+ a wave was governed by a dependency formula then the
+ actual wave data was not written to disk for that wave,
+ because on loading the wave Igor could recalculate the
+ data. However,this prevented the wave from being loaded
+ into an experiment other than the original
+ experiment. Consequently, in a version of Igor Pro 3.0x,
+ we changed it so that the wave data was written even if
+ the wave was governed by a dependency formula. When
+ reading a binary wave file, you can detect that the wave
+ file does not contain the wave data by examining the
+ wfmSize, formulaSize and npnts fields. If npnts is greater
+ than zero and formulaSize is greater than zero and
+ the waveDataSize as calculated above is zero, then this is
+ a file governed by a dependency formula that was written
+ without the actual wave data.
+ """
+ self.shape = (0,)
+ elif TYPE_TABLE.get(wave_header['type'], None) is not None:
+ assert self.data_size == self.count * self.dtype.itemsize, (
+ self.data_size, self.count, self.dtype.itemsize, self.dtype)
+ else:
+ assert self.data_size >= 0, (
+ bin_header['wfmSize'], wave_header_structure.size)
+
+ def _get_size(self, bin_header, wave_header_size):
+ return bin_header['wfmSize'] - wave_header_size - 16
+
+ def _get_shape(self, bin_header, wave_header):
+ return (self.count,)
+
+ def unpack(self, stream):
+ data_b = stream.read(self.data_size)
+ try:
+ data = _numpy.ndarray(
+ shape=self.shape,
+ dtype=self.dtype,
+ buffer=data_b,
+ order='F',
+ )
+ except:
+ _LOG.error(
+ 'could not reshape data from {} to {}'.format(
+ self.shape, data_b))
+ raise
+ return data
+
+
+class DynamicWaveDataField5 (DynamicWaveDataField1):
+ "Adds support for multidimensional data."
+ def _get_size(self, bin_header, wave_header_size):
+ return bin_header['wfmSize'] - wave_header_size
+
+ def _get_shape(self, bin_header, wave_header):
+ return [n for n in wave_header['nDim'] if n > 0] or (0,)
+
+
+# End IGOR constants and typedefs from IgorBin.h
+
+
+class DynamicStringField (StaticStringField):
+ _size_field = None
+
+ def pre_unpack(self, parents, data):
+ size = self._get_size_data(parents, data)
+ if self._array_size_field:
+ self.counts = size
+ self.count = sum(self.counts)
+ else:
+ self.count = size
+ self.setup()
+
+ def _get_size_data(self, parents, data):
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ bin_header = wave_data['bin_header']
+ return bin_header[self._size_field]
+
+
+class DynamicWaveNoteField (DynamicStringField):
+ _size_field = 'noteSize'
+
+
+class DynamicDependencyFormulaField (DynamicStringField):
+ """Optional wave dependency formula
+
+ Excerpted from TN003:
+
+ A wave has a dependency formula if it has been bound by a
+ statement such as "wave0 := sin(x)". In this example, the
+ dependency formula is "sin(x)". The formula is stored with
+ no trailing null byte.
+ """
+ _size_field = 'formulaSize'
+ # Except when it is stored with a trailing null byte :p. See, for
+ # example, test/data/mac-version3Dependent.ibw.
+ _null_terminated = True
+
+
+class DynamicDataUnitsField (DynamicStringField):
+ """Optional extended data units data
+
+ Excerpted from TN003:
+
+ dataUnits - Present in versions 1, 2, 3, 5. The dataUnits field
+ stores the units for the data represented by the wave. It is a C
+ string terminated with a null character. This field supports
+ units of 0 to 3 bytes. In version 1, 2 and 3 files, longer units
+ can not be represented. In version 5 files, longer units can be
+ stored using the optional extended data units section of the
+ file.
+ """
+ _size_field = 'dataEUnitsSize'
+
+
+class DynamicDimensionUnitsField (DynamicStringField):
+ """Optional extended dimension units data
+
+ Excerpted from TN003:
+
+ xUnits - Present in versions 1, 2, 3. The xUnits field stores the
+ X units for a wave. It is a C string terminated with a null
+ character. This field supports units of 0 to 3 bytes. In
+ version 1, 2 and 3 files, longer units can not be represented.
+
+ dimUnits - Present in version 5 only. This field is an array of 4
+ strings, one for each possible wave dimension. Each string
+ supports units of 0 to 3 bytes. Longer units can be stored using
+ the optional extended dimension units section of the file.
+ """
+ _size_field = 'dimEUnitsSize'
+ _array_size_field = True
+
+
+class DynamicLabelsField (DynamicStringField):
+ """Optional dimension label data
+
+ From TN003:
+
+ If the wave has dimension labels for dimension d then the
+ dimLabelsSize[d] field of the BinHeader5 structure will be
+ non-zero.
+
+ A wave will have dimension labels if a SetDimLabel command has
+ been executed on it.
+
+ A 3 point 1D wave has 4 dimension labels. The first dimension
+ label is the label for the dimension as a whole. The next three
+ dimension labels are the labels for rows 0, 1, and 2. When Igor
+ writes dimension labels to disk, it writes each dimension label as
+ a C string (null-terminated) in a field of 32 bytes.
+ """
+ _size_field = 'dimLabelsSize'
+ _array_size_field = True
+
+ def post_unpack(self, parents, data):
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ bin_header = wave_data['bin_header']
+ d = wave_data[self.name]
+ dim_labels = []
+ start = 0
+ for size in bin_header[self._size_field]:
+ end = start + size
+ if end > start:
+ dim_data = d[start:end]
+ chunks = []
+ for i in range(size//32):
+ chunks.append(dim_data[32*i:32*(i+1)])
+ labels = [b'']
+ for chunk in chunks:
+ labels[-1] = labels[-1] + b''.join(chunk)
+ if b'\x00' in chunk:
+ labels.append(b'')
+ labels.pop(-1)
+ start = end
+ else:
+ labels = []
+ dim_labels.append(labels)
+ wave_data[self.name] = dim_labels
+
+
+class DynamicStringIndicesDataField (_DynamicField):
+ """String indices used for text waves only
+ """
+ def pre_pack(self, parents, data):
+ raise NotImplementedError()
+
+ def pre_unpack(self, parents, data):
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ bin_header = wave_data['bin_header']
+ wave_header = wave_data['wave_header']
+ self.string_indices_size = bin_header['sIndicesSize']
+ self.count = self.string_indices_size // 4
+ if self.count: # make sure we're in a text wave
+ assert TYPE_TABLE[wave_header['type']] is None, wave_header
+ self.setup()
+
+ def post_unpack(self, parents, data):
+ if not self.count:
+ return
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ wave_header = wave_data['wave_header']
+ wdata = wave_data['wData']
+ strings = []
+ start = 0
+ for i,offset in enumerate(wave_data['sIndices']):
+ if offset > start:
+ chars = wdata[start:offset]
+ strings.append(b''.join(chars))
+ start = offset
+ elif offset == start:
+ strings.append(b'')
+ else:
+ raise ValueError((offset, wave_data['sIndices']))
+ wdata = _numpy.array(strings)
+ shape = [n for n in wave_header['nDim'] if n > 0] or (0,)
+ try:
+ wdata = wdata.reshape(shape)
+ except ValueError:
+ _LOG.error(
+ 'could not reshape strings from {} to {}'.format(
+ shape, wdata.shape))
+ raise
+ wave_data['wData'] = wdata
+
+
+class DynamicVersionField (_DynamicField):
+ def pre_pack(self, parents, byte_order):
+ raise NotImplementedError()
+
+ def post_unpack(self, parents, data):
+ wave_structure = parents[-1]
+ wave_data = self._get_structure_data(parents, data, wave_structure)
+ version = wave_data['version']
+ if wave_structure.byte_order in '@=':
+ need_to_reorder_bytes = _need_to_reorder_bytes(version)
+ wave_structure.byte_order = _byte_order(need_to_reorder_bytes)
+ _LOG.debug(
+ 'get byte order from version: {} (reorder? {})'.format(
+ wave_structure.byte_order, need_to_reorder_bytes))
else:
- shape = (wave_info['npnts'],)
- data = numpy.ndarray(
- shape=shape,
- dtype=t.newbyteorder(byteOrder),
- buffer=data_b,
- order='F',
- )
+ need_to_reorder_bytes = False
+ old_format = wave_structure.fields[-1].format
if version == 1:
- pass # No post-data information
+ wave_structure.fields[-1].format = Wave1
elif version == 2:
- # Post-data info:
- # * 16 bytes of padding
- # * Optional wave note data
- pad_b = buffer(f.read(16)) # skip the padding
- if max(pad_b) != 0:
- if strict:
- assert max(pad_b) == 0, pad_b
- else:
- sys.stderr.write(
- 'warning: post-data padding not zero: {}\n'.format(
- pad_b))
- bin_info['note'] = str(f.read(bin_info['noteSize'])).strip()
+ wave_structure.fields[-1].format = Wave2
elif version == 3:
- # Post-data info:
- # * 16 bytes of padding
- # * Optional wave note data
- # * Optional wave dependency formula
- """Excerpted from TN003:
-
- A wave has a dependency formula if it has been bound by a
- statement such as "wave0 := sin(x)". In this example, the
- dependency formula is "sin(x)". The formula is stored with
- no trailing null byte.
- """
- pad_b = buffer(f.read(16)) # skip the padding
- if max(pad_b) != 0:
- if strict:
- assert max(pad_b) == 0, pad_b
- else:
- sys.stderr.write(
- 'warning: post-data padding not zero: {}\n'.format(
- pad_b))
- bin_info['note'] = str(f.read(bin_info['noteSize'])).strip()
- bin_info['formula'] = str(f.read(bin_info['formulaSize'])).strip()
+ wave_structure.fields[-1].format = Wave3
elif version == 5:
- # Post-data info:
- # * Optional wave dependency formula
- # * Optional wave note data
- # * Optional extended data units data
- # * Optional extended dimension units data
- # * Optional dimension label data
- # * String indices used for text waves only
- """Excerpted from TN003:
-
- dataUnits - Present in versions 1, 2, 3, 5. The dataUnits
- field stores the units for the data represented by the
- wave. It is a C string terminated with a null
- character. This field supports units of 0 to 3 bytes. In
- version 1, 2 and 3 files, longer units can not be
- represented. In version 5 files, longer units can be
- stored using the optional extended data units section of
- the file.
-
- xUnits - Present in versions 1, 2, 3. The xUnits field
- stores the X units for a wave. It is a C string
- terminated with a null character. This field supports
- units of 0 to 3 bytes. In version 1, 2 and 3 files,
- longer units can not be represented.
-
- dimUnits - Present in version 5 only. This field is an
- array of 4 strings, one for each possible wave
- dimension. Each string supports units of 0 to 3
- bytes. Longer units can be stored using the optional
- extended dimension units section of the file.
- """
- bin_info['formula'] = str(f.read(bin_info['formulaSize'])).strip()
- bin_info['note'] = str(f.read(bin_info['noteSize'])).strip()
- bin_info['dataEUnits'] = str(f.read(bin_info['dataEUnitsSize'])).strip()
- bin_info['dimEUnits'] = [
- str(f.read(size)).strip() for size in bin_info['dimEUnitsSize']]
- bin_info['dimLabels'] = []
- for size in bin_info['dimLabelsSize']:
- labels = str(f.read(size)).split(chr(0)) # split null-delimited strings
- bin_info['dimLabels'].append([L for L in labels if len(L) > 0])
- if wave_info['type'] == 0: # text wave
- bin_info['sIndices'] = f.read(bin_info['sIndicesSize'])
+ wave_structure.fields[-1].format = Wave5
+ elif not need_to_reorder_bytes:
+ raise ValueError(
+ 'invalid binary wave version: {}'.format(version))
+
+ if wave_structure.fields[-1].format != old_format:
+ _LOG.debug('change wave headers from {} to {}'.format(
+ old_format, wave_structure.fields[-1].format))
+ wave_structure.setup()
+ elif need_to_reorder_bytes:
+ wave_structure.setup()
+
+ # we might need to unpack again with the new byte order
+ return need_to_reorder_bytes
+
+class DynamicWaveField (_DynamicField):
+ def post_unpack(self, parents, data):
+ return
+ raise NotImplementedError() # TODO
+ checksum_size = bin.size + wave.size
+ wave_structure = parents[-1]
+ if version == 5:
+ # Version 5 checksum does not include the wData field.
+ checksum_size -= 4
+ c = _checksum(b, parents[-1].byte_order, 0, checksum_size)
+ if c != 0:
+ raise ValueError(
+ ('This does not appear to be a valid Igor binary wave file. '
+ 'Error in checksum: should be 0, is {}.').format(c))
+
+Wave1 = _DynamicStructure(
+ name='Wave1',
+ fields=[
+ _Field(BinHeader1, 'bin_header', help='Binary wave header'),
+ _Field(WaveHeader2, 'wave_header', help='Wave header'),
+ DynamicWaveDataField1('f', 'wData', help='The start of the array of waveform data.', count=0, array=True),
+ ])
+
+Wave2 = _DynamicStructure(
+ name='Wave2',
+ fields=[
+ _Field(BinHeader2, 'bin_header', help='Binary wave header'),
+ _Field(WaveHeader2, 'wave_header', help='Wave header'),
+ DynamicWaveDataField1('f', 'wData', help='The start of the array of waveform data.', count=0, array=True),
+ _Field('x', 'padding', help='16 bytes of padding in versions 2 and 3.', count=16, array=True),
+ DynamicWaveNoteField('c', 'note', help='Optional wave note data', count=0, array=True),
+ ])
+
+Wave3 = _DynamicStructure(
+ name='Wave3',
+ fields=[
+ _Field(BinHeader3, 'bin_header', help='Binary wave header'),
+ _Field(WaveHeader2, 'wave_header', help='Wave header'),
+ DynamicWaveDataField1('f', 'wData', help='The start of the array of waveform data.', count=0, array=True),
+ _Field('x', 'padding', help='16 bytes of padding in versions 2 and 3.', count=16, array=True),
+ DynamicWaveNoteField('c', 'note', help='Optional wave note data', count=0, array=True),
+ DynamicDependencyFormulaField('c', 'formula', help='Optional wave dependency formula', count=0, array=True),
+ ])
+
+Wave5 = _DynamicStructure(
+ name='Wave5',
+ fields=[
+ _Field(BinHeader5, 'bin_header', help='Binary wave header'),
+ _Field(WaveHeader5, 'wave_header', help='Wave header'),
+ DynamicWaveDataField5('f', 'wData', help='The start of the array of waveform data.', count=0, array=True),
+ DynamicDependencyFormulaField('c', 'formula', help='Optional wave dependency formula.', count=0, array=True),
+ DynamicWaveNoteField('c', 'note', help='Optional wave note data.', count=0, array=True),
+ DynamicDataUnitsField('c', 'data_units', help='Optional extended data units data.', count=0, array=True),
+ DynamicDimensionUnitsField('c', 'dimension_units', help='Optional dimension label data', count=0, array=True),
+ DynamicLabelsField('c', 'labels', help="Optional dimension label data", count=0, array=True),
+ DynamicStringIndicesDataField('P', 'sIndices', help='Dynamic string indices for text waves.', count=0, array=True),
+ ])
+
+Wave = _DynamicStructure(
+ name='Wave',
+ fields=[
+ DynamicVersionField('h', 'version', help='Version number for backwards compatibility.'),
+ DynamicWaveField(Wave1, 'wave', help='The rest of the wave data.'),
+ ])
+
+
+def load(filename):
+ if hasattr(filename, 'read'):
+ f = filename # filename is actually a stream object
+ else:
+ f = open(filename, 'rb')
+ try:
+ Wave.byte_order = '='
+ Wave.setup()
+ data = Wave.unpack_stream(f)
finally:
if not hasattr(filename, 'read'):
f.close()
- return data, bin_info, wave_info
+ return data
-def saveibw(filename):
+def save(filename):
raise NotImplementedError
projects / igor.git / blobdiff