taffmat 1.0.1
Read and write Teac TAFFmat files.
License: MIT

taffmat
=======

|PyPi Version| |Build Status| |Coverage Status| |License Badge|

A Python 3.4+ module for reading and writing Teac TAFFmat files.

About the TAFFmat file format
-----------------------------

TAFFmat is Teac’s proprietary file format used to store data from their
LX series and other data recorders.

According to the Teac “LX Series Recording Unit Instruction Manual”:

    TAFFmat (an acronym for Teac Data Acquisition File Format) is a file
    format composed of the following:

    -  a data file containing A/D (analog to digital) converted data.
       The file is binary format with the extension dat.
    -  a header file containing information such as recording
       conditions. The file is in text format with the extension hdr.

TAFFmat is a trademark of Teac Corporation.

Data Recorders Using TAFFmat
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following data recorders store their data in the TAFFmat file
format:

-  Teac
   `LX-10/20 <http://www.teac.co.jp/en/industry/measurement/datarecorder/lx10/index.html>`__
-  Teac `LX-110/120 <http://teac-ipd.com/data-recorders/lx-110120/>`__
-  Teac `WX-7000 Series <http://teac-ipd.com/wx-7000/>`__
-  Teac `es8 <http://teac-ipd.com/data-recorders/es8/>`__

Installation
------------

You can install `taffmat <https://github.com/questrail/taffmat>`__
either via the Python Package Index (PyPI) or from source.

To install using pip:

.. code:: bash

    $ pip install taffmat

**Source:** https://github.com/questrail/taffmat

Requirements
------------

`taffmat <https://github.com/questrail/taffmat>`__ requires the
following Python packages:

-  `numpy <http://www.numpy.org>`__

Public API
----------

The following functions are provided:

-  ``change_slope(data_array, series, gain)``
-  ``read_taffmat(input_file)``
-  ``write_taffmat(data_array, header_data, output_base_filename)``
-  ``write_taffmat_slice(data_array, header_data, output_base_filename,                      starting_data_index, ending_data_index``

Contributing
------------

`taffmat <https://github.com/questrail/taffmat>`__ is developed using
`Scott Chacon <http://scottchacon.com/about.html>`__\ ’s `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__. To
contribute, fork `taffmat <https://github.com/questrail/taffmat>`__,
create a feature branch, and then submit a pull request. `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__ is
summarized as:

-  Anything in the ``master`` branch is deployable
-  To work on something new, create a descriptively named branch off of
   ``master`` (e.g., ``new-oauth2-scopes``)
-  Commit to that branch locally and regularly push your work to the
   same named branch on the server
-  When you need feedback or help, or you think the brnach is ready for
   merging, open a `pull
   request <https://help.github.com/articles/using-pull-requests>`__.
-  After someone else has reviewed and signed off on the feature, you
   can merge it into master.
-  Once it is merged and pushed to ``master``, you can and *should*
   deploy immediately.

License
-------

`taffmat <https://github.com/questrail/taffmat>`__ is released under the
MIT license. Please see the
`LICENSE.txt <https://github.com/questrail/taffmat/blob/master/LICENSE.txt>`__
file for more information.

.. |PyPi Version| image:: http://img.shields.io/pypi/v/taffmat.svg
   :target: https://pypi.python.org/pypi/taffmat/
.. |Build Status| image:: http://img.shields.io/travis/questrail/taffmat/master.svg
   :target: https://travis-ci.org/questrail/taffmat
.. |Coverage Status| image:: http://img.shields.io/coveralls/questrail/taffmat/master.svg
   :target: https://coveralls.io/r/questrail/taffmat
.. |License Badge| image:: http://img.shields.io/pypi/l/taffmat.svg
   :target: https://github.com/questrail/taffmat/blob/master/LICENSE.txt