pyfim.Collection

class pyfim.Collection

Collection of experiments. This allows you to easily collect and plot data from multi experiments.

Examples

>>> # Initialise two experiments from CSVs in a folder
>>> exp1 = pyfim.Experiment( 'users/data/genotype1' )
>>> exp2 = pyfim.Experiment( 'users/data/genotype2' )
>>> # Initialise collection and add data
>>> c = pyfim.Collection()
>>> c.add_data( exp1, 'Genotype I')
>>> c.add_data( exp2, 'Genotype II')
>>> # Get a summary
>>> c
... <class 'pyfim.core.Collection'> with 2 experiments:
...    name         n_objects  n_frames
... 0  Genotype I          47      1800
... 1  Genotype II         46      1800
... Available parameters: mom_y, perimeter, peristalsis_frequency,
... radius_3, pause_turns, spinepoint_2_x, acc_dst, ...
>>> # Access data
>>> c.peristalsis_frequency
>>> # Plot as boxplot
>>> ax = c.peristalsis_frequency.plot(kind='box')
>>> plt.show()

__init__()

Methods

__init__()
add_data(x[, label, keep_raw])	Add data (e.g.
extract_data()	Get the mean over all parameters.
plot([param])	Plots a set of parameters from this pyFIM Collection.
summary()	Gives a summary of the data in this analysis.