piel.analysis.signals.time.core.off_state

piel.analysis.signals.time.core.off_state#

Functions#

create_off_state_generator(→ Callable[[float, ...)

Creates a generator function for the equivalent off state signal with noise.

extract_off_state_generator_from_off_state_section(...)

Extracts parameters from an existing off state DataTimeSignalData and creates a generator function.

extract_off_state_generator_from_full_state_data(...)

Extracts parameters from an existing off state DataTimeSignalData and creates a generator function.

extract_off_state_section(→ piel.types.TimeSignalData)

Extracts the off state segments from a DataTimeSignalData instance containing multiple on and off states.

Module Contents#

create_off_state_generator(noise_std: float = 0.01, sampling_rate: float = 1000.0, baseline: float = 0.0, data_name: str = 'off_state', data_time_signal_kwargs: Dict | None = None) → Callable[[float, int | None], piel.types.TimeSignalData][source]#

Creates a generator function for the equivalent off state signal with noise.

Parameters:

  • noise_std (float) – Standard deviation of the Gaussian noise.

  • sampling_rate (float) – Sampling rate in Hz.

  • baseline (float) – Baseline signal level for the off state.

  • data_name (str) – Name of the data signal.

  • data_time_signal_kwargs (dict, optional) – Additional keyword arguments for TimeSignalData.

Returns:

A function that takes duration_s (in seconds) and returns TimeSignalData.

Return type:

Callable[[float, Optional[int]], TimeSignalData]

extract_off_state_generator_from_off_state_section(off_state_data: piel.types.TimeSignalData, data_name: str | None = None, data_time_signal_kwargs: Dict | None = None) → Callable[[float], piel.types.TimeSignalData][source]#

Extracts parameters from an existing off state DataTimeSignalData and creates a generator function.

Parameters:

  • off_state_data (TimeSignalData) – The existing off state signal data.

  • data_name (str, optional) – Name for the new data signal. Defaults to the original data_name.

  • data_time_signal_kwargs (dict, optional) – Additional keyword arguments for DataTimeSignalData.

Returns:

A generator function configured with extracted parameters.

Return type:

Callable[[float], DataTimeSignalData]

extract_off_state_generator_from_full_state_data(full_time_signal_data: piel.types.TimeSignalData, baseline: float | None = None, threshold: float | None = None, min_duration_s: float | None = None, sampling_rate: float | None = None, data_name: str | None = None, data_time_signal_kwargs: Dict | None = None) → Callable[[float, int | None], piel.types.TimeSignalData][source]#

Extracts parameters from an existing off state DataTimeSignalData and creates a generator function.

Parameters:

  • full_time_signal_data (TimeSignalData) – The input signal data containing multiple states.

  • baseline (float, optional) – The baseline value representing the off state. If not provided, it is computed as the mean of the data.

  • threshold (float, optional) – The maximum deviation from the baseline to consider as off state. If not provided, it is computed as 2 * standard deviation of the data.

  • min_duration_s (float, optional) – The minimum duration_s (in seconds) for a segment to be considered. Segments shorter than this duration_s will be ignored.

  • sampling_rate (float, optional) – The sampling rate in Hz. If not provided, it is calculated from time_s.

  • data_time_signal_kwargs (dict, optional) – Additional keyword arguments for DataTimeSignalData.

  • data_name (str, optional) – Name for the new data signal. Defaults to the original data_name.

  • data_time_signal_kwargs – Additional keyword arguments for DataTimeSignalData.

Returns:

A generator function configured with extracted parameters.

Return type:

Callable[[float], DataTimeSignalData]

extract_off_state_section(full_time_signal_data: piel.types.TimeSignalData, baseline: float | None = None, threshold: float | None = None, min_duration_s: float | None = None, sampling_rate: float | None = None, data_time_signal_kwargs: Dict | None = None) → piel.types.TimeSignalData[source]#

Extracts the off state segments from a DataTimeSignalData instance containing multiple on and off states.

Parameters:

  • full_time_signal_data (TimeSignalData) – The input signal data containing multiple states.

  • baseline (float, optional) – The baseline value representing the off state. If not provided, it is computed as the mean of the data.

  • threshold (float, optional) – The maximum deviation from the baseline to consider as off state. If not provided, it is computed as 2 * standard deviation of the data.

  • min_duration_s (float, optional) – The minimum duration_s (in seconds) for a segment to be considered. Segments shorter than this duration_s will be ignored.

  • sampling_rate (float, optional) – The sampling rate in Hz. If not provided, it is calculated from time_s.

  • data_time_signal_kwargs (dict, optional) – Additional keyword arguments for DataTimeSignalData.

Returns:

A new DataTimeSignalData instance containing only the off state segments.

Return type:

TimeSignalData

Contents