Skip to content

sim_range module

Mixin class for working with simulation ranges.

SimRangeMixin class

SimRangeMixin(
    sim_start=None,
    sim_end=None
)

Mixin class for working with simulation ranges.

Should be subclassed by a subclass of Wrapping.

Subclasses

column_stack_sim_end class method

SimRangeMixin.column_stack_sim_end(
    new_wrapper,
    *objs
)

Column-stack simulation end.

column_stack_sim_start class method

SimRangeMixin.column_stack_sim_start(
    new_wrapper,
    *objs
)

Column-stack simulation start.

fit_fig_to_sim_range class method

SimRangeMixin.fit_fig_to_sim_range(
    fig,
    column=None,
    sim_start=None,
    sim_end=None,
    wrapper=None,
    group_by=None,
    xref=None
)

Fit figure to simulation range.

get_sim_duration class method

SimRangeMixin.get_sim_duration(
    sim_start=None,
    sim_end=None,
    wrapper=None,
    group_by=None,
    wrap_kwargs=None
)

Get duration of simulation range.

get_sim_end class method

SimRangeMixin.get_sim_end(
    sim_end=None,
    keep_flex=False,
    allow_none=False,
    wrapper=None,
    group_by=None,
    wrap_kwargs=None
)

Get simulation end.

get_sim_end_index class method

SimRangeMixin.get_sim_end_index(
    sim_end=None,
    allow_none=False,
    inclusive=True,
    wrapper=None,
    group_by=None,
    wrap_kwargs=None
)

Get index of simulation end.

get_sim_start class method

SimRangeMixin.get_sim_start(
    sim_start=None,
    keep_flex=False,
    allow_none=False,
    wrapper=None,
    group_by=None,
    wrap_kwargs=None
)

Get simulation start.

get_sim_start_index class method

SimRangeMixin.get_sim_start_index(
    sim_start=None,
    allow_none=False,
    wrapper=None,
    group_by=None,
    wrap_kwargs=None
)

Get index of simulation start.

resample_sim_end method

SimRangeMixin.resample_sim_end(
    new_wrapper
)

Resample simulation end.

resample_sim_start method

SimRangeMixin.resample_sim_start(
    new_wrapper
)

Resample simulation start.

resolve_sim_end class method

SimRangeMixin.resolve_sim_end(
    sim_end=None,
    allow_none=True,
    wrapper=None,
    group_by=None
)

Resolve simulation end.

resolve_sim_end_value class method

SimRangeMixin.resolve_sim_end_value(
    value,
    wrapper=None
)

Resolve a single value of simulation end.

resolve_sim_start class method

SimRangeMixin.resolve_sim_start(
    sim_start=None,
    allow_none=True,
    wrapper=None,
    group_by=None
)

Resolve simulation start.

resolve_sim_start_value class method

SimRangeMixin.resolve_sim_start_value(
    value,
    wrapper=None
)

Resolve a single value of simulation start.

row_stack_sim_end class method

SimRangeMixin.row_stack_sim_end(
    new_wrapper,
    *objs
)

Row-stack simulation end.

row_stack_sim_start class method

SimRangeMixin.row_stack_sim_start(
    new_wrapper,
    *objs
)

Row-stack simulation start.

sim_duration property

SimRangeMixin.get_sim_duration() with default arguments.

sim_end property

SimRangeMixin.get_sim_end() with default arguments.

sim_end_index property

SimRangeMixin.get_sim_end_index() with default arguments.

sim_end_indexing_func method

SimRangeMixin.sim_end_indexing_func(
    wrapper_meta
)

Indexing function for simulation end.

sim_start property

SimRangeMixin.get_sim_start() with default arguments.

sim_start_index property

SimRangeMixin.get_sim_start_index() with default arguments.

sim_start_indexing_func method

SimRangeMixin.sim_start_indexing_func(
    wrapper_meta
)

Indexing function for simulation start.