Detailed User Interface Information

GWSky

Main module.

class gw_sky.gwsky.GWSky(sources, theta, phi, pol='gr')

Class to make sky maps for deterministic PTA gravitational wave signals. Calculated in terms of \(\hat{n}=-\hat{k}\).

Parameters

sourceslist

List of skymap.GW objects that contain the various gravitational wave sources for analysis.

thetalist, array

Pulsar sky location colatitude at which to calculate sky map.

philist, array

Pulsar sky location longitude at which to calculate sky map.

pol: str, optional [‘gr’,’scalar-trans’,’scalar-long’,’vector-long’]

Polarization of gravitational waves to be used in pulsar antenna patterns. Only one can be used at a time.

h_cross(t)

Returns cross polarization strain for all GW sources.

h_plus(t)

Returns plus polarization strain for all GW sources.

residuals(t)

“Pulsar timing time-of-arrival residuals due to GWs

s_cross(t)

Returns cross polarization GW-induced residuals for all GW sources.

s_plus(t)

Returns plus polarization GW-induced residuals for all GW sources.

strain(t)

“Total strain for given GW sources.