load_mojito§

typed_lisa_toolkit.load_mojito(file_path, time_interval=(None, None), *, relative_time=True)[source]§

Load the Mojito data.

The downloading and cache management of Mojito is handled by mojito. Especially, we recommend using mojito API to feed the file path to this loader. If requested data is missing on the machine, mojito will automatically download it from the server and cache it locally. See this page for more details.

Parameters:

  • file_path (str | pathlib.Path | Sequence[str | pathlib.Path]) – The file path(s) to the Mojito data file(s). If a sequence of file paths is provided, they are combined in a meaningful way (see this section for more details).

  • time_interval (tuple[float|None, float|None], optional) –

    A tuple specifying the start and end time (in seconds) of the data segment to load.

    If the start time is None, it defaults to the start of the data. If the end time is None, it defaults to the end of the data. If both are None, or if time_interval is not provided, the entire data will be loaded.

    We recommend using year2second(), month2second(), etc. to convert time units to seconds.

  • relative_time (bool, optional) – Whether the time in the returned data is relative to the start of the data. Default is True. If False, the time will be absolute, i.e., directly corresponding to the time in the Mojito data file.

Returns:

The loaded data segment, formatted as a TSData object.

There are four channels in the returned data: “X”, “Y”, “Z”, and “flag”, where “X”, “Y”, and “Z” are the TDI observables in Doppler units, and “flag” is the quality flag of the TDI observables.

The shape of the kernel is (1, 4, 1, 1, len(times)).

Return type:

TSData

Example

>>> import mojito.download
>>> import typed_lisa_tools as tlt
>>>
>>> combined = tlt.load_mojito(mojito.download.download-brick("combined"))