class TMSiSDK.device.tmsi_channel.TMSiChannel

Bases: object

Class to handle the interface of TMSi channel.

__init__()

Initialize the TMSi channel.

Methods

__init__()	Initialize the TMSi channel.
get_channel_bandwidth()	Get channel bandwidth
get_channel_divider()	Get channel divider.
get_channel_exp()	Get channel exponential.
get_channel_format()	Get channel format.
get_channel_imp_divider()	Get channel impedance divider.
get_channel_index()	Get channel index.
get_channel_name()	Get channel name.
get_channel_sampling_frequency()	Get channel sampling frequency
get_channel_type()	Get channel type.
get_channel_unit_name()	Get the name of the unit of measurement of the channel.
is_reference()	Get if the channel is a reference channel.
set_channel_divider(base_sample_rate[, divider])	Set channel divider
set_channel_index(index)	Set channel index
set_channel_information()	Set the information of the channel.
set_channel_name([default_channel_name, ...])	Set the names of the channel
set_reference(is_reference)	Set the channel to reference.

get_channel_bandwidth()

Get channel bandwidth

Returns:

bandwidth of the channel

Return type:

int

get_channel_divider()

Get channel divider.

Returns:

the divider of the channel over base sample rate.

Return type:

int

get_channel_exp()

Get channel exponential.

Returns:

the exponential in base 10 of the channel.

Return type:

int

get_channel_format()

Get channel format.

Returns:

format of the channel.

Return type:

int

get_channel_imp_divider()

Get channel impedance divider.

Returns:

the impedance divider of the channel over base sample rate.

Return type:

int

get_channel_index()

Get channel index.

Returns:

the index of the channel.

Return type:

int

get_channel_name()

Get channel name.

Returns:

name of the channel.

Return type:

str

get_channel_sampling_frequency()

Get channel sampling frequency

Returns:

sampling frequency for the channel

Return type:

int

get_channel_type()

Get channel type.

Returns:

channel type.

Return type:

ChannelType

get_channel_unit_name()

Get the name of the unit of measurement of the channel.

Returns:

unit of measurement.

Return type:

str

is_reference()

Get if the channel is a reference channel.

Returns:

1 if it is reference, 0 if it is not reference.

Return type:

int

set_channel_divider(base_sample_rate, divider=-1)

Set channel divider

Parameters:

• base_sample_rate (int) – base sample rate of the device

• divider (int, optional) – divider of the base sample rate, defaults to -1

set_channel_index(index)

Set channel index

Parameters:

index (int) – index of the channel

set_channel_information()

Set the information of the channel.

Raises:

NotImplementedError – Must be overridden by the child class.

set_channel_name(default_channel_name=None, alternative_channel_name=None)

Set the names of the channel

Parameters:

• default_channel_name (str, optional) – default name, defaults to None

• alternative_channel_name (str, optional) – alternative name, defaults to None

set_reference(is_reference)

Set the channel to reference.

Parameters:

is_reference (int) – 1 if it is reference, 0 if it is not.