ProjectedWaveform

class typed_lisa_toolkit.types.ProjectedWaveform[RepT: AnyReps]

Single-mode or mode-summed waveform projected onto the detector response in different channels.

Note

To build a ProjectedWaveform, use the factory function: projected_waveform() or pw().

classmethod from_dict(data_dict: Mapping[str, AnyReps], /, **kwargs: Any) → Self

Create a new instance from a dictionary of channel names to representations.

Warning

This is an expert-level API. Most users should use the top-level factory functions in typed_lisa_toolkit.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

get_kernel() → Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]]

Return kernel entries in conventional shape.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pick(channels: str | tuple[str, ...]) → Self

Return a new instance containing only the specified channels.

set_name(name: str | None) → Self

Set the name of the data container.

The name is only used for labeling the data container in plots.

Note

This method returns self to allow for fluent method chaining.

values() → an object providing a view on D's values

property channel_names: tuple[str, ...]

Return the channel names.

property domain: Literal['time', 'frequency', 'time-frequency']

Physical domain shared by all channels.

property grid

Return the grid.

property kind: str | None

Semantic kind.

property xp

The underlying array namespace (numpy-like module).