Mondaic
This API reference is not for the latest stable Salvus version.

salvus.flow.collections.types

Types for the SalvusFlow collection objects.

Classes

TimeAxis

class TimeAxis(builtins.object):
    def __init__(
        self,
        start_time: float,
        reference_time: float,
        number_of_samples: int,
        dt: float,
    ) -> None:
        ...

A time axis representation.

Parameters
  • start_time float — The start time in seconds.
  • reference_time float — The reference time in seconds, e.g. what time zero refers to.
  • number_of_samples int — The number of samples.
  • dt float — The sampling inverval in seconds.
Attributes
end_time float

The end time in seconds.

sampling_rate float

The sampling rate in Hz.

Methods
from_start_end_dt()
def from_start_end_dt(
    start_time: float, end_time: float, dt: float, reference_time: float
) -> TimeAxis:
    ...

Construct a time axis object from the start and end time as well as the sampling interval.

Parameters
  • start_time float — The start time in seconds.
  • end_time float — The end time in seconds.
  • dt float — The sampling inverval in seconds.
  • reference_time float — The reference time.
Returns TimeAxis