LALInspiral 5.0.3.1-eeff03c
RingTemplateBankInput Struct Reference

Detailed Description

This structure contains the parameters required for generating a ringdown template bank.

Definition at line 150 of file RingUtils.h.

Data Fields

REAL4 minQuality
 The minimum quality factor in the bank. More...
 
REAL4 maxQuality
 The maximum quality factor in the bank. More...
 
REAL4 minFrequency
 The minimum central frequency in the bank (in Hz) More...
 
REAL4 maxFrequency
 The minimum central frequency in the bank (in Hz) More...
 
REAL4 maxMismatch
 The maximum mismatch allowed between templates in the bank. More...
 
REAL4 templatePhase
 The phase of the ringdown templates, in radians; Zero is a cosine-phase template; \(-\pi/2\) is a sine-phase template. More...
 
REAL4 templateDistance
 UNDOCUMENTED. More...
 
REAL4 templateEpsilon
 UNDOCUMENTED. More...
 

Field Documentation

◆ minQuality

REAL4 RingTemplateBankInput::minQuality

The minimum quality factor in the bank.

Definition at line 153 of file RingUtils.h.

◆ maxQuality

REAL4 RingTemplateBankInput::maxQuality

The maximum quality factor in the bank.

Definition at line 154 of file RingUtils.h.

◆ minFrequency

REAL4 RingTemplateBankInput::minFrequency

The minimum central frequency in the bank (in Hz)

Definition at line 155 of file RingUtils.h.

◆ maxFrequency

REAL4 RingTemplateBankInput::maxFrequency

The minimum central frequency in the bank (in Hz)

Definition at line 156 of file RingUtils.h.

◆ maxMismatch

REAL4 RingTemplateBankInput::maxMismatch

The maximum mismatch allowed between templates in the bank.

Definition at line 157 of file RingUtils.h.

◆ templatePhase

REAL4 RingTemplateBankInput::templatePhase

The phase of the ringdown templates, in radians; Zero is a cosine-phase template; \(-\pi/2\) is a sine-phase template.

Definition at line 158 of file RingUtils.h.

◆ templateDistance

REAL4 RingTemplateBankInput::templateDistance

UNDOCUMENTED.

Definition at line 162 of file RingUtils.h.

◆ templateEpsilon

REAL4 RingTemplateBankInput::templateEpsilon

UNDOCUMENTED.

Definition at line 163 of file RingUtils.h.