LALPulsar  6.1.0.1-fe68b98
lalpulsar.pulsarpputils Namespace Reference

Data Structures

class  psr_par
 
class  psr_prior
 

Functions

def rad_to_dms (rad)
 rad_to_dms(rad): Convert radians to degrees, minutes, and seconds of arc. More...
 
def dms_to_rad (deg, mins, sec)
 dms_to_rad(deg, min, sec): Convert degrees, minutes, and seconds of arc to radians. More...
 
def dms_to_deg (deg, mins, sec)
 dms_to_deg(deg, min, sec): Convert degrees, minutes, and seconds of arc to degrees. More...
 
def rad_to_hms (rad)
 rad_to_hms(rad): Convert radians to hours, minutes, and seconds of arc. More...
 
def hms_to_rad (hour, mins, sec)
 hms_to_rad(hour, min, sec): Convert hours, minutes, and seconds of arc to radians More...
 
def coord_to_string (h_or_d, m, s)
 coord_to_string(h_or_d, m, s): Return a formatted string of RA or DEC values as 'hh:mm:ss.ssss' if RA, or 'dd:mm:ss.ssss' if DEC. More...
 
def rad_to_string (rad, ra_or_dec)
 rad_to_string(rad, ra_or_dec): Convert an angle in radians to hours/degrees, minutes seconds and output it as a string in the format 'hh:mm:ss.ssss' if RA, or 'dd:mm:ss.ssss' if DEC. More...
 
def ra_to_rad (ra_string)
 ra_to_rad(ar_string): Given a string containing RA information as 'hh:mm:ss.ssss', return the equivalent decimal radians. More...
 
def dec_to_rad (dec_string)
 dec_to_rad(dec_string): Given a string containing DEC information as 'dd:mm:ss.ssss', return the equivalent decimal radians. More...
 
def p_to_f (p, pd, pdd=None)
 p_to_f(p, pd, pdd=None): Convert period, period derivative and period second derivative to the equivalent frequency counterparts. More...
 
def pferrs (porf, porferr, pdorfd=None, pdorfderr=None)
 pferrs(porf, porferr, pdorfd=None, pdorfderr=None): Calculate the period or frequency errors and the pdot or fdot errors from the opposite one. More...
 
def spin_down_limit (freq, fdot, dist)
 
def h0_to_ellipticity (h0, freq, dist)
 
def h0_to_quadrupole (h0, freq, dist)
 
def quadrupole_to_h0 (q22, freq, dist)
 
def phipsiconvert (phipchain, psipchain)
 
def plot_posterior_hist (poslist, param, ifos, parambounds=[float("-inf"), float("inf")], nbins=50, upperlimit=0, overplot=False, parfile=None, mplparams=False)
 
def upper_limit (pos, upperlimit=0.95, parambounds=[float("-inf"), float("inf")], nbins=50)
 
def upper_limit_greedy (pos, upperlimit=0.95, nbins=100)
 
def plot_posterior_chain (poslist, param, ifos, grr=None, withhist=0, mplparams=False)
 
def read_hist_from_file (histfile)
 
def plot_2Dhist_from_file (histfile, ndimlabel, mdimlabel, margpars=True, mplparams=False)
 
def h0ul_from_prior_file (priorfile, ulval=0.95)
 
def plot_posterior_hist2D (poslist, params, ifos, bounds=None, nbins=[50, 50], parfile=None, overplot=False, mplparams=False)
 
def hist_norm_bounds (samples, nbins, low=float("-inf"), high=float("inf"))
 
def tukey_window (N, alpha=0.5)
 
def plot_Bks_ASDs (Bkdata, delt=86400, plotpsds=True, plotfscan=False, removeoutlier=None, mplparams=False)
 
def plot_limits_hist (lims, param, ifos, prevlims=None, bins=20, overplot=False, mplparams=False)
 
def plot_h0_lims (h0lims, f0gw, ifos, xlims=[10, 1500], ulesttop=None, ulestbot=None, prevlim=None, prevlimf0gw=None, overplot=False, mplparams=False)
 
def heterodyned_triaxial_pulsar (starttime, duration, dt, detector, pardict)
 
def heterodyned_pulsar_signal (pardict, detector, starttime=900000000.0, duration=86400.0, dt=60.0, datatimes=None)
 
def convert_model_parameters (pardict)
 
def heterodyned_pinsf_pulsar (starttime, duration, dt, detector, pardict)
 
def antenna_response (gpsTime, ra, dec, psi, det)
 
def inject_pulsar_signal (starttime, duration, dt, detectors, pardict, freqfac=[2.0], npsds=None, snrscale=None)
 
def detector_noise (det, f)
 
def get_optimal_snr (s, sig)
 
def gelman_rubins (chains)
 
def pulsar_mcmc_to_posterior (chainfiles)
 
def read_pulsar_mcmc_file (cf)
 
def pulsar_nest_to_posterior (postfile, nestedsamples=False, removeuntrig=True)
 This function will import a posterior sample file created by lalapps_nest2pos (or a nested sample file). More...
 
def logplus (x, y)
 
def logtrapz (lnf, dx)
 Perform trapezium rule integration for the logarithm of a function on a regular grid. More...
 
def marginalise (like, pname, pnames, ranges)
 
def marginal (lnlike, pname, pnames, ranges, multflatprior=False)
 
def get_chunk_lengths (ts, chunkMax)
 
def pulsar_estimate_snr (source, det, tstart, duration, Sn, dt=1800)
 A function to estimate the signal-to-noise ratio of a pulsar signal (for a triaxial neutron star emitting at twice the rotation frequency from the l=m=2 quadrupole mode) in a given detector over a given time range, for a given one-sided power spectral density. More...
 
def pulsar_estimate_h0_from_snr (snr, source, det, tstart, duration, Sn, dt=600)
 A function to estimate the signal amplitude of a pulsar signal (for a triaxial neutron star emitting at twice the rotation frequency from the l=m=2 quadrupole mode) for a given SNR in a particular detector over a given time range, for a given one-sided power spectral density. More...
 
def pulsar_posterior_grid (dets, ts, data, ra, dec, sigmas=None, paramranges={}, datachunks=30, chunkmin=5, ngrid=50, outputlike=False)
 A function to calculate the 4-parameter posterior probability density for a continuous wave signal given a set of processed data from a set of detectors. More...
 
def get_atnf_info (psr)
 Get the pulsar (psr) distance (DIST in kpc), proper motion corrected period derivative (P1_I) and any association (ASSOC e.g. More...
 
def cov_to_cor (cov)
 Convert a covariance matrix to a correlation coefficient matrix. More...
 

Variables

 ARCSECTORAD = float("4.8481368110953599358991410235794797595635330237270e-6")
 
 RADTOARCSEC = float("206264.80624709635515647335733077861319665970087963")
 
 SECTORAD = float("7.2722052166430399038487115353692196393452995355905e-5")
 
 RADTOSEC = float("13750.987083139757010431557155385240879777313391975")
 
 RADTODEG = float("57.295779513082320876798154814105170332405472466564")
 
 DEGTORAD = float("1.7453292519943295769236907684886127134428718885417e-2")
 
 RADTOHRS = float("3.8197186342054880584532103209403446888270314977710")
 
 HRSTORAD = float("2.6179938779914943653855361527329190701643078328126e-1")
 
 PI = float("3.1415926535897932384626433832795028841971693993751")
 
 TWOPI = float("6.2831853071795864769252867665590057683943387987502")
 
 PIBYTWO = float("1.5707963267948966192313216916397514420985846996876")
 
 SECPERDAY = float("86400.0")
 
 SECPERJULYR = float("31557600.0")
 
 KMPERPC = float("3.0856776e13")
 
 KMPERKPC = float("3.0856776e16")
 
 Tsun = float("4.925490947e-6")
 
 Msun = float("1.9891e30")
 
 Mjup = float("1.8987e27")
 
 Rsun = float("6.9551e8")
 
 Rearth = float("6.378e6")
 
 SOL = float("299792458.0")
 
 MSUN = float("1.989e+30")
 
 G = float("6.673e-11")
 
 C = SOL
 
 KPC = float("3.0856776e19")
 
 I38 = float("1e38")
 
list float_keys
 
list str_keys
 
string ATNF_VERSION = "1.58"
 

Function Documentation

◆ rad_to_dms()

def lalpulsar.pulsarpputils.rad_to_dms (   rad)

rad_to_dms(rad): Convert radians to degrees, minutes, and seconds of arc.

Definition at line 84 of file pulsarpputils.py.

◆ dms_to_rad()

def lalpulsar.pulsarpputils.dms_to_rad (   deg,
  mins,
  sec 
)

dms_to_rad(deg, min, sec): Convert degrees, minutes, and seconds of arc to radians.

Definition at line 104 of file pulsarpputils.py.

◆ dms_to_deg()

def lalpulsar.pulsarpputils.dms_to_deg (   deg,
  mins,
  sec 
)

dms_to_deg(deg, min, sec): Convert degrees, minutes, and seconds of arc to degrees.

Definition at line 122 of file pulsarpputils.py.

◆ rad_to_hms()

def lalpulsar.pulsarpputils.rad_to_hms (   rad)

rad_to_hms(rad): Convert radians to hours, minutes, and seconds of arc.

Definition at line 130 of file pulsarpputils.py.

◆ hms_to_rad()

def lalpulsar.pulsarpputils.hms_to_rad (   hour,
  mins,
  sec 
)

hms_to_rad(hour, min, sec): Convert hours, minutes, and seconds of arc to radians

Definition at line 146 of file pulsarpputils.py.

◆ coord_to_string()

def lalpulsar.pulsarpputils.coord_to_string (   h_or_d,
  m,
  s 
)

coord_to_string(h_or_d, m, s): Return a formatted string of RA or DEC values as 'hh:mm:ss.ssss' if RA, or 'dd:mm:ss.ssss' if DEC.

Definition at line 161 of file pulsarpputils.py.

◆ rad_to_string()

def lalpulsar.pulsarpputils.rad_to_string (   rad,
  ra_or_dec 
)

rad_to_string(rad, ra_or_dec): Convert an angle in radians to hours/degrees, minutes seconds and output it as a string in the format 'hh:mm:ss.ssss' if RA, or 'dd:mm:ss.ssss' if DEC.

Whether to use hours or degrees is set by whether ra_or_dec is 'RA' or 'DEC'

Definition at line 182 of file pulsarpputils.py.

◆ ra_to_rad()

def lalpulsar.pulsarpputils.ra_to_rad (   ra_string)

ra_to_rad(ar_string): Given a string containing RA information as 'hh:mm:ss.ssss', return the equivalent decimal radians.

Also deal with cases where input string is just hh:mm, or hh.

Definition at line 202 of file pulsarpputils.py.

◆ dec_to_rad()

def lalpulsar.pulsarpputils.dec_to_rad (   dec_string)

dec_to_rad(dec_string): Given a string containing DEC information as 'dd:mm:ss.ssss', return the equivalent decimal radians.

Also deal with cases where input string is just dd:mm or dd

Definition at line 222 of file pulsarpputils.py.

◆ p_to_f()

def lalpulsar.pulsarpputils.p_to_f (   p,
  pd,
  pdd = None 
)

p_to_f(p, pd, pdd=None): Convert period, period derivative and period second derivative to the equivalent frequency counterparts.

Will also convert from f to p.

Definition at line 246 of file pulsarpputils.py.

◆ pferrs()

def lalpulsar.pulsarpputils.pferrs (   porf,
  porferr,
  pdorfd = None,
  pdorfderr = None 
)

pferrs(porf, porferr, pdorfd=None, pdorfderr=None): Calculate the period or frequency errors and the pdot or fdot errors from the opposite one.

Definition at line 265 of file pulsarpputils.py.

◆ spin_down_limit()

def lalpulsar.pulsarpputils.spin_down_limit (   freq,
  fdot,
  dist 
)

Definition at line 719 of file pulsarpputils.py.

◆ h0_to_ellipticity()

def lalpulsar.pulsarpputils.h0_to_ellipticity (   h0,
  freq,
  dist 
)

Definition at line 729 of file pulsarpputils.py.

◆ h0_to_quadrupole()

def lalpulsar.pulsarpputils.h0_to_quadrupole (   h0,
  freq,
  dist 
)

Definition at line 736 of file pulsarpputils.py.

◆ quadrupole_to_h0()

def lalpulsar.pulsarpputils.quadrupole_to_h0 (   q22,
  freq,
  dist 
)

Definition at line 750 of file pulsarpputils.py.

◆ phipsiconvert()

def lalpulsar.pulsarpputils.phipsiconvert (   phipchain,
  psipchain 
)

Definition at line 766 of file pulsarpputils.py.

◆ plot_posterior_hist()

def lalpulsar.pulsarpputils.plot_posterior_hist (   poslist,
  param,
  ifos,
  parambounds = [float("-inf"), float("inf")],
  nbins = 50,
  upperlimit = 0,
  overplot = False,
  parfile = None,
  mplparams = False 
)

Definition at line 806 of file pulsarpputils.py.

◆ upper_limit()

def lalpulsar.pulsarpputils.upper_limit (   pos,
  upperlimit = 0.95,
  parambounds = [float("-inf"), float("inf")],
  nbins = 50 
)

Definition at line 933 of file pulsarpputils.py.

◆ upper_limit_greedy()

def lalpulsar.pulsarpputils.upper_limit_greedy (   pos,
  upperlimit = 0.95,
  nbins = 100 
)

Definition at line 956 of file pulsarpputils.py.

◆ plot_posterior_chain()

def lalpulsar.pulsarpputils.plot_posterior_chain (   poslist,
  param,
  ifos,
  grr = None,
  withhist = 0,
  mplparams = False 
)

Definition at line 981 of file pulsarpputils.py.

◆ read_hist_from_file()

def lalpulsar.pulsarpputils.read_hist_from_file (   histfile)

Definition at line 1108 of file pulsarpputils.py.

◆ plot_2Dhist_from_file()

def lalpulsar.pulsarpputils.plot_2Dhist_from_file (   histfile,
  ndimlabel,
  mdimlabel,
  margpars = True,
  mplparams = False 
)

Definition at line 1162 of file pulsarpputils.py.

◆ h0ul_from_prior_file()

def lalpulsar.pulsarpputils.h0ul_from_prior_file (   priorfile,
  ulval = 0.95 
)

Definition at line 1279 of file pulsarpputils.py.

◆ plot_posterior_hist2D()

def lalpulsar.pulsarpputils.plot_posterior_hist2D (   poslist,
  params,
  ifos,
  bounds = None,
  nbins = [50, 50],
  parfile = None,
  overplot = False,
  mplparams = False 
)

Definition at line 1310 of file pulsarpputils.py.

◆ hist_norm_bounds()

def lalpulsar.pulsarpputils.hist_norm_bounds (   samples,
  nbins,
  low = float("-inf"),
  high = float("inf") 
)

Definition at line 1458 of file pulsarpputils.py.

◆ tukey_window()

def lalpulsar.pulsarpputils.tukey_window (   N,
  alpha = 0.5 
)

Definition at line 1529 of file pulsarpputils.py.

◆ plot_Bks_ASDs()

def lalpulsar.pulsarpputils.plot_Bks_ASDs (   Bkdata,
  delt = 86400,
  plotpsds = True,
  plotfscan = False,
  removeoutlier = None,
  mplparams = False 
)

Definition at line 1555 of file pulsarpputils.py.

◆ plot_limits_hist()

def lalpulsar.pulsarpputils.plot_limits_hist (   lims,
  param,
  ifos,
  prevlims = None,
  bins = 20,
  overplot = False,
  mplparams = False 
)

Definition at line 1780 of file pulsarpputils.py.

◆ plot_h0_lims()

def lalpulsar.pulsarpputils.plot_h0_lims (   h0lims,
  f0gw,
  ifos,
  xlims = [10, 1500],
  ulesttop = None,
  ulestbot = None,
  prevlim = None,
  prevlimf0gw = None,
  overplot = False,
  mplparams = False 
)

Definition at line 1959 of file pulsarpputils.py.

◆ heterodyned_triaxial_pulsar()

def lalpulsar.pulsarpputils.heterodyned_triaxial_pulsar (   starttime,
  duration,
  dt,
  detector,
  pardict 
)

Definition at line 2061 of file pulsarpputils.py.

◆ heterodyned_pulsar_signal()

def lalpulsar.pulsarpputils.heterodyned_pulsar_signal (   pardict,
  detector,
  starttime = 900000000.0,
  duration = 86400.0,
  dt = 60.0,
  datatimes = None 
)

Definition at line 2111 of file pulsarpputils.py.

◆ convert_model_parameters()

def lalpulsar.pulsarpputils.convert_model_parameters (   pardict)

Definition at line 2193 of file pulsarpputils.py.

◆ heterodyned_pinsf_pulsar()

def lalpulsar.pulsarpputils.heterodyned_pinsf_pulsar (   starttime,
  duration,
  dt,
  detector,
  pardict 
)

Definition at line 2232 of file pulsarpputils.py.

◆ antenna_response()

def lalpulsar.pulsarpputils.antenna_response (   gpsTime,
  ra,
  dec,
  psi,
  det 
)

Definition at line 2315 of file pulsarpputils.py.

◆ inject_pulsar_signal()

def lalpulsar.pulsarpputils.inject_pulsar_signal (   starttime,
  duration,
  dt,
  detectors,
  pardict,
  freqfac = [2.0],
  npsds = None,
  snrscale = None 
)

Definition at line 2409 of file pulsarpputils.py.

◆ detector_noise()

def lalpulsar.pulsarpputils.detector_noise (   det,
  f 
)

Definition at line 2574 of file pulsarpputils.py.

◆ get_optimal_snr()

def lalpulsar.pulsarpputils.get_optimal_snr (   s,
  sig 
)

Definition at line 2599 of file pulsarpputils.py.

◆ gelman_rubins()

def lalpulsar.pulsarpputils.gelman_rubins (   chains)

Definition at line 2611 of file pulsarpputils.py.

◆ pulsar_mcmc_to_posterior()

def lalpulsar.pulsarpputils.pulsar_mcmc_to_posterior (   chainfiles)

Definition at line 2635 of file pulsarpputils.py.

◆ read_pulsar_mcmc_file()

def lalpulsar.pulsarpputils.read_pulsar_mcmc_file (   cf)

Definition at line 2750 of file pulsarpputils.py.

◆ pulsar_nest_to_posterior()

def lalpulsar.pulsarpputils.pulsar_nest_to_posterior (   postfile,
  nestedsamples = False,
  removeuntrig = True 
)

This function will import a posterior sample file created by lalapps_nest2pos (or a nested sample file).

It will be returned as a Posterior class object from bayespputils. The signal evidence and noise evidence are also returned.

If there are samples in 'Q22' and not 'H0', and also a distance, or distance samples, then the Q22 samples will be converted into equivalent H0 values.

Parameters

postfile : str, required The file name of the posterior or nested sample file. In general this should be a HDF5 file with the extension '.hdf' or '.h5', although older format ascii files are still supported at the moment. nestedsamples : bool, default: False If the file being input contains nested samples, rather than posterior samples, then this flag must be set to True removeuntrig : bool, default: True If this is True then any parameters that are sines or cosines of a value will have the value removed if present e.g. if cosiota and iota exist then iota will be removed.

Definition at line 2827 of file pulsarpputils.py.

◆ logplus()

def lalpulsar.pulsarpputils.logplus (   x,
  y 
)

Definition at line 2995 of file pulsarpputils.py.

◆ logtrapz()

def lalpulsar.pulsarpputils.logtrapz (   lnf,
  dx 
)

Perform trapezium rule integration for the logarithm of a function on a regular grid.

Inputs

lnf - a numpy array of values that are the natural logarithm of a function dx - a float giving the step size between values in the function

Returns

The natural logarithm of the area under the function.

Definition at line 3011 of file pulsarpputils.py.

◆ marginalise()

def lalpulsar.pulsarpputils.marginalise (   like,
  pname,
  pnames,
  ranges 
)

Definition at line 3017 of file pulsarpputils.py.

◆ marginal()

def lalpulsar.pulsarpputils.marginal (   lnlike,
  pname,
  pnames,
  ranges,
  multflatprior = False 
)

Definition at line 3044 of file pulsarpputils.py.

◆ get_chunk_lengths()

def lalpulsar.pulsarpputils.get_chunk_lengths (   ts,
  chunkMax 
)

Definition at line 3069 of file pulsarpputils.py.

◆ pulsar_estimate_snr()

def lalpulsar.pulsarpputils.pulsar_estimate_snr (   source,
  det,
  tstart,
  duration,
  Sn,
  dt = 1800 
)

A function to estimate the signal-to-noise ratio of a pulsar signal (for a triaxial neutron star emitting at twice the rotation frequency from the l=m=2 quadrupole mode) in a given detector over a given time range, for a given one-sided power spectral density.

Inputs

source - a dictionary containing 'h0', 'cosiota', 'psi', 'ra' (rads or string), 'dec' (rads or string) det - the detector, e.g. 'H1' tstart - a GPS start time duration - a signal duration (seconds) Sn - a one-sided power spectral density dt - timestep for antenna response calculation [default: 1800s]

Returns

rho - an estimate of the optimal matched filter SNR

Definition at line 3121 of file pulsarpputils.py.

◆ pulsar_estimate_h0_from_snr()

def lalpulsar.pulsarpputils.pulsar_estimate_h0_from_snr (   snr,
  source,
  det,
  tstart,
  duration,
  Sn,
  dt = 600 
)

A function to estimate the signal amplitude of a pulsar signal (for a triaxial neutron star emitting at twice the rotation frequency from the l=m=2 quadrupole mode) for a given SNR in a particular detector over a given time range, for a given one-sided power spectral density.

Inputs

snr - the optimal matched filter signal-to-noise ratio source - a dictionary containing 'cosiota', 'psi', 'ra' (rads or string), 'dec' (rads or string) det - the detector, e.g. 'H1' tstart - a GPS start time for the signal duration - a signal duration (seconds) Sn - a one-sided power spectral density dt - timestep for antenna response calculation [default: 600s]

Returns

h0 - an estimate of signal amplitude required to give the input SNR

Definition at line 3183 of file pulsarpputils.py.

◆ pulsar_posterior_grid()

def lalpulsar.pulsarpputils.pulsar_posterior_grid (   dets,
  ts,
  data,
  ra,
  dec,
  sigmas = None,
  paramranges = {},
  datachunks = 30,
  chunkmin = 5,
  ngrid = 50,
  outputlike = False 
)

A function to calculate the 4-parameter posterior probability density for a continuous wave signal given a set of processed data from a set of detectors.

Inputs

dets - a list of strings containing the detectors being used in the likelihood calculation ts - a dictionary of 1d numpy arrays containing the GPS times of the data for each detector data - a dictionary of 1d numpy arrays containing the complex data values for each detector ra - the right ascension (in rads) of the source dec - the declination (in rads) of the source sigmas - a dictionary of 1d numpy arrays containing the times series of standard deviation values for each detector. If this is not given a Student's t likelihood will be used, but if it is given a Gaussian likelihood will be used (default: None) paramranges - a dictionary of tuples for each parameter ('h0', 'phi0', 'psi' and 'cosiota') giving the lower and upper ranges of the parameter grid and the number of grid points. If not given then defaults will be used. datachunks - in the calculation split the data into stationary chunks with a maximum length given by this value. If set to 0 or inf then the data will not be split. (default: 30) chunkmin - this is the shortest chunk length allowed to be included in the likelihood calculation (default: 5) ngrid - the number of grid points to use for each dimension of the likelihood calculation. This is used if the values are not specified in the paramranges argument (default: 50) outputlike - output the log likelihoods rather than posteriors (default: False)

Returns

L - The 4d posterior (or likelihood) over all parameters h0pdf - The 1d marginal posterior for h0 phi0pdf - The 1d marginal posterior for phi0 (the rotation frequency, not GW frequency) psipdf - The 1d marginal posterior for psi cosiotapdf - The 1d marginal posterior for cosiota lingrids - A dictionary of the grid points for each parameter sigev - The log evidence for the signal model noiseev - The log evidence for the noise model

An example would be:

set the detectors

dets = ['H1', 'L1']

set the time series and data

ts = {} data = {} for det in dets: ts[det] = np.arange(900000000., 921000843., 60.) data[det] = np.random.randn(len(ts[det])) + 1j*np.random.randn(len(ts[det]))

set the parameter ranges

ra = 0.2 dec = -0.8 paramranges = {} paramranges['h0'] = (0., 2., 50) paramranges['psi'] = (0., np.pi/2., 50) paramranges['phi0'] = (0., np.pi, 50) paramranges['cosiota'] = (-1., 1., 50)

L, h0pdf, phi0pdf, psipdf, cosiotapdf, grid, sigev, noiseev = pulsar_posterior_grid(dets, ts, data, ra, dec, paramranges=paramranges)

Definition at line 3284 of file pulsarpputils.py.

◆ get_atnf_info()

def lalpulsar.pulsarpputils.get_atnf_info (   psr)

Get the pulsar (psr) distance (DIST in kpc), proper motion corrected period derivative (P1_I) and any association (ASSOC e.g.

GC) from the ATNF catalogue.

Definition at line 3565 of file pulsarpputils.py.

◆ cov_to_cor()

def lalpulsar.pulsarpputils.cov_to_cor (   cov)

Convert a covariance matrix to a correlation coefficient matrix.

Return the correlation coefficient matrix and the standard deviations from the covariance matrix.

Definition at line 3621 of file pulsarpputils.py.

Variable Documentation

◆ ARCSECTORAD

lalpulsar.pulsarpputils.ARCSECTORAD = float("4.8481368110953599358991410235794797595635330237270e-6")

Definition at line 51 of file pulsarpputils.py.

◆ RADTOARCSEC

lalpulsar.pulsarpputils.RADTOARCSEC = float("206264.80624709635515647335733077861319665970087963")

Definition at line 52 of file pulsarpputils.py.

◆ SECTORAD

lalpulsar.pulsarpputils.SECTORAD = float("7.2722052166430399038487115353692196393452995355905e-5")

Definition at line 53 of file pulsarpputils.py.

◆ RADTOSEC

lalpulsar.pulsarpputils.RADTOSEC = float("13750.987083139757010431557155385240879777313391975")

Definition at line 54 of file pulsarpputils.py.

◆ RADTODEG

lalpulsar.pulsarpputils.RADTODEG = float("57.295779513082320876798154814105170332405472466564")

Definition at line 55 of file pulsarpputils.py.

◆ DEGTORAD

lalpulsar.pulsarpputils.DEGTORAD = float("1.7453292519943295769236907684886127134428718885417e-2")

Definition at line 56 of file pulsarpputils.py.

◆ RADTOHRS

lalpulsar.pulsarpputils.RADTOHRS = float("3.8197186342054880584532103209403446888270314977710")

Definition at line 57 of file pulsarpputils.py.

◆ HRSTORAD

lalpulsar.pulsarpputils.HRSTORAD = float("2.6179938779914943653855361527329190701643078328126e-1")

Definition at line 58 of file pulsarpputils.py.

◆ PI

lalpulsar.pulsarpputils.PI = float("3.1415926535897932384626433832795028841971693993751")

Definition at line 59 of file pulsarpputils.py.

◆ TWOPI

lalpulsar.pulsarpputils.TWOPI = float("6.2831853071795864769252867665590057683943387987502")

Definition at line 60 of file pulsarpputils.py.

◆ PIBYTWO

lalpulsar.pulsarpputils.PIBYTWO = float("1.5707963267948966192313216916397514420985846996876")

Definition at line 61 of file pulsarpputils.py.

◆ SECPERDAY

lalpulsar.pulsarpputils.SECPERDAY = float("86400.0")

Definition at line 62 of file pulsarpputils.py.

◆ SECPERJULYR

lalpulsar.pulsarpputils.SECPERJULYR = float("31557600.0")

Definition at line 63 of file pulsarpputils.py.

◆ KMPERPC

lalpulsar.pulsarpputils.KMPERPC = float("3.0856776e13")

Definition at line 64 of file pulsarpputils.py.

◆ KMPERKPC

lalpulsar.pulsarpputils.KMPERKPC = float("3.0856776e16")

Definition at line 65 of file pulsarpputils.py.

◆ Tsun

lalpulsar.pulsarpputils.Tsun = float("4.925490947e-6")

Definition at line 66 of file pulsarpputils.py.

◆ Msun

lalpulsar.pulsarpputils.Msun = float("1.9891e30")

Definition at line 67 of file pulsarpputils.py.

◆ Mjup

lalpulsar.pulsarpputils.Mjup = float("1.8987e27")

Definition at line 68 of file pulsarpputils.py.

◆ Rsun

lalpulsar.pulsarpputils.Rsun = float("6.9551e8")

Definition at line 69 of file pulsarpputils.py.

◆ Rearth

lalpulsar.pulsarpputils.Rearth = float("6.378e6")

Definition at line 70 of file pulsarpputils.py.

◆ SOL

lalpulsar.pulsarpputils.SOL = float("299792458.0")

Definition at line 71 of file pulsarpputils.py.

◆ MSUN

lalpulsar.pulsarpputils.MSUN = float("1.989e+30")

Definition at line 72 of file pulsarpputils.py.

◆ G

lalpulsar.pulsarpputils.G = float("6.673e-11")

Definition at line 73 of file pulsarpputils.py.

◆ C

lalpulsar.pulsarpputils.C = SOL

Definition at line 74 of file pulsarpputils.py.

◆ KPC

lalpulsar.pulsarpputils.KPC = float("3.0856776e19")

Definition at line 75 of file pulsarpputils.py.

◆ I38

lalpulsar.pulsarpputils.I38 = float("1e38")

Definition at line 76 of file pulsarpputils.py.

◆ float_keys

list lalpulsar.pulsarpputils.float_keys

Definition at line 281 of file pulsarpputils.py.

◆ str_keys

list lalpulsar.pulsarpputils.str_keys
Initial value:
1 = [
2  "FILE",
3  "PSR",
4  "PSRJ",
5  "NAME",
6  "RAJ",
7  "DECJ",
8  "RA",
9  "DEC",
10  "EPHEM",
11  "CLK",
12  "BINARY",
13  "UNITS",
14 ]

Definition at line 373 of file pulsarpputils.py.

◆ ATNF_VERSION

string lalpulsar.pulsarpputils.ATNF_VERSION = "1.58"

Definition at line 3558 of file pulsarpputils.py.