Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Documentation
Here is a list of all modules:
[detail level 123]
 General RoutinesThis package provides common data-types and routines for pulsar searches
 Header DetectorStates.hAPI for the DetectorStates.c functions
 Header ExtrapolatePulsarSpins.hExtrapolate the Pulsar spin-paramters \( \{f^{(k)}\}\equiv\{f, \dot{f},\ddot{f},...\} \) , and "spin-ranges" \( \{ f^{(k)}, \Delta f^{(k)} \} \) from one SSB epoch to another
 Header FITSFileIO.hRoutines for reading/writing data to/from FITS files
 Header FITSPulsarIO.hRoutines for reading/writing pulsar-related data to/from FITS files
 Header GetEarthTimes.hComputes the next sidereal midnight and autumnal equinox
 Header LALBarycenter.hProvides routines for transforming from arrival time at detector (GPS) to pulse emission time (TDB); ie for `‘barycentering’' the measured astronomical time series
 Header LALPulsarVCSInfo.hVCS and build information for LALPulsar
 Header NormalizeSFTRngMed.hHeader file for SFT normalization routines
 Header PulsarDataTypes.hSome common useful data-types for pulsar-searches
 Header SinCosLUT.hFast non-vector FPU version of SinCos used in various CW codes
 Header SynthesizeCWDraws.hGenerate samples of various statistics (F-stat, F-atoms, B-stat,...) drawn from their respective distributions, assuming Gaussian noise, and drawing signal params from their (given) priors
 Short Fourier Transform RoutinesThis packages provides routines for handling Fourier Transforms (SFTs)
 Header LFTandTSutils.hUtility functions for working with Long Fourier Transforms and Time Series
 Header PSDutils.hModule for computing PSD (Power Spectral Density) estimates and handling related structures
 Header SFTClean.hHeader file for cleaning routines
 Header SFTfileIO.hModule for reading/writing/manipulating SFTs (Short Fourier Transforms)
 Header SFTReferenceLibrary.hThis is a reference library for the SFT data format [4]
 Pulsar Signal GenerationThis package provides routines to simulate gravitational waves from a pulsar and their effect on a detector
 Header CWMakeFakeData.hModule for generating 'fake' data containing CW signals and/or Gaussian noise. This basically presents a high-level wrapper API to the lower-level CW signal-generation functions in lalsuite
 Header GeneratePulsarSignal.hPulsar signal-generation routines for hardware- and software-injections
 Header GenerateSpinOrbitCW.hProvides routines to generate continuous waveforms with spindown and orbital modulation
 Header GenerateTaylorCW.hProvides routines to generate Taylor-parameterized continuous waveforms
 Header PulsarSimulateCoherentGW.hProvides routines to simulate generic gravitational waveforms originating from a particular source
 Header SimulatePulsarSignal.hNew pulsar signal-generation routines
 Pulsar Metric RoutinesThis package provides routines which calculate pulsar-specific parameter-space metrics
 Header MetricUtils.hVarious useful utility functions for working with CW parameter-space metrics
 Header PtoleMetric.hProvides routines to compute pulsar parameter-space metrics using the `‘Ptolemaic’' approximation
 Header SuperskyMetrics.hCompute the supersky metrics and coordinate transforms of [29] and [32]
 Header UniversalDopplerMetric.h
 Template Bank RoutinesThis package provides routines which generate template banks for pulsar searches
 Header LatticeTiling.hLattice-based template generation for constant-metric parameter spaces, described in [30] and [31]
 Header TwoDMesh.hProvides routines to place search meshes for two-dimensional parameter spaces with varying metric
 Header TwoDMeshPlot.hProvides routines to plot two-dimensional parameter meshes
 Coherent Search RoutinesThis packages provides routines which calculate coherent search statistics, e.g
 Header ComputeFstat.hThe \( \mathcal{F} \) -statistic
 Module ComputeFstat_Demod.cImplements the Demod Dirichlet kernel-based demodulation algorithm for computing the \( \mathcal{F} \) -statistic [36]
 Module ComputeFstat_Resamp_CUDA.cuImplements a CUDA version [7] of the Resamp FFT-based resampling algorithm for computing the \(\mathcal{F}\)-statistic [9]
 Module ComputeFstat_Resamp_Generic.cImplements a generic version [22] of the Resamp FFT-based resampling algorithm for computing the \( \mathcal{F} \) -statistic [9]
 Header FstatisticTools.hFunctions to estimate amplitude parameters and convert between different parametrizations
 Header LALComputeAM.hHeader-file for computing antenna-pattern components for amplitude demodulation
 Header SSBtimes.hFunctions for working with SSB times
 Header TransientCW_utils.hSome helper functions useful for "transient CWs", mostly applying transient window functions
 Line-robust detection statisticsThis packages provides routines to calculate (coherent and semi-coherent) line-robust detection statistics (based on F-statistics), e.g
 Header LineRobustStats.hFunctions to compute line-robust CW statistics
 The Hough TransformThis package provides routines which implement the Hough-transform as a search-method for unknown pulsars
 Header HoughMap.hProvides subroutines for initialization and construction of Hough-map derivatives and total Hough-maps
 Header LALHough.hRoutines for building and updating the space of partial Hough map derivatives and related functions needed for the construction of total Hough maps at different frequencies and possible residual spin down parameters
 Header LUT.hProvides structures and function prototypes required for the construction of look up tables that are the core for building the Hough maps
 Header PHMD.hConversion from peaks in a spectrum into a partial Hough map derivative
 StatisticsComputes statistics of the Hough maps
 Header Velocity.hComputation of instant and averaged velocities for a given detector and the like
 Cross-Correlation SearchThis package provides routines which implement a pulsar-specific cross-correlation search
 Header PulsarCrossCorr.hHeader-file for LAL routines for CW cross-correlation searches
 Header PulsarCrossCorr_v2.hHeader-file for XLAL routines for v2 CW cross-correlation searches
 SWIG InterfacesThis package provides Octave and Python wrappings of LALPulsar functions and data structures generated using SWIG
 Interface SWIGLALPulsarAlpha.iSWIG code which must appear before the LALPulsar headers
 Interface SWIGLALPulsarOmega.iSWIG code which must appear after the LALPulsar headers
 Python Packages
 LineFileParserParse identified and unidentified line files following the O3a convention
 Parameter Space Metric UtilitiesUtilities for working with parameter space metrics
 Piecewise ModelPiecewise model code used by lalpulsar_PiecewiseSearch.py
 Public SFT Directory FunctionImplements the public SFT directory naming convention detailed in the SFT spec (T040164)
 SimulateCWGenerate strain time series of a continuous-wave signal in the detector frame, given a function which computes signal phase and amplitudes as functions of time
 SimulateHeterodynedCWThe module provides the HeterodynedCWSimulator() class for simulating a signal from a continuous wave source after application of a heterodyned as described in Equations 7 and 8 of [19]
 Pulsar Applications
 General Tools
 SFT Tools
 FITS Tools
 Search Applications
 Cross-Correlation Search Applications
 Fstatistic Search Applications
 GCT Search Application
 Heterodyne Search Applications
 Hough-on-Fstatistic Search Application
 Piecewise Search ApplicationsPython Copyright (C) 2019–2023 Benjamin Grace
 Sideband Search Application
 TwoSpect Search Application
 Weave Search Application