Skip to content

Latest commit

 

History

History
389 lines (286 loc) · 18.7 KB

README.md

File metadata and controls

389 lines (286 loc) · 18.7 KB

quattrocento-python

This repository contains Python code that can be used to interface with OT Bioelettronica Quattrocento HD EMG biological signal amplifier. The code is based on Sessantoquattro control repository provided by the manufacturer, and modified to work with Quattrocento.

It is designed to be relatively easily modified and embedded in any project that involves processing real time HD EMG data.

DOI

Installation

This code has been developed for a Python 3.8 environment.

Download and install it on your system:

  $ git clone https://github.com/screamuch/quattrocento-python
  $ cd quattrocento-python
  $ pip install -r requirements.txt

Configuration

The bulk of configuration happens in the configuration_generator.py file, except the network parameters.

Configuration Steps

  1. Connect Quattrocento to network and electricity, according to manufacturer's manual.

  2. Follow directions in configuration_generator.py and communication protocol to set your acquisition parameters.

  3. Set Quattrocento's network address in stream_data.py:

    # Network settings
    ip_address = '192.168.0.103'    # written on the QC's LCD
    port = 23456                    # can be changed in online interface
    
  4. Set your environment to Python 3.8. This can be done using conda, pyenv or other tool of your choice.

  5. Run $ python stream_data.py to validate that data is coming in correctly.

Default Configuration

As is, this code will print an array of integers that represent signal from each electrode. By default, it is set up to work with the following configuration:

  • MULTIPLE IN1
    • AD1x64 64 channels single adapter
    • GR10MM0808 64 Adhesive Array 10mm i.e.d. sensor
    • Extensor Digitorum Communis muscle (forearm)
    • Right side
    • Monopolar acquisition mode
    • 10Hz High Pass Filter
    • 500Hz Low Pass Filter

Usage

Demo

To run this code with default parameters, read the Configuration section to set the IP address and port of your Quattrocento device.

Then simply run:

$ python stream_data.py

Or, if you want to write the data directly into a CSV file, run:

$ python write_to_csv.py example

And you will see example.csv file with captured data.

Custom Usage

To run this code outside the demo, place stream_data.py and configuration_generator.py in your project folder. Add the following lines to your code, and use the emg_data_frame variable as you need.

import stream_data

# Network settings
ip_address = '192.168.0.103'    # written on the QC's LCD
port = 23456                    # can be changed in online interface

# Create start command and get basic setup information
(start_command,
number_of_channels,
sample_frequency,
bytes_in_sample) = stream_data.create_bin_command(start=1)

connection = stream_data.connect_to_qc(ip_address, port, start_command)

# Replace with a desired condition
while True:
    emg_data_frame = stream_data.read_emg_signal(connection,
                            number_of_channels,
                            bytes_in_sample,
                            output_milli_volts=False)

    # Adjust the following line to your needs
    print(emg_data_frame)

# Sends a stop acquisition command to quattrocento
# Not necessary, but saves battery on the amplifier
stream_data.disconnect_from_sq(connection)

Additionally, you can refer to write_to_csv.py file for an example of how it can be done.

Method Reference

stream_data.py

convert_bytes_to_int(bytes_value, bytes_in_sample)

Convert byte-array value to an integer array and apply two's complement.

create_bin_command(start)

Generates a Quattrocento-friendly command. If start is 1 (by default) - generates a start command. If 0 - generates a stop command.

bytes_to_integers(sample_from_channels_as_bytes, number_of_channels, bytes_in_sample, output_milli_volts)

Takes a byte array that contains the raw signal data for all channels, the number of channels, the number of bytes per sample, and a boolean flag that specifies whether the output should be in millivolts. It converts each channel's byte value to an integer value, applies two's complement if necessary, and returns a list of channel values as integers. If output_milli_volts is set to True, this method multiplies the channel values by a conversion factor to convert them to millivolts.

read_raw_bytes(connection, number_of_all_channels, bytes_in_sample)

Takes a socket connection to Quattrocento, the number of all channels (including accessory channels), and the number of bytes per sample. It reads raw byte data from the socket and returns the data as a byte array. This method is used to read the raw signal data from Quattrocento.

connect_to_qc(ip_address, port, start_command)

Takes the IP address and port number of Quattrocento, and a binary command to start data acquisition. It establishes a socket connection to Quattrocento, sends a command to stop data acquisition, and then sends the start command to start data acquisition. It returns the socket connection to Quattrocento.

disconnect_from_sq(conn)

Takes a socket connection to Quattrocento and sends a command to stop data acquisition. It then closes the socket connection to disconnect from Quattrocento.

read_emg_signal(connection, number_of_channels, bytes_in_sample, output_milli_volts=True)

Takes a socket connection to Quattrocento, the number of channels, the number of bytes per sample, and a boolean flag that specifies whether the output should be in millivolts. It reads the raw signal data from Quattrocento using the read_raw_bytes method and converts the raw data into integer values using the bytes_to_integers method. It then returns the list of channel values as integers.

write_to_csv.py

Takes 1 command-line argument: filename without .csv extension.

This script records a specified number of biological signal samples from Quattrocento and saves the data to a CSV file for further analysis.

Modifiable parameters:

  1. output_milli_volts: A boolean flag passed to the read_emg_signal method that specifies whether to convert the channel values to millivolts (output_milli_volts=True) or leave them as raw integer values (output_milli_volts=False).
  2. file_name: The name of the CSV file that the script writes data to. This is specified by the first command-line argument when the script is run.
  3. number_of_samples: The number of biological signal samples to record. This is specified by the for loop that iterates over a range of number_of_samples and records a sample on each iteration. Set to 20000 by default.

Authors

  • Peter Chudinov [Dept. of Biology, San Francisco State University]

  • Xiaorong Zhang [Dept. of Computer Engineering, San Francisco State University]

Acknowledgements

  • Zhuwei Qin [Dept. of Computer Engineering, San Francisco State University]

  • Yuriah Lydon [Dept. of Computer Engineering, San Francisco State University]

  • Enrico Merlo [OT Bioelettronica]

Citation

If you use this software, please cite it as below:

authors:
  - name: Peter Chudinov
  - name: Xiaorong Zhang
title: quattrocento-python
version: 1.0.0
doi: 10.5281/zenodo.7869982

License

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2023 Peter Chudinov, Xiaorong Zhang, ICE Lab at San Francisco
   State University

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.