Skip to contents

Generate gravitational-wave signal from PyCBC

get_wave.Rd

Calls PyCBC waveform generator and optionally applies antenna projection and Earth rotation.

Usage

get_wave(
  model.name,
  sampling.freq,
  fl = NULL,
  fu = NULL,
  m1 = NULL,
  m2 = NULL,
  d_L = NULL,
  inc = 0,
  ...,
  R.ts = TRUE,
  det,
  ra,
  dec,
  pol,
  t_gps,
  proj = FALSE
)

Arguments

model.name

A character. Waveform approximant name (e.g., "IMRPhenomPv2").

sampling.freq

A numeric. Sampling rate in Hz.

fl

A numeric. Lower frequency bound (Hz).

fu

A numeric. Upper frequency bound (Hz).

m1

A numeric. Mass 1 (solar masses).

m2

A numeric. Mass 2 (solar masses).

d_L

A numeric. Luminosity distance (Mpc).

inc

A numeric. Inclination angle (radians). Default: 0.

...

Additional waveform parameters.

R.ts

Logical. If TRUE, return result as R ts objects.

det

A character. Detector abbreviation.

ra

A numeric. Right Ascension (radians).

dec

A numeric. Declination (radians).

pol

A numeric. Polarization angle (radians).

t_gps

A numeric. GPS time of signal arrival.

proj

Logical. If TRUE, apply full Earth-rotation-based projection.

Value

A list with waveform components (hp, hc, ht) and attributes:

  • Params – generation parameters

  • AntPat – antenna pattern info

Details

This function interfaces with Python's pycbc library using reticulate. Please ensure that the required Python packages are available in your environment.