Top-level API§

Top-level API of the project.

Typed LISA Toolkit has a top-level module, typed_lisa_toolkit, with functions for loading data and constructing objects. It also has two submodules:

typed_lisa_toolkit.types for core typed objects.
typed_lisa_toolkit.shop for utility functions acting on those objects (conversions, transforms, etc.). Shop for what you need in this module.

This page focuses on the top-level module.

Loaders§

Functions that load data from disk or memory in common formats.

`load_data`	Load the data from a saved HDF5 file.
`load_sangria`	Load Sangria dataset or Sangria HM dataset.
`load_mojito`	Load the Mojito data.
`load_preprocessed_mojito`	Load the data from a preprocessed Mojito data segment.
`load_ldc_data`	Load the LDC dataset.

Plotting§

Functions for visualizing objects.

`plot`	Plot a single object with customizable visualization options.
`plot_compare`	Plot two objects for comparison, with optional difference view.

Factory Functions§

These are functions that create objects of types in types, but with a nicer API than the class initializer methods. Below, they are grouped by purpose.

Representations§

Representations are the most fundamental types in TLT, and are components of other more involved types.

They house numerical signal arrays, together with time and/or frequency grids and other metadata. They support not only basic algebraic operations as the underlying arrays do, but also some grid-aware operations such as semantic subsetting and embedding.

`frequency_series`	Build an `FrequencySeries` or a `UniformFrequencySeries`.
`time_series`	Build a `TimeSeries` or a `UniformTimeSeries`.
`frequency_phasor`	Build a `FrequencyPhasor`.
`time_phasor`	Build a `TimePhasor`.
`stft`	Build an `ShortTimeFourierTransform`.
`wdm`	Build a `WilsonDaubechiesMeyer`.
`phasor`	Alias for `frequency_phasor()` (Deprecated).

The following functions construct new representations by processing existing representations:

densify_phasor

Densify a sparse phasor representation by interpolation.

Data§

Data objects house multi-channel LISA data, where all channels are of the same representation type suitable for representing recorded data.

`tsdata`	Construct a `TSData`.
`fsdata`	Construct `FSData` or `TimedFSData`.
`stftdata`	Construct `STFTData`.
`wdmdata`	Construct `WDMData`.
`timed_fsdata`	Construct `TimedFSData` (Deprecated).
`construct_tsdata`	Construct a `TSData` (Deprecated).
`construct_fsdata`	Construct an `FSData` (Deprecated).
`construct_stftdata`	Construct an `STFTData` (Deprecated).
`construct_wdmdata`	Construct a `WDMData` (Deprecated).
`construct_timed_fsdata`	Construct a `TimedFSData` (Deprecated).

Waveforms§

Similar to data objects, waveform objects group multiple representations together. Waveform objects are meant to represent modeled signals, and as such, they can carry theoretical information such as harmonic content, which is not the case for data objects.

In the nomenclature of the project, “raw” waveforms are detector-independent strains, such as the two polarizations (\(h_+\) and \(h_\times\)) or the spherical harmonic decomposition (\(h_{lm}\)); “projected” waveforms depend on LISA’s response, and are typically TDI channel signals.

The factory functions are available in long-form and short aliases:

`harmonic_waveform`(...)	Build a `HarmonicWaveform`.
`homogeneous_harmonic_waveform`(...)	Build a `HomogeneousHarmonicWaveform`.
`plus_cross_waveform`(pol_to_reps)	Build a `PlusCrossWaveform`.
`projected_waveform`(channels_to_reps)	Build a `ProjectedWaveform`.
`harmonic_projected_waveform`(...)	Build a `HarmonicProjectedWaveform`.
`homogeneous_harmonic_projected_waveform`(...)	Build a `HomogeneousHarmonicProjectedWaveform`.
`hw`(modes_to_reps)	Alias for `harmonic_waveform()`.
`hhw`(modes_to_reps)	Alias for `homogeneous_harmonic_waveform()`.
`pcw`(pol_to_reps)	Alias for `plus_cross_waveform()`.
`pw`(channels_to_reps)	Alias for `projected_waveform()`.
`hpw`(modes_to_pws)	Alias for `harmonic_projected_waveform()`.
`hhpw`(modes_to_pws)	Alias for `homogeneous_harmonic_projected_waveform()`.

The following functions construct new waveforms by processing existing waveforms:

`sum_harmonics`	Sum over modes.
`densify_phasor_hw`	Densify `HarmonicWaveform` with sparse `TimePhasor` or `FrequencyPhasor` by interpolation (Deprecated).
`densify_phasor_pw`	Densify `ProjectedWaveform` with sparse `TimePhasor` or `FrequencyPhasor` representations by interpolation (Deprecated).
`densify_phasor_hpw`	Densify `HarmonicProjectedWaveform` with sparse `TimePhasor` or `FrequencyPhasor` representations by interpolation (Deprecated).
`phasor_to_series`	Convert phasor-valued waveform to series-valued waveform.
`phasor_to_fs_hw`	Convert `FrequencyPhasor`-valued `HarmonicWaveform` to `FrequencySeries` (Deprecated).
`phasor_to_fs_pw`	Convert `FrequencyPhasor`-valued `ProjectedWaveform` to `FrequencySeries` (Deprecated).
`phasor_to_fs_hpw`	Convert `FrequencyPhasor`-valued `HarmonicProjectedWaveform` to `FrequencySeries` (Deprecated).
`get_dense_maker`	Return a function to convert a sparse phasor projected waveform to a dense phasor projected waveform (Deprecated).

Noise Models and Likelihoods§

`make_sdm`	Make a `SpectralDensity`, a `DiagonalSpectralDensity` or an `EvolutionarySpectralDensity`.
`noise_model`	Construct a `FDNoiseModel` or `TFNoiseModel` from a `SpectralDensity` or a `EvolutionarySpectralDensity`.
`whittle`	Construct a WhittleLikelihood.

Miscellaneous§

The following functions do not fit into the above categories, but are useful helpers for constructing the above objects.

`axis`	Create an `Axis` instance.
`linspace`	Create a `Linspace` instance.
`linspace_from_step`	Create a `Linspace` instance from a start, step, and num.
`linspace_from_array`	Create a `Linspace` instance from an array.
`build_grid2d`	Build a `Grid2D`, either `dense` or `sparse`.