Skip to content

poreflow.EventDataFrame

Bases: BaseDataFrame

Data frame storing events in a nanopore read

Data frame must contain the following columns: - i (floats): The current of an event "sfreq", "name", "bdc", "bamp", "bfreq", "ios", "channel", "start_idx",

Attributes:

Name Type Description
sfreq float

The sampling frequency

name str

The name of the event

bdc float

The bias voltage DC value in mV

bamp float

The bias voltage amplitude value in mV. 0 for constant-voltage measurements

bfreq float

The bias voltage frequency in Hz. 0 for constant-voltage measurements

ios float

The local open-state current around the event.

channel int

The channel number in which the event occurs.

start_idx int

The start index in the measurement in which the event occurs.

start_time property

The time at which the event started

get_t(absolute=False, n=None)

Get time array

Parameters:

Name Type Description Default
absolute bool

Whether to return absolute time (start from start time). Defaults to False.

False
n int

Number of time points to return. Defaults to None, in which case an number of time points is equal to the current data is returned

None

Returns:

load(path) classmethod

Load data from an HDF5 file.

Parameters:

Name Type Description Default
path str or Path

Path to load the file from.

required

Returns:

Name Type Description
BaseData

The loaded data.

reset_indices()

Resets indices of data

save(path)

Save data to an HDF5 file.

Parameters:

Name Type Description Default
path str or Path

Path to save the file to.

required