Documentation

Here is a list of all modules:

[detail level 1234]

▼General Packages
►Standard Definitions	This package contains headers providing basic datatypes, constants, and macros that support the LAL standard
Header LALConfig.h	Defines configuration macro constants
Header LALConstants.h	Provides standard numerical constants for LAL
Headers LAL(Atomic)Datatypes.h	Provides the basic LAL datatypes
Header LALDebugLevel.h	Control LALSuite debugging information verbosity and memory debugging features
Header LALError.h	Provides routines to report and handle errors
Header LALGSL.h	Provides macros for integrating the GSL error handler with the LAL status structure
Header LALMalloc.h	Provides standard LAL memory allocation/deallocation routines
Header LALSIMD.h	SIMD extension detection and runtime selection for LALSuite
Header LALStatusMacros.h	Provides macros for handling the LALStatus structure
Header LALStdio.h	Provides LAL functions similar to the non-file functions in <stdio.h>
Header LALStdlib.h	Includes the standard LAL header files
Header LALString.h	XLAL string manipulation routines
Header LALVCSInfoType.h	Contains routines for dealing with VCS and build information
Header StringInput.h	Provides routines to parse CHARVectors into other LAL datatypes
Header XLALError.h	This header covers routines to provide the XLAL interface error handling
►Date and Time Routines	This package provides routines related to date and time manipulations (Header Date.h)
►Header Date.h	Provides routines for manipulating date and time information
CivilTime	XLAL routines for converting civil time structures to GPS times
SideralTime	XLAL routines for computing the sidereal time
GPS Time	GPS time manipulation functions
Header TimeDelay.h	Provides routines to compute time delay between two detectors
►Datatype Factory Routines	This package provides routines for creating and destroying the LAL aggregate datatypes
►Header AVFactories.h	Provides prototype and status code information for use of CreateVector, CreateArray, ResizeVector, ResizeArray, DestroyVector and DestroyArray
Module ArrayFactories.c	Create/destroy <datatype>Array objects
Module VectorFactories.c	Create/destroy <datatype>Vector objects
►Header SeqFactories.h	Provides prototype and status code information for use of CreateVectorSequence and DestroyVectorSequence
Module ArraySequenceFactories.c	Create/destroy <datatype>ArraySequence objects
Module VectorSequenceFactories.c	Create/destroy <datatype>VectorSequence objects
Header StringVector.h	Creation/destruction/manipulation API for LALStringVector objects, which are just LAL-type vectors of CHAR * pointers
►General Purpose Tools	This package contains the general purpose LAL tools
►Header Calibration.h	Calibration API
Module ComputeTransfer.c	Computes the transfer function from zero-pole-gain representation
Header DetResponse.h	Provides routines to compute gravitational wave detector response to polarized planar gravitational wave originating from a given source, detected at a given time
Frequency Series Manipulation	This is a suite of functions for creating, destroying, and manipulating LAL frequency series. One pair of functions (the XLAL version and its LAL counterpart) is available for each method and frequency series type. For example XLALCreateREAL4FrequencySeries() is available for creating frequency series of REAL4 data, and the LAL-stype wrapper LALCreateREAL4FrequencySeries() is provided which is equivalent to the XLAL version in all respects except that it adheres to the LAL calling conventions (eg. it takes a LALStatus pointer as its first argument, its return type is void, etc.)
►Header LALDetectors.h	This header defines structures to hold the basic data describing a gravitational wave detector
Module CreateDetector.c	Creates a LALDetector structure from a LALFrDetector structure and the type of detector
Detector Constants	Constants describing various gravitational wave detectors
►Header ResampleTimeSeries.h	Provides routines to resample a time series
Module ResampleTimeSeries.c	Downsamples a time series in place by an integer power of two
Header Segments.h	Provides data types and functions for manipulating lists of `‘segments’' (GPS time intervals)
Sequence Manipulation	This is a suite of functions for creating, destroying, and manipulating LAL sequences. For example XLALCreateREAL4Sequence() is available for creating sequences of REAL4 data
Time Series Manipulation	This is a suite of functions for creating, destroying, and manipulating LAL time series. One pair of functions (the XLAL version and its LAL counterpart) is available for each method and series type. For example XLALCreateREAL4TimeSeries() is available for creating time series of REAL4 data, and the LAL-stype wrapper LALCreateREAL4TimeSeries() is provided which is equivalent to the XLAL version in all respects except that it adheres to the LAL calling conventions (eg. it takes a LALStatus pointer as its first argument, its return type is void, etc.)
Trigger Interpolation	This module implements several algorithms for performing sub-sample interpolation of peaks in the output of a matched filter
►Header Units.h	Provides prototypes for manipulation of units and declares extern constants for the basic and derived SI units
Module UnitDefs.c	Defines basic and derived SI units and a function to produce a text string corresponding to a unit structure
Module UnitNormalize.c	Brings an LALUnit structure into standard form by reducing all of the rational exponents into LCD form
Module UnitRaise.c	Raises an LALUnit structure to a specified rational power
Module UnitMultiply.c	Multiplies two LALUnit structures
Module UnitCompare.c	Function to compare two LALUnit structures
Header LALVCSInfo.h	VCS and build information for LAL
▼Math and Signal Analysis Packages
►Vector Manipulation Routines	This package contains routines for vector manipulation and math
Header VectorMath.h	Functions for performing fast math on vectors of numbers, using SIMD (SSE, AVX, ...) instructions if available
►Header VectorOps.h	Basic vector manipulation operations
Module VectorMultiply.c	Multiply two vectors
Module VectorPolar.c	Convert complex vector components from rectangular coordinates to polar coordinates
►Fast Fourier Transform Routines	This package contains various routines for performing FFTs
Header ComplexFFT_h	Performs complex-to-complex FFTs
Module Convolution.c	Convolutions of time-series
Header RealFFT_h	Performs real-to-complex and complex-to-real FFTs
Header TimeFreqFFT_h	Performs real-to-complex, complex-to-real FFTs and average power spectrum estimation
►Statistical Routines	This package containts statistical routines
Header LALChisq.h	UNDOCUMENTED
►Time-Domain Filter Routines	This package covers LAL routines for constructing and applying digital time-domain filters
►Header BandPassTimeSeries.h	Provides routines to low- or high-pass filter a time series
Module ButterworthTimeSeries.c	Applies a low- or high-pass Butterworth filter to a time series
►Header IIRFilter.h	Provides routines to make and apply IIR filters
Module CreateIIRFilter.c	Creates IIR filter objects
Module DestroyIIRFilter.c	Destroys IIR filter objects
Module IIRFilter.c	Computes an instant-by-instant IIR filter response
Module IIRFilterVector.c	Applies an IIR filter to a data stream
Module IIRFilterVectorR.c	Applies a time-reversed IIR filter to a data stream
►Header ZPGFilter.h	Provides routines to manipulate ZPG filters
Module CreateZPGFilter.c	Creates ZPG filter objects
Module DestroyZPGFilter.c	Destroys ZPG filter objects
Module BilinearTransform.c	Transforms the complex frequency coordinate of a ZPG filter
►Numerical Utilities	This package contains various numerical utilities for use in LAL
Header Factorial.h	Static tables of the factorial and double-factorial functions, and derived quantities
Header FindRoot.h	Root finding routines
Header Integrate.h	Integrates a function
Header Interpolate.h	This header covers the routines for interpolation
Header LALAdaptiveRungeKuttaIntegrator.h	Adaptive Runge-Kutta4
Header LALBitset.h	Implementation of an arbitrary-size bitset
Header LALHashFunc.h	Implementations of various hash functions
Header LALHashTbl.h	Implementation of a generic hash table, following Chapter 5.2 of [19]
Header LALHeap.h	Implementation of a generic heap, following Chapter 10.1 of [19]
Header LALRunningMedian.h	Provides routines to efficiently calculate the running median
►Header MatrixUtils.h	Provides routines to solve linear systems
Module DetInverse.c	Routines to compute matrix determinants and inverses
Module Eigen.c	Routines to compute eigenvalues and eigenvectors
Module MatrixOps.c	Routines to perform basic matrix operations
►Header Random.h	Generates random numbers
Module Random.c	Functions for generating random numbers
Header RngMedBias.h	Routine for finding bias in median for exponential distribution
Header Sort.h	Provides routines for sorting, indexing, and ranking real vector elements
Header SphericalHarmonics.h	Library of Spin-weighted Spherical Harmonic functions and an implementation of the Wigner-D matrices
►Window Routines	This package contains a function to create a vector containing a window (also called a taper, lag window, or apodization function)
Header Window.h	This header file provides routines and structures to create and store window functions (also called a taper, lag window, or apodization function)
►Signal Injection Routines	This package provided routines to simulate gravitational waves and their effect on a detector
Header SimulateCoherentGW.h	Provides routines to simulate generic gravitational waveforms originating from a particular source
►Header SkyCoordinates.h	Module providing routines to convert among various sky coordinate systems
Module CelestialCoordinates.c	Converts among Galactic, ecliptic, and equatorial coordinates
Module TerrestrialCoordinates.c	Converts among equatorial, geographic, and horizon coordinates
Module SkyCoordinates.c	Automatically converts among sky coordinate systems
►Noise Model Routines	This is a module that generates noisemodels of various interferometers and helps run simple filtering of data simulated with these noise models
Header LALNoiseModels.h	Header file for model noise generation codes
▼Support Package	This package covers LAL support routines
Header Audio.h	Routines for exporting time series data as sound files
Header ConfigFile.h	Module for general parsing of simple ASCII-based config-files
Header FileIO.h	Provides standard LAL support IO functions
►Header H5FileIO.h	Provides standard LAL support for reading and writing HDF5 files
Low-Level Routines	Low-level routines for reading/writing HDF5 files
Mid-Level Routines	Mid-level routines for reading/writing HDF5 files
High-Level Routines	High-level routines for reading/writing HDF5 files
Table Reading/Writing Routines	Routines for reading/writing tables in HDF5 files
Header LALCache.h	This header covers routines to create and manipulate LALCache structures and to read LAL cache files
Header LALMathematica.h	Provides structures, functions and macro definitions for modules that generate MATHEMATICA notebooks
Header LogPrintf.h	General-purpose log-message handling, mostly modelled after the MSG_LOG class in BOINC
►Header PrintFTSeries.h	This is a simple utility to print time and frequency series into a file
Module PrintTimeSeries.c	Print a <datatype>TimeSeries object into a file
Module PrintFrequencySeries.c	Print a <datatype>FrequencySeries object into a file
Header PrintVector.h	This is a simple utility to print vectors into a file
►Header ReadFTSeries.h	This is a simple utility to Read time and frequency series into a file
Module ReadTimeSeries.c	Each member of this family of functions reads from a file the output of the corresponding PrintTimeSeries routine
Module ReadFrequencySeries.c	Each member of this family of functions reads from a file the output of the corresponding PrintFrequencySeries routine
Header ReadNoiseSpectrum.h	Provides function to read in a file containing a possibly unequally sampled noise amplitude spectrum ( \(\textrm{strain}/\sqrt(\textrm{Hz})\)) and return as a frequency series
►Header StreamInput.h	Provides routines to read data from an open stream and store it in LAL data structures
Module StreamVectorInput.c	Reads data from a single line in an input stream
Module StreamVectorSequenceInput.c	Reads the entire contents of an input stream into a vector sequence
Module StreamSequenceInput.c	Converts an input stream into a data sequence
Module StreamSeriesInput.c	Converts an input stream into a time or frequency series
►Header StreamOutput.h	Provides routines to write data from LAL data structures to an open stream
Module StreamSeriesOutput.c	Writes a time or frequency series to an output stream
Header TranslateAngles.h	Module for translating between 'hms' (RA) and 'dms' (DEC) angle strings and radians
Header TranslateMJD.h	Module for translating between MJD(TT) strings and GPS
►Header UserInput.h	Module for simple unified handling of user-input from config-file and/or command-line
Header UserInputParse.h	Sub-module for parsing of input 'string values' as various 'types' (as defined in Header UserInput.h)
Header UserInputPrint.h	Sub-module for general printing of various input 'types' (as defined in Header UserInput.h) as 'string values', These can be thought of as the 'inverse functions' to Header UserInputParse.h
▼SWIG Interfaces	This package provides Octave and Python wrappings of LAL functions and data structures generated using SWIG
File SWIGSharedVars.c	Flag variables shared between the LAL SWIG wrappers
Interface SWIGCommon.i	Common SWIG interface code
Interface SWIGLALAlpha.i	SWIG code which must appear before the LAL headers
Interface SWIGLALOmega.i	SWIG code which must appear after the LAL headers
▼Python Packages
Antenna	This module provides a Python class for generating antenna response functions
GPSTime	Utilties for calculating and modifying GPS times using the LAL date package
Utilities	This module provides utilities for generating LAL objects in python