Source code for biomechzoo.processing.addchannel_data

from typing import Dict
import numpy as np
from numpy.typing import ArrayLike
from biomechzoo.utils.update_channel_list import update_channel_list




def addchannel_data(data: Dict, ch_new_name: str, ch_new_data: ArrayLike, section: str = 'Video') -> Dict:
    """
    Add a new channel to zoo data.

    Parameters
    ----------
    data : dict
        Zoo file data dictionary.
    ch_new_name : str
        Name of the new channel.
    ch_new_data : array_like
        New data to be added to the channel (should be n x 1 or n x 3).
    section : {'Video', 'Analog'}, optional
        Section of zoo data. Default is 'Video'.

    Returns
    -------
    dict
        Updated zoo data with new channel added.

    Notes
    -----
    If the channel already exists, it will be overwritten.
    
    Adds channel name to the list in data['zoosystem'][section]['Channels'].
    """

    # Warn if overwriting
    if ch_new_name in data:
        print('Warning: channel {} already exists, overwriting...'.format(ch_new_name))

    # Assign channel data
    data[ch_new_name] = {
        'line': ch_new_data,
        'event': {}
    }

    # Update channel list
    data = update_channel_list(data, section=section, ch_add=ch_new_name)

    return data



if __name__ == '__main__':
    # -------TESTING FOR DEVELOPERS--------
    import os
    from biomechzoo.utils.zload import zload
    from biomechzoo.utils.zplot import zplot

    # get path to sample zoo file
    current_dir = os.path.dirname(os.path.abspath(__file__))
    project_root = os.path.dirname(os.path.dirname(os.path.dirname(current_dir)))
    fl = os.path.join(project_root, 'data', 'other', 'HC030A05.zoo')

    # load  zoo file
    data = zload(fl)
    r = data['RKneeAngles']['line']*3
    data= addchannel_data(data, ch_new_name='blah', ch_new_data=r)
    zplot(data, 'blah')