agora.io.signal.Signal

class agora.io.signal.Signal(file: Union[str, PosixPath])

Bases: BridgeH5

Class that fetches data from the hdf5 storage for post-processing

Attributes

cell_tree

datasets

merges

n_merges

ntimepoints

p_siglist

Print signal list

picks

siglist

Return list of signals

tinterval

Methods

apply_prepost(dataset[, skip_pick])	Apply modifier operations (picker, merger) to a given dataframe.
get_info_tree([fields])	Returns traps, time points and labels for this position in form of a tree in the hierarchy determined by the argument fields.
get_picks(names[, path])
join_tracks_pair(target, source)	Join two tracks

add_name
apply_merge
close
cols_in_mins
dataset_to_df
dset_to_df
get_consecutives
get_merged
get_merges
get_npairs
get_npairs_over_time
get_raw
get_retained
get_siglist
retained

__init__(file: Union[str, PosixPath])

Methods

__init__(file)
add_name(df, name)
apply_merge(df, changes)
apply_prepost(dataset[, skip_pick])	Apply modifier operations (picker, merger) to a given dataframe.
close()
cols_in_mins(df)
dataset_to_df(f, path)
dset_to_df(f, dataset)
get_consecutives(tree, nstepsback)
get_info_tree([fields])	Returns traps, time points and labels for this position in form of a tree in the hierarchy determined by the argument fields.
get_merged(dataset)
get_merges()
get_npairs([nstepsback, tree])
get_npairs_over_time([nstepsback])
get_picks(names[, path])
get_raw(dataset[, in_minutes])
get_retained(df, cutoff)
get_siglist(name, node)
join_tracks_pair(target, source)	Join two tracks
retained(signal[, cutoff])

Attributes

cell_tree
datasets
merges
n_merges
ntimepoints
p_siglist	Print signal list
picks
siglist	Return list of signals
tinterval

apply_prepost(dataset: str, skip_pick: Optional[bool] = None)

Apply modifier operations (picker, merger) to a given dataframe.

get_info_tree(fields: Union[tuple, list] = ('trap', 'timepoint', 'cell_label'))

Returns traps, time points and labels for this position in form of a tree in the hierarchy determined by the argument fields. Note that it is compressed to non-empty elements and timepoints.

Default hierarchy is: - trap

• time point

• cell label

This function currently produces trees of depth 3, but it can easily be extended for deeper trees if needed (e.g. considering groups, chambers and/or positions).

input :fields: Fields to fetch from ‘cell_info’ inside the hdf5 storage

returns :tree: Nested dictionary where keys (or branches) are the upper levels

and the leaves are the last element of :fields:.

static join_tracks_pair(target: Series, source: Series)

Join two tracks

property p_siglist

Print signal list

property siglist

Return list of signals