bluepysnap.frame_report¶
Frame report access.
Classes
|
Access to a CompartmentsReport data. |
|
Access to filtered FrameReport data. |
|
Access to FrameReport data. |
|
Access to PopulationCompartmentsReport data. |
|
Access to PopulationFrameReport data. |
|
Access to PopulationSomaReport data. |
|
Access to a SomaReport data. |
- class bluepysnap.frame_report.CompartmentReport(simulation, report_name)¶
Access to a CompartmentsReport data.
Initializes a FrameReport object from a simulation object.
- Parameters:
simulation (Simulation) – Simulation containing this frame report.
report_name (str) – The name of this frame report.
- Returns:
A FrameReport object.
- Return type:
- class bluepysnap.frame_report.FilteredFrameReport(frame_report, group=None, t_start=None, t_stop=None)¶
Access to filtered FrameReport data.
Initialize a FilteredFrameReport.
A FilteredFrameReport is a lazy and cached object which contains the filtered data from all the populations of a report.
- Parameters:
frame_report (FrameReport) – The FrameReport to filter.
group (None/int/list/np.array/dict) – Get frames filtered by Group Concept.
t_start (float) – Include only frames occurring at or after this time.
t_stop (float) – Include only frames occurring at or before this time.
- Returns:
A FilteredFrameReport object.
- Return type:
- report¶
Access to the report data.
- Returns:
A DataFrame containing the data from the report. Row’s indices are the different timestamps and the column’s MultiIndex are:
(population_name, node_id, compartment id) for the CompartmentReport
(population_name, node_id) for the SomaReport
- Return type:
pandas.DataFrame
- trace(plot_type='mean', ax=None)¶
Returns a plot displaying the voltage of a node or a compartment as a function of time.
- Parameters:
plot_type (str) – string either all or mean. all will plot the first 15 traces from the group. mean will plot the mean value of the node
ax – A plot axis object that will be updated
- Returns:
axis containing the soma’s traces.
- Return type:
matplotlib.Axis
- class bluepysnap.frame_report.FrameReport(simulation, report_name)¶
Access to FrameReport data.
Initializes a FrameReport object from a simulation object.
- Parameters:
simulation (Simulation) – Simulation containing this frame report.
report_name (str) – The name of this frame report.
- Returns:
A FrameReport object.
- Return type:
- property config¶
Access the report config.
- data_units¶
Returns the data unit for this report.
- property dt¶
Returns the frequency of reporting in milliseconds.
- filter(group=None, t_start=None, t_stop=None)¶
Returns a FilteredFrameReport.
A FilteredFrameReport is a lazy and cached object which contains the filtered data from all the populations of a report.
- Parameters:
group (None/int/list/np.array/dict) – Get frames filtered by Group Concept.
t_start (float) – Include only frames occurring at or after this time.
t_stop (float) – Include only frames occurring at or before this time.
- Returns:
A FilteredFrameReport object.
- Return type:
- property node_set¶
Returns the name of the node set for the report.
- population_names¶
Returns the population names included in this report.
- property simulation¶
Return the Simulation object related to this frame report.
- property time_start¶
Returns the starting time of the report.
- property time_stop¶
Returns the stopping time of the report.
- property time_units¶
Returns the data unit for this report.
- property to_libsonata¶
Access libsonata instance of the report.
- class bluepysnap.frame_report.PopulationCompartmentReport(frame_report, population_name)¶
Access to PopulationCompartmentsReport data.
Initializes a PopulationFrameReport object from a FrameReport.
- Parameters:
frame_report (FrameReport) – FrameReport containing this frame report population.
population_name (str) – the population name corresponding to this report.
- Returns:
A PopulationFrameReport object.
- Return type:
- nodes¶
Returns the NodePopulation corresponding to this report.
- class bluepysnap.frame_report.PopulationFrameReport(frame_report, population_name)¶
Access to PopulationFrameReport data.
Initializes a PopulationFrameReport object from a FrameReport.
- Parameters:
frame_report (FrameReport) – FrameReport containing this frame report population.
population_name (str) – the population name corresponding to this report.
- Returns:
A PopulationFrameReport object.
- Return type:
- get(group=None, t_start=None, t_stop=None, t_step=None)¶
Fetch data from the report.
- Parameters:
group (None/int/list/np.array/dict) – Get frames filtered by Group Concept.
t_start (float) – Include only frames occurring at or after this time.
t_stop (float) – Include only frames occurring at or before this time.
t_step (float) – Optional time step, useful to reduce the number of samples. It should be a multiple of the report time step dt, and it’s equal to dt by default. If the given t_step isn’t an exact multiple, it’s rounded to the closer multiple. Only the samples at t = t0 + k * t_step, for k = 0, 1… are returned, where t0 is the first sample time >= t_start.
- Returns:
frame as columns indexed by timestamps.
- Return type:
pandas.DataFrame
- property name¶
Access to the population name.
- node_ids¶
Returns the node ids present in the report.
- Returns:
Numpy array containing the node_ids included in the report
- Return type:
np.Array
- class bluepysnap.frame_report.PopulationSomaReport(frame_report, population_name)¶
Access to PopulationSomaReport data.
Initializes a PopulationFrameReport object from a FrameReport.
- Parameters:
frame_report (FrameReport) – FrameReport containing this frame report population.
population_name (str) – the population name corresponding to this report.
- Returns:
A PopulationFrameReport object.
- Return type:
- class bluepysnap.frame_report.SomaReport(simulation, report_name)¶
Access to a SomaReport data.
Initializes a FrameReport object from a simulation object.
- Parameters:
simulation (Simulation) – Simulation containing this frame report.
report_name (str) – The name of this frame report.
- Returns:
A FrameReport object.
- Return type: