py-neuromodulation 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

packages/tmsi/build/lib/TMSiSDK/error.py

@@ -1,95 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file ${error.py} 
- * @brief General SDK errors
- *
- */
-
-
-"""
-from enum import Enum, unique
-
-
-@unique
-class TMSiErrorCode(Enum):
-    general_error = 0
-    missing_dll = 1
-    already_in_use_dll = 2
-    device_error = 100
-    device_not_connected = 101
-    no_devices_found = 102
-    api_no_driver = 200
-    api_incorrect_argument = 201
-    api_invalid_command = 202
-    file_writer_error = 300
-
-
-class TMSiError(Exception):
-    def __init__(self, code):
-        self.code = code
-
-    def __str__(self):
-        return repr(self.code)
-
-
-def DeviceErrorLookupTable(code):
-    _lookup_table = {
-        "0x1010001": "DR reported 'Checksum error in received block'",
-        "0x2010001": "DS reported 'Checksum error in received block'",
-        "0x1010002": "DR reported 'Unknown command'",
-        "0x2010002": "DS reported 'Unknown command'",
-        "0x1010003": "DR reported 'Response timeout'",
-        "0x2010003": "DS reported 'Response timeout'",
-        "0x1010004": "DR reported 'Device busy try again in x msec'",
-        "0x2010004": "DS reported 'Device busy try again in x msec'",
-        "0x1010005": "DR reported 'Command not supported over current interface'",
-        "0x2010005": "DS reported 'Command not supported over current interface'",
-        "0x1010006": "DR reported 'Command not possible, device is recording'",
-        "0x1010007": "DR reported 'Device not available'",
-        "0x2010007": "DS reported 'Device not available'",
-        "0x2010008": "DS reported 'Interface not available'",
-        "0x2010009": "DS reported 'Command not allowed in current mode'",
-        "0x201000A": "DS reported 'Processing error'",
-        "0x201000B": "DS reported 'Unknown internal error'",
-        "0x1030001": "DR reported 'Command not supported by Channel'",
-        "0x1030002": "DR reported 'Illegal start control for ambulant recording",
-        "0x201000C": "DS reports that data request does not fit with one Device Api Packet",
-        "0x201000D": "DS reports that DR is already opened",
-        "0x3001000": "DLL Function is declared, but not yet implemented",
-        "0x3001001": "DLL Function called with invalid parameters",
-        "0x3001002": "Incorrect checksum of response message",
-        "0x3001003": "DLL Function failed because of header failure",
-        "0x3001004": "DLL Function failed because an underlying process failed",
-        "0x3001005": "DLL Function called with a too small buffer",
-        "0x3001006": "DLL Function called with a Handle that's not assigned to a device",
-        "0x3002000": "DLL Function failed becasue could not open selected interface",
-        "0x3002001": "DLL Function failed because could not close selected interface",
-        "0x3002002": "DLL Function failed because could not send command-data",
-        "0x3002003": "DLL Function failed because could not receive data",
-        "0x3002004": "DLL Function failed because commination timed out",
-        "0x3002005": "Lost connection to DS, USB / Ethernet disconnect",
-    }
-
-    print("\n " + _lookup_table[code] + "\n")

packages/tmsi/build/lib/TMSiSDK/sample_data.py

@@ -1,63 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file ${sample_data.py} 
- * @brief Sample data class definitions.
- *
- */
-
-
-"""
-
-
-class SampleSet:
-    """<SampleSet> represents a set of samples taken by the device from all
-                active channels at the same event. It has the next properties:
-
-    num_samples: <int> The number of samples within the sample-set.
-
-    samples: <float[]> Array of samples, in order of the active channels in
-             the active channel list <Device.channels[]>
-    """
-
-    def __init__(self, num_samples, samples):
-        self.num_samples = num_samples
-        self.samples = samples
-
-
-class SampleData:
-    """<SampleData> represents an array of received samples. It has the next properties:
-
-    num_sample_sets: <int> The number of sample-sets within the
-                    samples-array
-
-    num_samples_per_sample_set: <int> The number of samples within one sample-set.
-
-    samples: <float[]> Array of samples, sequentially in sample-sets and sampling-event.
-    """
-
-    def __init__(self, num_sample_sets, num_samples_per_sample_set, samples):
-        self.num_sample_sets = num_sample_sets
-        self.num_samples_per_sample_set = num_samples_per_sample_set
-        self.samples = samples

packages/tmsi/build/lib/TMSiSDK/sample_data_server.py

@@ -1,99 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file ${sample_data_server.py} 
- * @brief Sample Data Server module
- *
- */
-
-
-"""
-
-from TMSiSDK import settings
-from copy import copy
-
-
-class SampleDataConsumer:
-    """Local class which identifies which consumer registered for what device"""
-
-    def __init__(self, id, q):
-        self.id = id
-        self.q = q
-
-
-def registerConsumer(id, q):
-    """Registers a consumer-queue to receive the sample-data of a specific
-    device.
-    This method is called by sample-data-consumers.
-
-    Args:
-        id: <int> : Unique id of a device <Device.id>.
-            Indicates from which specific device, received sample-data
-            must be put into the registered <queue>
-
-        q: <queue> The queue into which received sample-data will be put.
-    """
-    settings._consumer_list.append(SampleDataConsumer(id, q))
-
-
-def unregisterConsumer(id, q):
-    """Unregisters a consumer-queue associated with a file-writer or plotter
-    object.
-    This method is called by close-methods of the sample-data-consumers.
-
-    Args:
-        id: <int> : Unique id of a device <Device.id>.
-            Indicates from which specific device, received sample-data
-            must be put into the registered <queue>
-
-        q: <queue> The queue object which has to be removed from the global
-            consumer list.
-    """
-    num_consumers = len(settings._consumer_list)
-    for i in range(num_consumers):
-        if settings._consumer_list[i].id == id:
-            if settings._consumer_list[i].q == q:
-                idx_remove = copy(i)
-    # try:
-    #     settings._consumer_list[idx_remove].q.close()
-    # except AttributeError:
-    #     pass
-    settings._consumer_list.pop(idx_remove)
-
-
-def putSampleData(id, data):
-    """Puts a <SampleData>-object, coming from device <Device.id> into the queues
-    of registered consumers.
-    This method is called by sample-data-producers.
-
-    Args:
-        id: <int> : Unique id of the device (<Device>.id), which forwards
-            received sample-data to the sample-data-server.
-
-        data <SampleData> The sample-data.
-    """
-    num_consumers = len(settings._consumer_list)
-    for i in range(num_consumers):
-        if settings._consumer_list[i].id == id:
-            settings._consumer_list[i].q.put(data)

packages/tmsi/build/lib/TMSiSDK/settings.py

@@ -1,45 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file ${settings.py} 
- * @brief Module for SDK 'locally' used settings
- *
- */
-
-
-"""
-
-
-def _initialize():
-    """
-    Instantiates and initializes 'local' static variables fro SDK-modules.
-    This method must be called once befor start using the SDK.
-
-    Returns
-    -------
-    None.
-
-    """
-    global _consumer_list  # used in <sample_data_server.py> : list of registered
-    _consumer_list = []  # consumer for receipt of sample-data

packages/tmsi/build/lib/TMSiSDK/tmsi_device.py

@@ -1,111 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file ${tmsi_device.py} 
- * @brief Starting module to instantiate <Device>-objects of TMSi measurement 
- * systems.
- *
- */
-
-
-"""
-
-from enum import Enum
-
-from TMSiSDK.error import TMSiError, TMSiErrorCode
-from TMSiSDK.device import DeviceInterfaceType
-from TMSiSDK.devices.saga import saga_device
-from TMSiSDK.devices.saga.saga_device import SagaDevice
-
-from TMSiSDK import settings
-
-
-class DeviceType(Enum):
-    none = 0
-    saga = 1
-
-
-def initialize():
-    """Initializes the TMSi-SDK environment.
-    This must be done once before starting using the SDK.
-    """
-    settings._initialize()
-
-
-def create(dev_type, dr_interface, ds_interface=DeviceInterfaceType.none):
-    """Creates a Device-object to interface with a TMSI measurement system.
-
-    Args:
-        dev_type : <DeviceType> The measurement-system type.
-                   Momentarily only the SAGA system is supported.
-
-        dr_interface : <DeviceInterfaceType> The interface-type between the
-                       data-recorder and docking-station (if the system exists
-                       out of a DS and DR like the SAGA-system) or a PC.
-                       The default interface-type = DeviceInterfaceType.docked
-
-        ds_interface : <DeviceInterfaceType> The interface-type between the
-                       docking station and PC.
-                       The default interface-type = DeviceInterfaceType.usb
-
-    Returns:
-        <Device> An object of the system-implementation of the <Device-class>-interface.
-        With this object one can interface with the attached system.
-    """
-    dev = None
-    if dev_type == DeviceType.saga:
-        dev = SagaDevice(ds_interface, dr_interface)
-    else:
-        raise TMSiError(TMSiErrorCode.api_incorrect_argument)
-
-    return dev
-
-
-def discover(dev_type, dr_interface, ds_interface=DeviceInterfaceType.none):
-    """Creates a list with Device-objects to interface with found TMSI measurement systems.
-
-    Args:
-        dev_type : <DeviceType> The measurement-system type.
-                   Momentarily only the SAGA system is supported.
-
-        dr_interface : <DeviceInterfaceType> The interface-type between the
-                       data-recorder and docking-station (if the system exists
-                       out of a DS and DR like the SAGA-system) or a PC.
-                       The default interface-type = DeviceInterfaceType.docked
-
-        ds_interface : <DeviceInterfaceType> The interface-type between the
-                       docking station and PC.
-                       The default interface-type = DeviceInterfaceType.usb
-
-    Returns:
-        <Device[]> An array with objects of the system-implementation of the
-        <Device-class>-interface. With these object one can interface with the
-        attached systems.
-    """
-    discoveryList = []
-
-    if dev_type == DeviceType.saga:
-        discoveryList = saga_device.discover(ds_interface, dr_interface)
-
-    return discoveryList

packages/tmsi/build/lib/__init__.py

@@ -1,4 +0,0 @@
-"""tmsi is a package derived from TMSi's python interface."""
-from . import TMSiFileFormats
-from . import TMSiPlotters
-from . import TMSiSDK

packages/tmsi/build/lib/apex_sdk/__init__.py

@@ -1,34 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file __init__.py 
- * @brief 
- * Initialization of the SDK.
- */
-
-
-"""
-
-from .tmsi_utilities.tmsi_logger import TMSiLogger
-from .tmsi_utilities.decorators import LogPerformances

packages/tmsi/build/lib/apex_sdk/device/__init__.py

@@ -1,41 +0,0 @@
-"""
-(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
-
-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.
-
-#######  #     #   #####   #
-   #     ##   ##  #        
-   #     # # # #  #        #
-   #     #  #  #   #####   #
-   #     #     #        #  #
-   #     #     #        #  #
-   #     #     #  #####    #
-
-/**
- * @file __init__.py 
- * @brief 
- * Initialization of the device.
- */
-
-
-"""
-
-from .devices.apex import apex_API_enums as ApexEnums
-from .devices.apex import apex_API_structures as ApexStructures
-from .devices.apex.apex_structures.apex_channel import ApexChannel, ChannelType
-from .devices.apex.apex_structures.apex_impedance_channel import (
-    ApexImpedanceChannel,
-)
-from ..tmsi_utilities.apex.apex_structure_generator import (
-    ApexStructureGenerator,
-)