Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structure List
Here are the data structures with brief descriptions:
[detail level 1234]
 Nlalpulsar
 Nlalpulsar_knope_result_page
 Nlalpulsar_MakeSFTDAG
 C_SFT_header_t
 CalignedREAL4VectorSequence
 CalignedREAL8Vector
 CalignedREAL8VectorArray
 CAMCoeffsThis structure contains the per-SFT (weighted) antenna-pattern functions \( \widehat{a}_{X\alpha}, \widehat{b}_{X\alpha} \) , with \( \alpha \) the SFT-index, and \( X \) the IFO index
 CAMCoeffsParamsThis structure contains the parameters for the routine
 CAmplitudePrior_tSignal (amplitude) parameter ranges
 CAmpParamsRange_tSignal (amplitude) parameter ranges
 CAntennaPatternMatrixStruct holding the "antenna-pattern" matrix \( \mathcal{M}_{\mu\nu} \equiv \left( \mathbf{h}_\mu|\mathbf{h}_\nu\right) \) , in terms of the multi-detector scalar product
 CassumeNSparams
 CBarycenterBufferInternal (opaque) buffer type for optimized Barycentering function
 CBarycenterInputBasic input structure to LALBarycenter.c
 CBestVariablesStruct fo storing all the variables affected by the selection of a subset of SFTs
 CBinaryOrbitParams
 CBinaryPulsarInputStructure containing the input parameters for the binary delay function
 CBinaryPulsarOutputStructure containing the output parameters for the binary delay function
 CBinaryPulsarParamsA structure to contain all pulsar parameters and associated errors
 CBSGLComponentsType containing multi- and single-detector \( \mathcal{F} \) -statistics and line-robust statistic
 CBSGLSetupInternal storage for setup and pre-computed BSGL quantities
 Ccache_itemItem stored in the cache
 CCalibrationFiles
 Ccandidate
 CcandidateVector
 Ccheb_series
 CCmplxDetectorTensorThe 'detector tensor' for a GW-detector: symmetric 3x3 matrix, storing only the upper triangle
 CCoarseGridStructure for storing coarse-grid points
 CCommandLineArgsTag
 CCOMPLEX16FrequencySeriesVectorA vector of COMPLEX16FrequencySeries
 CCOMPLEX16SFTData1
 CCOMPLEX8FrequencySeriesVectorA vector of COMPLEX8FrequencySeries
 CCOMPLEX8SFTData1
 CCOMPLEX8SFTvector1
 CConfigVariablesConfiguration settings required for and defining a coherent pulsar search
 CConfigVariables_tConfig variables 'derived' from user-input
 CConfigVars_tConfiguration-variables derived from user-variables
 CCrossCorrAmps
 CCrossCorrBeamFn
 CCrossCorrBeamFnListElement
 CCrossCorrBinaryOutputEntryType to hold the fields that will be kept in a "toplist" – for a directed binary search
 CCrossCorrOutputEntryType to hold the fields that will be kept in a "toplist"
 CCrossCorrTimings_t
 CCSParamsThis structure contains the parameters for the LALComputeSky() routine
 CCWMFDataParamsStruct controlling all the aspects of the fake data (time-series + SFTs) to be produced by XLALCWMakeFakeData() and XLALCWMakeFakeMultiData()
 CDemodMethodData
 CDetectorArmStruct containing pre-computed quantites describing a single detector arm: unit-vector along detector-arm, arm-length, and arm "basis-tensor" n x n
 CDetectorStateState-info about position, velocity and LMST of a detector together with corresponding EarthState
 CDetectorStateSeriesTimeseries of DetectorState's, representing the detector-info at different timestamps
 CDetResponseTimeLookupTablePulsar signal-generation routines for heterodyned data
 CDopplerCoordinateSystemType describing a Doppler coordinate system: lists the number of dimensions and the symbolic names of the coordinates
 CDopplerFstatMetricStruct to hold the output of XLALComputeDopplerFstatMetric(), including meta-info on the number of dimensions, the coordinate-system and type of metric
 CDopplerFullScanInitStructure describing a region in paramter-space (a,d,f,f1dot,..)
 CDopplerFullScanState--— internal [opaque] type to store the state of a FULL multidimensional grid-scan --—
 CDopplerMetricParamsMeta-info specifying a Doppler-metric
 CDopplerPhaseMetricStruct to hold the output of XLALComputeDopplerPhaseMetric(), including meta-info on the number of dimensions, the coordinate-system and type of metric
 CDopplerPoint'point' in the "Doppler parameter space" {alpha, delta, fkdot }
 CDopplerRegion
 CDopplerSkyGridSky grid
 CDopplerSkyScanInitInitialization-structure passed to InitDopplerSkyScan()
 CDopplerSkyScanStateThis structure reflects the current state of a DopplerSkyScan
 CE_solver_params
 CEarthStateBasic output structure of LALBarycenterEarth.c
 CEmissionTimeBasic output structure produced by LALBarycenter.c
 CEphemerisDataThis structure contains all information about the center-of-mass positions of the Earth and Sun, listed at regular time intervals
 CEphemerisVectorGeneric ephemeris-vector type, holding one timeseries of pos, vel, acceleration
 CExRegionA structure for information on the exclusion region needed to avoid edge effects in calculation of Cstat
 CF1DotAgeBrakingBoundInfo
 CF2DotBrakingBoundInfo
 CfactoredGridScan_t
 CfarStruct
 CffdataStruct
 CFilterResponse
 CFilters
 CFineGrid
 Cfixed_site_t
 Cfixed_sky_t-------— internal buffer type for optimized Barycentering function -------—
 CFmetricAtoms_tStruct to hold the 'atoms', ie weighted phase-derivative averages like \( \langle a^2 \partial_i \phi \partial_j \phi\rangle> \) from which the F-metric is computed, but also the full Fisher-matrix
 CFrameCache
 CFreqSkypos_tConvenience container for precomputed pi f L/c and skyposition vector
 CFstatAtomAn \( \mathcal{F} \) -statistic 'atom', i.e
 CFstatAtomVectorA vector of \( \mathcal{F} \) -statistic 'atoms', i.e
 CFstatCandidateWhat info do we want to store in our toplist?
 CFstatCheckpointFileToplist as a checkpointed file
 CFstatCommon
 CFstatInputXLALComputeFstat() input data structure
 CFstatInputVectorA vector of XLALComputeFstat() input data structures, for e.g
 CFstatLine_t
 CFstatMethodFuncs
 CFstatOptionalArgsStruct of optional 'advanced level' and (potentially method-specific) arguments to be passed to the \( \mathcal{F} \) -statistic setup function XLALCreateFstatInput()
 CFstatOutputEntryType to hold the fields that will be output in unclustered output file
 CFstatResultsXLALComputeFstat() computed results structure
 CFstatTimingDemod
 CFstatTimingGenericGeneric F-stat timing coefficients (times in seconds) [see https://dcc.ligo.org/LIGO-T1600531-v4 for details] tauF_eff = tauF_core + b * tauF_buffer where 'b' denotes the fraction of times per call to XLALComputeFstat() the buffer needed to be recomputed ==> b = NBufferMisses / NCalls
"
 CFstatTimingModelStruct to carry the \( \mathcal{F} \) -statistic method-specific timing model in terms of a list of variable names and corresponding REAL4 values, including a help-string documenting the timing model variables
 CFstatTimingResamp
 CGCTtopOutputEntry
 Cgsl_probR_pars
 Cheadertag2
 CHeterodyneParams
 CHOUGHBin2BorderThis structure stores the border indexes corresponding to one frequency bin plus the corrections to be added to the first column of the patch
 CHOUGHBorderThis structure stores the border of a circle clipped on the projected plane
 CHOUGHDemodParDemodulation parameters needed for the Hough transform; all coordinates are assumed to be with respect to the same reference system
 CHoughFstatOutputEntryType to hold the fields that will be kept in a "toplist"
 CHoughInjectParams
 CHOUGHMapDerivThis structure stores the Hough map derivative
 CHOUGHMapTotalThis structure stores the Hough map
 CHOUGHMapTotalVectorThis structure contains a vector of Hough maps
 CHoughNearTemplates
 CHOUGHParamPLUTParameters needed to construct the partial look up table
 CHoughParamsTest
 CHOUGHPatchGridThis structure stores patch-frequency grid information
 CHOUGHPeakGramThis structure stores the `‘peak-gram’'
 CHOUGHPeakGramVectorThis structure contains a vector of peak-grams (for the different time stamps)
 CHOUGHphmdThis structure stores a partial Hough map derivative
 CHOUGHptfLUTThis structure stores the patch-time-frequency look up table
 CHOUGHptfLUTVectorThis structure contains a vector of partial look up tables (for the different time stamps)
 CHoughPulsarTemplate
 CHOUGHResidualSpinParThis structure stores the residual spin-down parameters at a given time
 CHOUGHResolutionParParameters needed for gridding the patch
 CHoughSignificantEvent
 CHoughSignificantEventVector
 CHOUGHSizeParRequired for constructing patch
 CHoughSkyPatchesInfo
 CHoughStatsStructure for storing statistical information about a Hough map
 CHoughTemplate
 CIFOModelExtraData
 CIFTE_interpolation_info
 CIFTEphemeris
 CihsfarStruct
 CihsMaximaStruct
 CihsVals
 CInjParams_tHold all (generally) randomly drawn injection parameters: skypos, amplitude-params, M_mu_nu, transient-window, SNR
 CInputParams
 CinputParams_t
 CintegrationParams_t
 Cintparams_tParameters for metric-integration
 CKopeikinTermsStructure containing the Kopeikin terms
 CLatticeTilingDescribes a lattice tiling parameter-space bounds and metric
 CLatticeTilingIteratorIterates over all points in a lattice tiling
 CLatticeTilingLocatorLocates the nearest point in a lattice tiling
 CLatticeTilingStatsStatistics related to the number/value of lattice tiling points in a dimension
 CLIGOTimeGPSVectorA vector of 'timestamps' of type LIGOTimeGPS
 CLineHarmonicsInfoStructure for storing the contents of the input list of known spectral disturbances
 CLineNoiseInfoStructure for storing list of spectral lines – constructed by expanding list of harmonics
 CLT_BoundLattice tiling parameter-space bound for one dimension
 CLT_CallbackLattice tiling callback function and associated data
 CLT_FITSRecordFITS record for for saving and restoring a lattice tiling iterator
 CLT_IndexTrieLattice tiling index trie for one dimension
 CMeshMacroParamStruc
 CMetricEllipse"sky-ellipse", described by the two major axes and it's angle wrt x-axis
 CMJDTime
 CmultiAMBuffer_tStruct for buffering of AM-coeffs, if signal for same sky-position is injected
 CMultiAMCoeffsMulti-IFO container for antenna-pattern coefficients \( a_{X\alpha}, b_{X\alpha} \) and atenna-pattern matrix \( \mathcal{M}_{\mu\nu} \)
 CMultiCOMPLEX8TimeSeriesMulti-IFO container for COMPLEX8 resampled timeseries
 CMultiDetectorStateSeriesMulti-IFO time-series of DetectorStates
 CMultiFstatAtomVectorA multi-detector vector of FstatAtomVector
 CMultiLALDetectorArray of detectors definitions 'LALDetector'
 CMultiLIGOTimeGPSVectorA collection of (multi-IFO) LIGOTimeGPSVector time-stamps vectors
 CMultiNoiseFloorArray of detector-specific 'noise floors' (ie PSD values), assumed constant over the frequency-band of interest
 CMultiNoiseWeightsOne noise-weight (number) per SFT (therefore indexed over IFOs and SFTs
 CMultiPhaseDerivs
 CMultiPSDVectorA collection of PSD vectors – one for each IFO in a multi-IFO search
 CMultiREAL4TimeSeriesA collection of (multi-IFO) REAL4 time-series
 CMultiREAL8TimeSeriesA collection of (multi-IFO) REAL8 time-series
 CMultiResampSFTMultiCountListOUTER List of SFT indices
 CMultiResampSFTPairMultiIndexListResampling Multi List of all paired SFTs L_Y_K_X, top level (multiple pairs, multiple detectors)
 CMultiSFTCatalogViewA multi-SFT-catalogue "view": a multi-IFO vector of SFT-catalogs
 CMultiSFTVectorA collection of SFT vectors – one for each IFO in a multi-IFO search
 CMultiSSBtimesMulti-IFO container for SSB timings
 CMultiUINT4VectorA collection of UINT4Vectors – one for each IFO
 Cncx2cdf_solver_params
 COldDopplerMetric
 CParamData
 CParamStructA structure for template parameters
 Cpdf1D_tEncode a pdf(x) as a discretized function probDens[i] = pdf( x[i] ) with user-specified bins xBin[i]
 CPhaseDerivs
 CPHMDVectorSequenceThis structure contains a vector sequence of partial-Hough maps derivatives (for different time stamps and different frequencies) representing a circular buffer for the frequency indexes
 CPhysicalSkyBoundData
 CPhysicalSkyBoundPiece
 CPiecewiseBoundInfoA struct containing the relevant information for calculating upper and lower bounds on a specific piecewise segment
 CPorbEllipticalBoundInfo
 CPosVel3D_tSmall Container to hold two 3D vectors: position and velocity
 CPosVel_t
 CPosVelAccStructure holding a REAL8 time, and a position, velocity and acceleration vector
 CPSDListElement
 CPtoleMetricInThis structure will likely be changed to match up better with those under StackMetric.h; it contains the bare necessities, not needing function pointers etc
 CPulsarAmplitudeParamsType containing the JKS 'amplitude parameters' {h0, cosi, phi0, psi}
 CPulsarCandidateType containing a "candidate": parameter-space point with estimated errors and Fstat-value/significance
 CPulsarCoherentGWThis structure stores a representation of a plane gravitational wave propagating from a particular point on the sky
 CPulsarData
 CPulsarDetectorResponseThis structure contains information required to determine the response of a detector to a gravitational waveform
 CPulsarDopplerParamsType containing the 'Doppler-parameters' affecting the time-evolution of the phase
 CPulsarParamThe PulsarParam list node structure
 CPulsarParametersThe PulsarParameters structure to contain a set of pulsar parameters
 CPulsarParamsType defining the parameters of a pulsar-source of CW Gravitational waves
 CPulsarParamsVectorStraightforward vector type of N PulsarParams structs
 CPulsarSignalParamsInput parameters to GeneratePulsarSignal(), defining the source and the time-series
 CPulsarSpinRangeContains a "spin-range", ie spins \( f^{(k)} \) and corresponding bands \( \Delta f^{(k)} \) at a given (SSB) reference GPS-time \( \tau \)
 Cqfvars
 CREAL4FrequencySeriesVectorA vector of REAL4FrequencySeries
 CREAL4VectorAlignedArray
 CREAL8Cart2CoorTwo dimensional Cartessian coordinates
 CREAL8Cart3CoorThree dimensional Cartessian coordinates
 CREAL8Cart3CoorVector
 CREAL8FrequencySeriesVectorA vector of REAL8FrequencySeries
 CREAL8ListElement
 CREAL8Periodogram1
 CREAL8PeriodoPSDStructure containing psd and periodogram of a sft – obsolete – use LAL functions
 CREAL8Polar2CoorTwo dimensional polar coordinates
 CREAL8UnitPolarCoorPolar coordinates of a unitary vector on the sphere
 CREAL8VectorListDoubly linked list of REAL8-vectors (physical vectors)
 CRecalcStatsComponentsType containing multi- and single-detector \( \mathcal{F} \) -statistics and line-robust statistic
 CRecalcStatsParamsType containing input arguments for XLALComputeExtraStatsForToplist()
 CResampCrossCorrTimingInfo
 CResampCrossCorrWorkspace
 CResampCUDAMethodData
 CResampCUDAWorkspace
 CResampGenericMethodData
 CResampGenericWorkspace
 CResampSFTIndexResampling: Index to refer to fields of an SFT given a specific index L_Y_K_X
 CResampSFTIndexListResampling: List of SFT indices L for a given detector Y_K_X: indexing method is nominally original vectors but may be affected by gaps
 CResampSFTMultiCountListINNER List of SFT indices
 CResampSFTMultiCountListDetMIDDLE List of SFT indices
 CResampSFTMultiIndexListResampling: Multi List of indices of SFT L_Y, for a given sft K_X
 CResampSFTPairMultiIndexListResampling Multi List of SFT pair indices (L_Y_K), for a given detector X
 CResultHistory_tRudimentary first sketch of a history type, to encode all the history-trail leading to a certain result from primal inputs
 CscanlineWindow_tMoving 'Scanline window' of candidates on the scan-line, which is used to find local 1D maxima
 Csegment_infoInput data segment info
 CSegment_tType describing one coherent segment of data: ( start-time + duration )
 CSegmentVector_tStandard vector of data-segments
 CSemiCohCandidateOne hough or stackslide candidate
 CSemiCohCandidateListStructure for storing candidates produced by Hough search
 CSemiCoherentParamsParameters for the semicoherent stage
 CSFDBHeader
 CSFTandSignalParamsParameters defining the pulsar signal and SFTs used by LALFastGeneratePulsarSFTs()
 CSFTCatalogAn "SFT-catalogue": a vector of SFTdescriptors, as returned by XLALSFTdataFind()
 CSFTCatalogSequenceSequence of SFT catalogs – for each segment
 CSFTConstraints'Constraints' for SFT-matching: which detector, within which time-stretch and which timestamps exactly should be loaded ? Any of the entries is optional, and they will be combined by logical AND
 CSFTCountResampling Counter of matching SFTs for a given detector Y_K_X matching SFT K_X
 CSFTDescriptorA 'descriptor' of an SFT: basically containing the header-info plus an opaque description of where exactly to load this SFT from
 CSFTDetectorInfo
 CSFTFilenameSpecStructure specifying an SFT file name, following the convention in [4]
 CSFTIndexIndex to refer to an SFT given a set of SFTs from several different detectors
 CSFTIndexListList of SFT indices
 CSFTListElement
 CSFTPairIndexIndex to refer to a pair of SFTs
 CSFTPairIndexListList of SFT pair indices
 CSFTParamsParameters defining the SFTs to be returned from LALSignalToSFTs()
 CSFTReadSegmentSegments read so far from one SFT
 CSkyConstAndZeroPsiAMResponseSky Constants and beam pattern response functions used by LALFastGeneratePulsarSFTs()
 CSkyPatchesInfoStruct holding info about skypoints
 CSkyRegionStructure describing a polygon-region in the sky
 CSM_CallbackOut
 CSM_CallbackParam
 Csolver_params
 CSpinOrbitCWParamStrucThis structure stores the parameters for constructing a gravitational waveform with both a Taylor-polynomial intrinsic frequency and phase, and a binary-orbit modulation
 CSplInterParams
 CSSBtimesSimple container for two REAL8-vectors, namely the SSB-timings DeltaT_alpha and Tdot_alpha, with one entry per SFT-timestamp
 CSuperskyMetricsComputed supersky metrics, returned by XLALComputeSuperskyMetrics()
 CSuperskyTransformDataSupersky metric coordinate transform data
 Cswig_lalpulsar_test_parent_map_struct
 CSymmTensor3A symmetric 3x3 tensor (such as detector-tensors), storing only the upper triangle
 CSymmTensor3dA symmetric 3x3 tensor (such as detector-tensors), storing only the upper triangle, using REAL8 precision
 CtagSFTLocator
 CTaylorCWParamStrucThis structure stores the parameters for constructing a gravitational waveform with a Taylor-polynomial frequency and phase
 CTimeCorrectionDataThis structure will contain a vector of time corrections used during conversion from TT to TDB/TCB/Teph
 CtimingInfo_tStruct holding various timing measurements and relevant search parameters
 CTimings_t
 Ctoplist_t
 CtransientCandidate_tStruct holding a transient CW candidate
 CtransientFstatMap_tStruct holding a transient-window "F-statistic map" over start-time and timescale {t0, tau}
 CtransientWindow_tStruct defining one transient window instance
 CtransientWindowRange_tStruct defining a range of transient windows
 CTwoDColumnParamStrucThis structure stores additional parameters required when laying down a single column of a two-dimensional mesh
 CTwoDMeshNodeThis structure represents a single node in a linked list of mesh points, specified in the coordinate system used to place it
 CTwoDMeshParamStrucThis structure stores the parameters required by the two-dimensional mesh placement functions
 CTwoDMeshPlotStrucThis structure stores parameters specifying how to plot a PostScript diagram of the parameter mesh
 CTwoSpectParamSpaceSearchVals
 CTwoSpectTemplate
 CTwoSpectTemplateVector
 CUCHARPeakGramExplicit peakgram structure – 1 if power in bin is above threshold and 0 if below
 CUCHARPeakGramVector
 CUINT8FrequencyIndexVectorThis structure stores the frequency indexes of the partial-Hough map derivatives at different time stamps that have to be combined to form a Hough map for a given (null or) residual spin-down parameters
 CUINT8FrequencyIndexVectorSequenceThis structure stores a set of frequency-index vectors
 Cul_params
 CUNIT_SOURCE
 CUpperLimit
 CUpperLimitVector
 CUsefulStageVariablesUseful variables for each hierarchical stage
 CUserVar
 CUserVariables
 CUserVariables_tUser input variables
 Cvect2Dlist_tVariable-length list of 2D-vectors
 Cvect3Dlist_tVariable-length list of 3D vectors
 CVectorComparisonStruct holding the results of comparing two floating-point vectors (real-valued or complex), using various different comparison metrics
 CVectorStructA structure for frequency series
 CVelocityParThis structure stores the parameters required by XLALBarycenter() to calculate Earth velocity at a given detector location
 CWeaveCacheCache used to store coherent results
 CWeaveCacheQueriesContainer for a series of cache queries
 CWeaveCohInputInput data required for computing coherent results
 CWeaveCohResultsResults of a coherent computation on a single segment
 CWeaveMean2FHistogramBinHistogram bin of mean multi-F-statistics
 CWeaveOutputResultsOutput results from a search
 CWeaveResultsToplistToplist of output results
 CWeaveResultsToplistItemToplist item
 CWeaveSearchIteratorIterator over a search parameter space
 CWeaveSearchTimingContainer for timings and other information for a timing model
 CWeaveSemiResultsFinal results of a semicoherent computation over many segments
 CWeaveSetupDataSetup data which is computed only once for a given search setup
 CWeaveStatisticMapStruct defining the global 'statistics map' that contains all the defining properties of the supported statistics
 CWeaveStatisticsParamsStruct holding all parameters and status values for computing various statistics
 CWeaveStatisticsValues