LALInspiral 5.0.3.1-eeff03c
RingUtils.h File Reference

Prototypes

REAL4 XLALBlackHoleRingSpin (REAL4 Q)
 
REAL4 XLALBlackHoleRingMass (REAL4 f, REAL4 Q)
 
REAL4 XLALBlackHoleRingQuality (REAL4 a)
 
REAL4 XLALBlackHoleRingFrequency (REAL4 M, REAL4 a)
 
REAL4 XLALNonSpinBinaryFinalBHSpin (REAL4 eta)
 
REAL4 XLALNonSpinBinaryFinalBHMass (REAL4 eta, REAL4 mass1, REAL4 mass2)
 
REAL4 XLALSpinBinaryFinalBHSpin (REAL4 eta, REAL4 mass1, REAL4 mass2, REAL4 spin1x, REAL4 spin2x, REAL4 spin1y, REAL4 spin2y, REAL4 spin1z, REAL4 spin2z)
 
REAL4 XLALBlackHoleRingAmplitude (REAL4 f, REAL4 Q, REAL4 r, REAL4 epsilon)
 
REAL4 XLALBlackHoleRingEpsilon (REAL4 f, REAL4 Q, REAL4 r, REAL4 amplitude)
 
REAL4 XLALBlackHoleRingHRSS (REAL4 f, REAL4 Q, REAL4 amplitude, REAL4 plus, REAL4 cross)
 
REAL8 XLAL2DRingMetricDistance (REAL8 fa, REAL8 fb, REAL8 Qa, REAL8 Qb)
 
REAL8 XLAL3DRingMetricDistance (REAL8 fa, REAL8 fb, REAL8 Qa, REAL8 Qb, REAL8 dt)
 
REAL8 XLAL3DRingTimeMinimum (REAL8 fa, REAL8 fb, REAL8 Qa, REAL8 Qb)
 
REAL8 XLALRingdownTimeError (const SnglRingdownTable *table, REAL8 lal_ring_ds_sq)
 
int XLALComputeRingTemplate (REAL4TimeSeries *output, SnglRingdownTable *input)
 This routine computes the ringdown waveform. More...
 
int XLALComputeBlackHoleRing (REAL4TimeSeries *output, SnglRingdownTable *input, REAL4 dynRange)
 This routine computes a waveform for a black hole with the specified physical parameters (in the input structure). More...
 
RingTemplateBankXLALCreateRingTemplateBank (RingTemplateBankInput *input)
 This routine creates a bank of ringdown templates that cover a set range in the parameters \(f\) and \(Q\). More...
 
void XLALDestroyRingTemplateBank (RingTemplateBank *bank)
 Destroys a RingTemplateBank. More...
 

Go to the source code of this file.

Data Structures

struct  RingTemplateBank
 This structure contains a bank of ringdown waveforms. More...
 
struct  RingTemplateBankInput
 This structure contains the parameters required for generating a ringdown template bank. More...
 

Macros

Error Codes
#define RINGH_ENULL   01
 Null pointer. More...
 
#define RINGH_ENNUL   02
 Non-null pointer. More...
 
#define RINGH_EALOC   04
 Memory allocation error. More...