API interface

Here we document the various classes, functions and modules provided within CWInPy.

Handling heterodyned data

• Data handling
  • Heterodyned Data
  • Data references

Bayesian inference

• Likelihood function
  • TargetedPulsarLikelihood
  • Likelihood references
• Reduced Order Quadrature
  • ROQ in CWInPy
  • ROQ API
• Hierarchical inference
  • Evaluating the integral
  • Available distributions
  • Example
  • Sampling the hyperparameters
  • Model comparison
  • Hierarchical module API
  • Hierarchical analysis references

Plotting

• Plotting results
  • Example: plotting 1D marginal posteriors
  • Example: over-plotting multiple 1D posteriors
  • Example: plotting 2D posteriors
  • Example: plotting multiple posteriors
  • Plotting API
  • Plotting references

Signal simulation

• Simulating an individual signal
  • Phase offset signal
  • Examples
  • Signal API
  • Signal references
• Simulating a population of signals
  • Simulation using fake data
  • Simulation using real data
  • Simulation class API

Observing run information

• Run information
  • Run times
  • Hardware injections
  • CVMFS data locations
  • Run information references

Utility functions

• Utility functions
  • CHECKPOINT_EXIT_CODE
  • EPHEMERIS_CACHE_DIR
  • LAL_BINARY_MODELS
  • LAL_EPHEMERIS_TYPES
  • MuteStream
  • TEMPO2_GW_ALIASES
  • allzero()
  • check_for_tempo2()
  • convert_dict_values_if_possible()
  • convert_string_to_dict()
  • draw_ra_dec()
  • ellipticity_to_q22()
  • gcd_array()
  • get_psr_name()
  • initialise_ephemeris()
  • int_to_alpha()
  • is_par_file()
  • is_valid_psr_name()
  • lalinference_to_bilby_result()
  • logfactorial()
  • overlap()
  • parse_args()
  • q22_to_ellipticity()
  • relative_topdir()
  • string_to_int_float()
  • strip_quotes()
  • Utility references
• Reading/storing pulsar parameters
  • PulsarParameters