Next:
Preface
Up:
LAL S oftware D
Previous:
Contributors
Index
Contents
Contributors
Preface
Coding and Documentation Instructions
An Introduction to the LIGO/LSC Algorithm Library (LAL)
The LAL webpage
Notes about coding
The directory structure of the LAL
Schematic Diagram of Directory Structure
Documenting your code
Use L
A
TEX
The lay out of the documentation
Documentation for a single package versus a comprehensive LAL manual
What about figures?
Autodocumentation and Indexing
Autodocumentation requirements
Indexing requirements
Package samplepackage
Header SampleHeader1.h
Synopsis and description
Error conditions
Structures
Module SampleModule1.c
Prototypes
Description and operating instructions
Algorithm
Uses
Notes
Validation Information
Program SampleTest.c
Usage
Description and operating instructions
Exit Codes
Uses
Notes
References
Index
The automatic documentation system
A four step introduction to the code parser laldoc
Brief Description of the parser laldoc
The laldoc command line
The three laldoc environments
How laldoc handles the output files
Examples of how to use the three environments in laldoc
The <lalVerbatim> environment
The <lalLaTeX> environment
The <lalErrTable> environment, for printing a table of the error codes and warnings.
How the documentation is automatically built
Documentation of the LAL packages
Package std
Header LALConfig.h
Synopsis
Header LALStdlib.h
Synopsis
Header LALRCSID.h
Synopsis
Header LALDatatypes.h
Synopsis
Primitive datatypes
Atomic datatypes codes
Aggregate datatypes
Structured datatypes
The LAL universal status structure LALStatus
Header LALStatusMacros.h
Synopsis
Status-reporting objects
Using the status tools
Compilation flags
Notes
Example: A LAL primer
Sample header: LALPrimer.h
Sample module: LALPrimer.c
Sample program: LALPrimerTest.c
Header LALConstants.h
Synopsis
Mathematical constants
Physical constants
Astrophysical parameters
Bibliography
Package support
Header LALStdio.h
Synopsis
Module LALStd.c
Prototypes
Description
Module FileIO.c
Prototypes
Description
Header LALVersion.h
Synopsis
Global variables
Macros
Error conditions
Module LALVersion.c
Program LALVersionTest.c
Header LALMalloc.h
Synopsis
Module LALMalloc.c
Program LALMallocTest.c
Header LALError.h
Synopsis
Module LALError.c
Header Grid.h
Synopsis
Error conditions
Types
Module Grid.c
Header PrintVector.h
Synopsis
Module PrintVector.c
Program PrintVectorTest.c
Header PrintFTSeries.h
Synopsis
Module PrintTimeSeries.c
Program PrintFTSeriesTest.c
Module PrintFrequencySeries.c
Header ReadFTSeries.h
Synopsis
Module ReadFrequencySeries.c
Module ReadTimeSeries.c
Program ReadFTSeriesTest.c
Header StringInput.h
Synopsis
Error conditions
Constants
Types
Module StringToken.c
Module StringConvert.c
Header StreamInput.h
Synopsis
Error conditions
Types
Module StreamVectorInput.c
Module StreamVectorSequenceInput.c
Module StreamSequenceInput.c
Module StreamSeriesInput.c
Program TwoDMeshTest.c
Header Resample.h
Synopsis
Error conditions
Types
Module CreateResampleRules.c
Module DestroyResampleRules.c
Module StreamGridInput.c
Module ApplyResampleRules.c
Module PolycoToTimingDifference.c
Module RulesToTimingDifference.c
Program ResampleTest.c
Bibliography
Package pulsar: Hough transform routines
Header LALDemod.h
Synopsis
Structures
Program LALDemodTest.c
Header ComputeSky.h
Synopsis
Error conditions
Structures
Module ComputeSky.c
Program StreamInputTest.c
Header LALComputeAM.h
Synposis
Error conditions
Structures
Module LALComputeAM.c
Prototypes
Header LALBarycenter.h
Synopsis
Error conditions
Structures
Module LALBarycenter.c
Header LALInitBarycenter.h
Program LALBarycenterTest.c
Header PtoleMetric.h
Synopsis
Error conditions
Structures
Module LALPtoleMetric
Program StreamSeriesInputTest.c
Program PtoleMetricTest
Program PtoleMeshTest
Bibliography
Package pulsar: known pulsar time-domain search routines
Header HeterodynePulsar.h
Synopsis
Error conditions
Types
Module HeterodynePulsar.c
Program HeterodynePulsarTest.c
Header FitToPulsar.h
Synopsis
Error conditions
Structures
Module FitToPulsar.c
Header StreamOutput.h
Synopsis
Error conditions
Types
Module FitToPulsar.c
Program FitToPulsarTest.c
Header PulsarCat.h
Synopsis
Error conditions
Types
Module PulsarCat.c
Module PulsarCatInput.c
Program PulsarCatTest.c
Package houghpulsar: The Hough transform
Acknowledgment
Header LUT.h
Synopsis
Error conditions
Constant declarations
Structures and type definitions
Module Stereographic.c
Module StreamSeriesOutput.c
Module PatchGrid.c
Module ParamPLUT.c
Module NDParamPLUT.c
Module ConstructPLUT.c
Program TestConstructPLUT.c
Program TestNDConstructPLUT.c
Module StreamGridOutput.c
Header PHMD.h
Synopsis
Error conditions
Structures
Module Peak2PHMD.c
Program TestPeak2PHMD.c
Program TestNDPeak2PHMD.c
Header HoughMap.h
Synopsis
Error conditions
Structures and type definitions
Module HoughMap.c
Program TestHoughMap.c
Header LALInitBarycenter.h
Synopsis
Error conditions
Program TestNDHoughMap.c
Header LALHough.h
Synopsis
Error conditions
Structures
Module DriveHough.c
Program TestDriveHough.c
Program TestDriveNDHough.c
Bibliography
Package fct
Header LALfct.h
Synopsis
Structures and Datatypes
Module LALfct.c
Sample Program LALfctSample.c
Package framedata
Header FrameCache.h
Synopsis
Error conditions
Structures
Module FrameCache.c
Header FrameStream.h
Synopsis
Error conditions
Structures
Module FrameStream.c
Module LALInitBarycenter.c
Module FrameSeries.c
Program FrameStreamTest.c
Header FrameCalibration.h
Synopsis
Error conditions
Structures
Module FrameCalibration.c
Prototypes
Program FrameCalibrationTest.c
Usage
Package comm
Header Comm.h
Synopsis
Error conditions
Types
Module SendRecv.c
Module Exchange.c
Description
Program SendRecvTest.c
Program ExchangeTest.c
Package findchirp
Conventions
The Fourier Transform
Power Spectral Densities
Header FindChirp.h
Synopsis
Error codes
Types
Header LALXMGRInterface.h
Synopsis
Error codes
Types
Module FindChirpMemory.c
Module FindChirpFilter.c
Module FindChirpSimulation.c
Header FindChirpChisq.h
Synopsis
Error codes
Types
Module LALXMGRInterface.c
Module FindChirpChisq.c
Header FindChirpSP.h
Synopsis
Error codes
Types
Module FindChirpSPData.c
Module FindChirpSPTemplate.c
Header FindChirpEngine.h
Synopsis
Error codes
Types
Header LIGOLwXML.h
Synopsis
Error conditions
Structures
Header TwoInterfFindChirp.h
Synopsis
Error codes
Types
Package burstsearch
Header StdBurstSearch.h
Synopsis
Error Conditions
Algorithm
Header TFTransform.h
Synopsis
Error Conditions
Structures
Module CreateRealDFTParams.c
Module DestroyRealDFTParams.c
Module CreateComplexDFTParams.c
Module DestroyComplexDFTParams.c
Module ComputeFrequencySeries.c
Module CreateTFPlane.c
Module DestroyTFPlane.c
Module TimeSeriesToTFPlane.c
Module LIGOLwXML.c
Module FreqSeriesToTFPlane.c
Header ExcessPower.h
Synopsis
Error Conditions
Structures
Module LALAddWhiteNoise.c
Module LALCreateTFTiling.c
Module LALDestroyTFTiling.c
Module LALComputeTFPlanes.c
Module LALComputeExcessPower.c
Module LALSortTFTiling.c
Module LALCountEPEvents.c
Module LALPrintTFTileList.c
Module LALComputeLikelihood.c
Header EPSearch.h
Synopsis
Error Conditions
Structures
Module EPSearch.c
Header Thresholds.h
Synopsis
Error Conditions
Package tools
Structures
Module Thresholds.c
Bibliography
Package: tfclusters
Header TFClusters.h
Synopsis
Error Conditions
Structures
Module TFClusters.c
Header Units.h
Synopsis
Error conditions
Structures
Program TFClustersTest1.c
Usage
Description
Exit codes
Uses
Notes
Header TFCThresholds.h
Synopsis
Error Conditions
Structures
Module TFCThresholds.c
Package slopefilters
Header SlopeDetectorFilter.h
Synopsis
Error conditions
Structures
Module SlopeDetectorFilter.c
Program SlopeDetectorFilterTest.c
Module UnitDefs.c
Package waveburst
Header LALWavelet.h
Synopsis
Error conditions
Structures
Module LALWavelet.c
Package block
Header BlockRho.h
Error conditions
Structures and Unions
Module BlockRho2.c
Description
Algorithms
Uses
Notes
Index
Module UnitNormalize.c
Module UnitRaise.c
Module UnitMultiply.c
Module UnitCompare.c
Program UnitsTest.c
Header DetectorSite.h
Synopsis
Error conditions
Structures
Module CreateDetector.c
Program DetectorSiteTest.c
Header DetResponse.h
Synopsis
Error conditions
Types and Structures
Module DetResponse.c
Header Calibration.h
Synopsis
Error conditions
Structures
Module ComputeTransfer.c
Header ResampleTimeSeries.h
Synopsis
Error conditions
Types
Module ResampleTimeSeries.c
Prototypes
Program ResampleTimeSeriesTest.c
Header LIGOMetadataTables.h
Synopsis
Types
Header LIGOMetadataUtils.h
Synopsis
Types
Module SnglInspiralUtils.c
Bibliography
Package sample
Header LALSample.h
Synopsis
Error codes
Module LALSample.c
Program LALSampleTest.c
Package hello
Header LALHello.h
Synopsis
Error conditions
Structures
Module LALHello.c
Program LALHelloTest.c
Package factories
Header AVFactories.h
Synopsis
Error conditions
Module VectorFactories.c
Module ArrayFactories.c
Program VectorFactoriesTest.c
Program ArrayFactoriesTest.c
Header SeqFactories.h
Synopsis
Error conditions
Structures
Module VectorSequenceFactories.c
Program VectorSequenceFactoriesTest.c
Program ArraySequenceFactoriesTest.c
Package vectorops
Header VectorOps.h
Synopsis
Error conditions
Module VectorMultiply.c
Module VectorPolar.c
Program VectorOpsTest.c
Header VectorIndexRange.h
Synopsis
Error conditions
Module VectorIndexRange.c
Description
Algorithms
Uses
Notes
Header Matrix.h
Synopsis
Error conditions
Module MatrixMultiply.c
Description
Algorithms
Uses
Notes
Module MatrixDivide.c
Description
Algorithms
Uses
Notes
Module MatrixPower.c
Description
Algorithms
Uses
Notes
Module MiscMatlab.c
Description
Algorithms
Uses
Notes
Bibliography
Package utilities
Header Random.h
Synopsis
Error conditions
Structures
Module Random.c
Program RandomTest.c
Usage
Module MersenneRandom.c
Program MersenneRandomTest.c
Header FindRoot.h
Synopsis
Error conditions
Structures
Module FindRoot.c
Program FindRootTest.c
Usage
Header Integrate.h
Synopsis
Error conditions
Structures
Module Integrate.c
Program IntegrateTest.c
Usage
Header Interpolate.h
Synopsis
Error conditions
Structures
Module Interpolate.c
Program InterpolateTest.c
Usage
Header Sort.h
Synopsis
Error conditions
Structures
Module HeapSort.c
Program SortTest.c
Header ODE.h
Synopsis
Error conditions
Structures
Module ODE.c
Program ODETest.c
Header Dirichlet.h
Synopsis
Error conditions
Structures
Module Dirichlet.c
Program DirichletTest.c
Header CoarseGrainFrequencySeries.h
Synopsis
Error conditions
Structures
Module CoarseGrainFrequencySeries.c
Program SCoarseGrainFrequencySeriesTest.c
Program DCoarseGrainFrequencySeriesTest.c
Program CCoarseGrainFrequencySeriesTest.c
Program ZCoarseGrainFrequencySeriesTest.c
Header MatrixUtils.h
Synopsis
Error conditions
Module MatrixOps.c
Module DetInverse.c
Module DetInverseInternal.c
Program DetInverseTest.c
Module Eigen.c
Module EigenInternal.c
Program EigenTest.c
Header LALRunningMedian.h
Synopsis
Error conditions
Structures
Module LALRunningMedian.c
Program LALRunningMedianTest.c
Bibliography
Package stats
Header LALMoment.h
Synopsis
Error codes
Module LALMoment.c
Program LALMomentTest.c
Header LALCorrelation.h
Synopsis
Error conditions
Structures
Module LALCorrelation.c
Program LALCorrelationTest.c
Package inject
Header Inject.h
Synopsis
Error conditions
Types
Module InjectVector.c
Module InjectTimeSeries.c
Program BasicInjectTest.c
Program InjectTest.c
Header SimulateCoherentGW.h
Synopsis
Error conditions
Types
Module SimulateCoherentGW.c
Header GeneratePPNInspiral.h
Synopsis
Error conditions
Termination conditions
Types
Module GeneratePPNInspiral.c
Module GetInspiralParams.c
Program GeneratePPNInspiralTest.c
Header GenerateTaylorCW.h
Synopsis
Error conditions
Types
Module GenerateTaylorCW.c
Program SimulateTaylorCWTest.c
Header GenerateSpinOrbitCW.h
Synopsis
Error conditions
Types
Module GenerateSpinOrbitCW.c
Module GenerateEllipticSpinOrbitCW.c
Module GenerateParabolicSpinOrbitCW.c
Module GenerateHyperbolicSpinOrbitCW.c
Header GenerateBurst.h
Synopsis
Error conditions
Types
Module GenerateBurst.c
Header SkyCoordinates.h
Synopsis
Error conditions
Types
Module CelestialCoordinates.c
Module TerrestrialCoordinates.c
Module SkyCoordinates.c
Program SkyCoordinatesTest.c
Header SimulateInspiral.h
Synopsis
Error conditions
Types
Conventions
Module SimulateInspiral.c
Header SimulateSB.h
Synopsis
Error conditions
Structures
Module SimulateSB.c
Header SimulatePopcorn.h
Synopsis
Error conditions
Structures
Structures
Bibliography
Package date
Header Date.h
Synopsis
Error conditions
Structures
Types
Module Julian.c
Prototypes
Module DateString.c
Prototypes
Module LMST1.c
Prototypes
Module SecsToLALDate.c
Prototypes
Module GPStoUTC.c
Prototypes
Module GPStoFloat.c
Prototypes
Module GPStoINT8.c
Prototypes
Module IncrementGPS.c
Prototypes
Module GPSTimeNow.c
Prototypes
Module Playground.c
Prototypes
Header TimeDelay.h
Synopsis
Error conditions
Structures
Module TimeDelay.c
Module TimeDelayFromEarthCenter.c
Bibliography
Package tdfilter
Header ZPGFilter.h
Synopsis
Error conditions
Structures
Module CreateZPGFilter.c
Module DestroyZPGFilter.c
Module BilinearTransform.c
Header IIRFilter.h
Synopsis
Error conditions
Types
Module CreateIIRFilter.c
Module DestroyIIRFilter.c
Module IIRFilter.c
Module IIRFilterVector.c
Module IIRFilterVectorR.c
Program IIRFilterTest.c
Header BandPassTimeSeries.h
Synopsis
Error conditions
Types
Module ButterworthTimeSeries.c
Program BandPassTest.c
Header LPC.h
Synopsis
Error Conditions
Package window
Header Window.h
Synopsis
Error conditions
Types
Module Window.c
Program WindowTest.c
Bibliography
Package fft
Header RealFFT.h
Synopsis
Error conditions
Structures
Module RealFFT.c
Program RealFFTTest.c
Usage
Header ComplexFFT.h
Synopsis
Error conditions
Structures
Module ComplexFFT.c
Program ComplexFFTTest.c
Usage
Header TimeFreqFFT.h
Synopsis
Error conditions
Types
Module TimeFreqFFT.c
Program TimeFreqFFTTest.c
Usage
Bibliography
Package clremoval
Header CLR.h
Synopsis
Error conditions
Structures
Module HarmonicFinder.c
Module RefInterference.c
Module CleanAll.c
Program CLRTest.c
Bibliography
Package stochastic
Header StochasticCrossCorrelation.h
Synopsis
Error conditions
Structures
Module StochasticCrossCorrelation.c
Program StochasticCrossCorrelationStatisticTest.c
Program StochasticHeterodynedCrossCorrelationStatisticTest.c
Program StochasticCrossCorrelationSpectrumTest.c
Module ZeroPadAndFFT.c
Program SZeroPadAndFFTTest.c
Program CZeroPadAndFFTTest.c
Module StochasticOptimalFilter.c
Program StochasticOptimalFilterTest.c
Module StochasticOptimalFilterNormalization.c
Program StochasticOptimalFilterNormalizationTest.c
Module StochasticInverseNoise.c
Program StochasticInverseNoiseTest.c
Module StochasticOmegaGW.c
Program StochasticOmegaGWTest.c
Module OverlapReductionFunction.c
Program OverlapReductionFunctionTest.c
Header AstroOmega.h
Synopsis
Error conditions
Structures
Module AstroOmegaGeneral.c
Module AstroOmegaTermplates.c
Bibliography
Package inspiral
Taylor and Pade approximants
Stationary Phase Approximation
Amplitude in the Fourier domain
Effective one-body approach
Spinning Modulated Chirps
Header LALInspiral.h
Synopsis
Error codes
Structures
Module LALInspiralParameterCalc.c
Module LALInspiralWaveLength.c
Module LALInspiralWave.c and LALInspiralWaveTemplates.c
Module LALInspiralWave1.c and LALInspiralWave1Templates.c
Module LALInspiralWave2.c and LALInspiralWave2Templates.c
Module LALInspiralWave3.c and LALInspiralWave3Templates.c
Module LALInspiralStationaryPhaseApprox1.c
Module LALInspiralStationaryPhaseApprox2.c
Module LALEOBWaveform.c and LALEOBWaveformTemplates.c
Module LALBCVWaveform.c
Module LALInspiralSpinningBHBinary.c
Module LALInspiralChooseModel.c
Module LALInspiralSetup.c
Module LALEtaTau02.c
Module LALEtaTau04.c
Module LALInspiralDerivatives.c
Module LALInspiralVelocity.c
Module LALInspiralPhasing1.c
Module LALInspiralPhiofVIntegrand.c
Module LALInspiralPhasing2.c
Module LALInspiralPhasing3.c
Module LALInspiralTofV.c
Module LALInspiralTofVIntegrand.c
Module LALInspiralTiming2.c
Module LALInspiralFrequency3.c
Module LALRungeKutta4.c
Module LALInspiralTest.c
Module LALInspiralTestOne.c
Module LALInspiralSpinningBHBinariesTest.c
Bibliography
Package noisemodels
Header LALNoiseModels.h
Synopsis
Error codes
Structures
Module LALNoiseSpectralDensity.c
Module LALInspiralWaveCorrelate.c
Module LALInspiralWaveNormalise.c
Module LALInspiralWaveNormaliseLSO.c
Module LALGEOPsd.c
Module LALLIGOIPsd.c
Module LALTAMAPsd.c
Module LALVIRGOPsd.c
Module LALRandomInspiralSignal.c
Module LALColoredNoise.c
Module LALAddVectors.c
Module LALInspiralWaveOverlap.c
Module LALInspiralFindEvents.c
Module LALInspiralFindLoudestEvent.c
Module LALInspiralFindEventsCluster.c
Module LALStatsREAL4Vector.c
Module LALInspiralComputeChisq.c
Module LALInspiralComputeSNRIntegrand.c
Program FilterTest.c
Program RandomInspiralSignalTest.c
Program NoisePSDTest.c
Package bank
Template Placement for Binary Inspiral Searches
Coarse Grid Algorithm
Header LALInspiralBank.h
Synopsis
Error codes
Enums
Structures
Module LALInspiralCreateCoarseBank.c
Module LALInspiralCreateFlatBank.c
Module LALInspiralBCVFcutBank.c
Module LALInspiralCreateFineBank.c
Module LALInspiralComputeMetric.c
Module LALInspiralLongestTemplateInBank.c
Module LALInspiralMoments.c
Module LALInspiralMomentsIntegrand.c
Module LALInspiralSetSearchLimits.c
Module LALInspiralNextTemplate.c
Module LALInspiralComputeParams.c
Module LALInspiralValidParams.c
Module LALInspiralValidTemplate.c
Module LALInspiralUpdateParams.c
Module LALMatrixTransform.c
Module LALInspiralMoments.c
Module LALDeterminant.c
Module LALInverse3.c
Module LALInspiralSetParams.c
Module LALRectangleVertices.c
Program CoarseTest.c
Program CoarseTest2.c
Program ChirpSpace.c
Bibliography
Package ring
Header Ring.h
Synopsis
Error conditions
Structures
Module Ring.c
Program RingTest.c
Header RingSearch.h
Synopsis
Error conditions
Structures
Module RingSearchInit.c
Module RingSearchConditionData.c
Module RingSearch.c
Program RingSearchTest.c
Header LALRingDown.h
Synopsis
Error codes
Structures
Module LALRingDown.c
Program LALRingDownTest.c
Header LALWiener.h
Synopsis
Error codes
Structures
Module LALWiener.c
Program LALWienerTest.c
Bibliography
Package pulsar: common routines
Package pulsar: amplitude folding routines
Header FoldAmplitudes.h
Synopsis
Error conditions
Structures
Module FoldAmplitudes.c
Program FoldAmplitudesTest.c
Package pulsar: stack-slide routines
Header PulsarTimes.h
Synopsis
Error conditions
Types
Module GetEarthTimes.c
Module TBaryPtolemaic.c
Module TSpin.c
Module TComp.c
Header StackMetric.h
Synopsis
Error conditions
Types
Module CoherentMetric.c
Module StackMetric.c
Module ProjectMetric.c
Program StackMetricTest.c
Program SkyMetricTest.c
Header FlatMesh.h
Synopsis
Error conditions
Types
Module FlatMesh.c
Program FlatMeshTest.c
Program DirectedMeshTest.c
Header TwoDMesh.h
Synopsis
Error conditions
Types
Module TwoDMesh.c
Module TwoDMeshInternal.c
Module TwoDMeshMetrics.c
Module TwoDMeshRanges.c
Header TwoDMeshPlot.h
Synopsis
Error conditions
Constants
Types
Module TwoDMeshPlot.c
About this document ...
Subsections
Preface
LAL test account 2003-10-23
