gwexpy.interop.pycbc_

gwexpy.interop.pycbc 

Interoperability with PyCBC (Python gravitational-wave data analysis library).

Provides bidirectional conversion between PyCBC time/frequency series types and GWexpy TimeSeries / FrequencySeries.

Functions

`from_pycbc_frequencyseries`(cls, pycbc_fs, *)	Create a GWexpy FrequencySeries from a PyCBC FrequencySeries.
`from_pycbc_timeseries`(cls, pycbc_ts, *[, copy])	Create a GWexpy TimeSeries from a PyCBC TimeSeries.
`to_pycbc_frequencyseries`(fs)	Convert a GWexpy FrequencySeries to a PyCBC FrequencySeries.
`to_pycbc_timeseries`(ts)	Convert a GWexpy TimeSeries to a PyCBC TimeSeries.

gwexpy.interop.pycbc_.from_pycbc_timeseries(cls: type, pycbc_ts: Any, *, copy: bool = True) → Any[source]

Create a GWexpy TimeSeries from a PyCBC TimeSeries.

Parameters:

cls (type) – The TimeSeries class to instantiate.
pycbc_ts (pycbc.types.TimeSeries) – PyCBC time series object.
copy (bool, default True) – Whether to copy the underlying data array.

Returns:

GWexpy TimeSeries with epoch, sample rate and unit from PyCBC.

Return type:

TimeSeries

Examples

>>> from pycbc.types import TimeSeries as PyCBCTimeSeries
>>> import numpy as np
>>> pycbc_ts = PyCBCTimeSeries(np.zeros(1024), delta_t=1/1024, epoch=0)
>>> from gwexpy.timeseries import TimeSeries
>>> ts = TimeSeries.from_pycbc(pycbc_ts)

gwexpy.interop.pycbc_.to_pycbc_timeseries(ts: Any) → Any[source]

Convert a GWexpy TimeSeries to a PyCBC TimeSeries.

Parameters:: ts (TimeSeries) – GWexpy TimeSeries to convert.
Returns:: PyCBC time series.
Return type:: pycbc.types.TimeSeries

Examples

>>> from gwexpy.timeseries import TimeSeries
>>> import numpy as np
>>> ts = TimeSeries(np.zeros(1024), t0=0, dt=1/1024)
>>> pycbc_ts = ts.to_pycbc()

gwexpy.interop.pycbc_.from_pycbc_frequencyseries(cls: type, pycbc_fs: Any, *, copy: bool = True) → Any[source]

Create a GWexpy FrequencySeries from a PyCBC FrequencySeries.

Parameters:

cls (type) – The FrequencySeries class to instantiate.
pycbc_fs (pycbc.types.FrequencySeries) – PyCBC frequency series object.
copy (bool, default True) – Whether to copy the underlying data array.

Returns:

GWexpy FrequencySeries with df, epoch and unit from PyCBC.

Return type:

FrequencySeries

Examples

>>> from pycbc.types import FrequencySeries as PyCBCFrequencySeries
>>> import numpy as np
>>> pycbc_fs = PyCBCFrequencySeries(np.zeros(512, dtype=complex), delta_f=1.0, epoch=0)
>>> from gwexpy.frequencyseries import FrequencySeries
>>> fs = FrequencySeries.from_pycbc(pycbc_fs)

gwexpy.interop.pycbc_.to_pycbc_frequencyseries(fs: Any) → Any[source]

Convert a GWexpy FrequencySeries to a PyCBC FrequencySeries.

Parameters:: fs (FrequencySeries) – GWexpy FrequencySeries to convert.
Returns:: PyCBC frequency series.
Return type:: pycbc.types.FrequencySeries

Examples

>>> from gwexpy.frequencyseries import FrequencySeries
>>> import numpy as np
>>> fs = FrequencySeries(np.zeros(512, dtype=complex), frequencies=np.arange(512))
>>> pycbc_fs = fs.to_pycbc()

gwexpy.interop.pycbc_

gwexpy.interop.pycbc

gwexpy.interop.pycbc 