Skip to content

result.timecourse

Result of a single timecourse simulation.

The simulator answers every TimecourseSim with a TimecourseResult: the array of the selections which roadrunner returns, with a row per time point and a column per selection, and the names of the columns. XResult.from_timecourses places the results of the simulations of a scan into one xarray.Dataset.

It is deliberately not a data frame. A fit simulates its groups on every evaluation of the residuals and a scan simulates every combination of its dimensions, so building a frame per simulation, concatenating the frames and looking their columns up took a third of the time of the residuals and half of the time of a scan; the columns of a TimecourseResult are views into the array roadrunner returned.

TimecourseResult dataclass 

TimecourseResult(columns, values)

Values of the selections of a timecourse simulation.

Attributes:

Name Type Description
columns tuple[str, ...]

names of the columns, i.e., the timecourse selections.
values ndarray

values with a row per time point and a column per selection.

time property 

time

Get the time points, i.e., the column time.

concatenate classmethod 

concatenate(results)

Concatenate the results of consecutive timecourses.

Parameters:

Name Type Description Default
results Sequence[TimecourseResult]

results with the same columns, in the order of their time.

 required

Returns:

Type Description
TimecourseResult

The rows of all results.

Raises:

Type Description
ValueError

if there are no results or their columns differ.