CADETProcess.dynamicEvents.TimeLine

Contents

CADETProcess.dynamicEvents.TimeLine#

class CADETProcess.dynamicEvents.TimeLine[source]#

Class representing a timeline of time-varying data.

The timeline is made up of Sections, which are continuous time intervals. Each Section represents a piecewise polynomial function that defines the variation of a given parameter over time.

Attributes:
sectionsList[Section]

list: Sections of the TimeLine.

Methods

add_section(section)

Add a Section to the timeline.

coefficients(time)

Return coefficient of polynomial at given time.

from_constant(start, end, value)

Create a timeline with a constant value for a given time range.

from_profile(time, profile[, s])

Create a timeline from a profile.

integral([start, end])

Calculate integral of sections in interval [start, end].

offset(offset)

Shift the timeline by an offset.

plot([x_axis_in_minutes, ax, ...])

Plot the state of the timeline over time.

section_index(time)

Return the index of the section that contains the specified time.

slice([start, end, offset])

Slice the timeline from a profile.

update_piecewise_poly()

Update the piecewise polynomial representation of the timeline.

value(time)

np.ndarray: Value of parameter at given time.