Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInspiral 5.0.3.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Header InspiralInjectionParams.h

Detailed Description

Module for generating randomly distributed inspiral parameters.

Author
D. Brown, J. Creighton, S. Fairhurst, G. Jones, E. Messaritaki

Prototypes

SimInspiralTableXLALRandomInspiralTime (SimInspiralTable *inj, RandomParams *randParams, LIGOTimeGPS startTime, REAL4 timeWindow)
 Generates the geocent_end_time for an inspiral injection, based on the given startTime and timeWindow. More...
 
SimInspiralTableXLALRandomInspiralDistance (SimInspiralTable *inj, RandomParams *randParams, LoudnessDistribution dDist, REAL4 distMin, REAL4 distMax)
 Generates the distance for an inspiral injection, based on the requested distribution and max/min distances. More...
 
SimInspiralTableXLALRandomInspiralSkyLocation (SimInspiralTable *inj, RandomParams *randParams)
 Generates a random sky location (right ascension=longitude, delta=latitude) for an inspiral injection. More...
 
void XLALRandomInspiralMilkywayLocation (REAL8 *rightAscension, REAL8 *declination, REAL8 *distance, RandomParams *randParams)
 Generates a location within the Milky Way for an inspiral injection. More...
 
SimInspiralTableXLALRandomInspiralOrientation (SimInspiralTable *inj, RandomParams *randParams, InclDistribution iDist, REAL4 inclinationPeak)
 Generates a random orientation (polarization, inclination, coa_phase) for an inspiral injection. More...
 
SimInspiralTableXLALm1m2SquareGridInspiralMasses (SimInspiralTable *inj, REAL4 mass1Min, REAL4 mass2Min, REAL4 minTotalMass, REAL4 maxTotalMass, REAL4 mass1Delta, REAL4 mass2Delta, INT4 mass1Pnt, INT4 mass2Pnt, INT4 injNum, INT4 *count)
 Places component masses on a square grid for an inspiral injection. More...
 
SimInspiralTableXLALFixedInspiralMasses (SimInspiralTable *inj, REAL4 mass1Fix, REAL4 mass2Fix)
 Set masses to fixed values for an inspiral injection. More...
 
SimInspiralTableXLALRandomInspiralMasses (SimInspiralTable *inj, RandomParams *randParams, MassDistribution mDistr, REAL4 mass1Min, REAL4 mass1Max, REAL4 mass2Min, REAL4 mass2Max, REAL4 minTotalMass, REAL4 maxTotalMass)
 Generates random masses for an inspiral injection. More...
 
SimInspiralTableXLALGaussianInspiralMasses (SimInspiralTable *inj, RandomParams *randParams, REAL4 mass1Min, REAL4 mass1Max, REAL4 mass1Mean, REAL4 mass1Std, REAL4 mass2Min, REAL4 mass2Max, REAL4 mass2Mean, REAL4 mass2Std)
 Generates masses for an inspiral injection. More...
 
SimInspiralTableXLALRandomInspiralTotalMassRatio (SimInspiralTable *inj, RandomParams *randParams, MassDistribution mDist, REAL4 minTotalMass, REAL4 maxTotalMass, REAL4 minMassRatio, REAL4 maxMassRatio)
 Generates masses for an inspiral injection. More...
 
SimInspiralTableXLALRandomInspiralTotalMassFraction (SimInspiralTable *inj, RandomParams *randParams, MassDistribution mDist, REAL4 minTotalMass, REAL4 maxTotalMass, REAL4 minMassRatio, REAL4 maxMassRatio)
 Generates masses for an inspiral injection. More...
 
SimInspiralTableXLALRandomInspiralSpins (SimInspiralTable *inj, RandomParams *randParams, REAL4 spin1Min, REAL4 spin1Max, REAL4 spin2Min, REAL4 spin2Max, REAL4 kappa1Min, REAL4 kappa1Max, REAL4 abskappa1Min, REAL4 abskappa1Max, AlignmentType alignInj, SpinDistribution distribution, REAL4 spin1Mean, REAL4 spin1Std, REAL4 spin2Mean, REAL4 spin2Std)
 Generates spins for an inspiral injection. More...
 
SimInspiralTableXLALRandomNRInjectTotalMass (SimInspiralTable *inj, RandomParams *randParams, REAL4 minTotalMass, REAL4 maxTotalMass, SimInspiralTable *nrInjParams)
 Generates random masses for an inspiral injection. More...
 
SimInspiralTableXLALInspiralSiteTimeAndDist (SimInspiralTable *inj, const LALDetector *detector, LIGOTimeGPS *endTime, REAL4 *effDist)
 Set end time and effective distance of an injection for a detector. More...
 
SimInspiralTableXLALPopulateSimInspiralSiteInfo (SimInspiralTable *inj)
 Set the end time and effective distance for all detectors for this injection. More...
 
COMPLEX8FrequencySeriesgenerateActuation (COMPLEX8FrequencySeries *resp, REAL4 ETMcal, REAL4 pendF, REAL4 pendQ)
 Populate a frequency series with the actuation response. More...
 

Enumerations

enum  lalinspiral_time_distribution {
  LALINSPIRAL_UNKNOWN_TIME_DIST , LALINSPIRAL_FIXED_TIME_DIST , LALINSPIRAL_UNIFORM_TIME_DIST , LALINSPIRAL_EXPONENTIAL_TIME_DIST ,
  LALINSPIRAL_FILE_TIME_DIST
}
 enum containing the different ways in which the time step to injections can be distributed More...
 
enum  LoudnessDistribution {
  unknownLoudnessDist , distFromSourceFile , uniformDistance , uniformDistanceSquared ,
  uniformLogDistance , uniformVolume , starFormationRate , uniformSnr ,
  uniformLogSnr , uniformVolumeSnr
}
 enum containing the different ways in which the loudness of injections can be distributed More...
 
enum  SkyLocationDistribution {
  unknownLocationDist , locationFromSourceFile , locationFromExttrigFile , uniformSkyLocation ,
  fixedSkyLocation , locationFromIPNFile
}
 enum containing the different ways in which the sky location of injections can be distributed More...
 
enum  MassDistribution {
  unknownMassDist , massFromSourceFile , massFromNRFile , uniformTotalMass ,
  uniformComponentMass , logComponentMass , gaussianMassDist , uniformTotalMassRatio ,
  logMassUniformTotalMassRatio , m1m2SquareGrid , fixMasses , uniformTotalMassFraction
}
 enum containing the different ways in which the masses of injections can be distributed More...
 
enum  InclDistribution { unknownInclDist , uniformInclDist , gaussianInclDist , fixedInclDist }
 enum containing the different ways in which the inclinations of injections can be distributed More...
 
enum  SpinDistribution { unknownSpinDist , uniformSpinDist , gaussianSpinDist }
 enum containing the different ways in which the spin magnitudes of injections can be distributed More...
 
enum  AlignmentType { alongzAxis , inxzPlane , notAligned }
 enum for two distinct ways a spin-aligned injection is realized depending on the waveform family More...
 

Function Documentation

◆ XLALRandomInspiralTime()

SimInspiralTable * XLALRandomInspiralTime ( SimInspiralTable inj,
RandomParams randParams,
LIGOTimeGPS  startTime,
REAL4  timeWindow 
)

Generates the geocent_end_time for an inspiral injection, based on the given startTime and timeWindow.

Parameters
injinjection for which time will be set
randParamsrandom parameter details
startTimethe first time that the injection could be
timeWindowthe time window within which inj must occur

Definition at line 49 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralDistance()

SimInspiralTable * XLALRandomInspiralDistance ( SimInspiralTable inj,
RandomParams randParams,
LoudnessDistribution  dDist,
REAL4  distMin,
REAL4  distMax 
)

Generates the distance for an inspiral injection, based on the requested distribution and max/min distances.

Parameters
injinjection for which distance will be set
randParamsrandom parameter details
dDistrequested distance distribution
distMinminimum distance (Mpc)
distMaxmaximum distance (Mpc)

Definition at line 69 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralSkyLocation()

SimInspiralTable * XLALRandomInspiralSkyLocation ( SimInspiralTable inj,
RandomParams randParams 
)

Generates a random sky location (right ascension=longitude, delta=latitude) for an inspiral injection.

Parameters
injinjection for which sky location will be set
randParamsrandom parameter details

Definition at line 122 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralMilkywayLocation()

void XLALRandomInspiralMilkywayLocation ( REAL8 rightAscension,
REAL8 declination,
REAL8 distance,
RandomParams randParams 
)

Generates a location within the Milky Way for an inspiral injection.

Parameters
rightAscensionright ascension of the milky-way source
declinationdeclination of the milky-way source
distancedistance to the milky-way source
randParamsrandom parameter details

Definition at line 137 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralOrientation()

SimInspiralTable * XLALRandomInspiralOrientation ( SimInspiralTable inj,
RandomParams randParams,
InclDistribution  iDist,
REAL4  inclinationPeak 
)

Generates a random orientation (polarization, inclination, coa_phase) for an inspiral injection.

If inclinationPeak is non-zero, then peak the inclination around o with width inclinationPeak

Parameters
injinjection for which orientation will be set
randParamsrandom parameter details
iDistrequested inclination distribution
inclinationPeakwidth of the peak of the inclination

Definition at line 189 of file InspiralInjectionParams.c.

◆ XLALm1m2SquareGridInspiralMasses()

SimInspiralTable * XLALm1m2SquareGridInspiralMasses ( SimInspiralTable inj,
REAL4  mass1Min,
REAL4  mass2Min,
REAL4  minTotalMass,
REAL4  maxTotalMass,
REAL4  mass1Delta,
REAL4  mass2Delta,
INT4  mass1Pnt,
INT4  mass2Pnt,
INT4  injNum,
INT4 count 
)

Places component masses on a square grid for an inspiral injection.

Parameters
injinjection for which masses will be set
mass1Minminimum mass for first component
mass2Minminimum mass for second component
minTotalMassminimum total mass of binary
maxTotalMassmaximum total mass of binary
mass1Deltam1 grid spacing
mass2Deltam2 grid spacing
mass1Pntnumber of grid points along m1
mass2Pntnumber of grid points along m2
injNuminjection number
countunsuccessful injection counter

Definition at line 213 of file InspiralInjectionParams.c.

◆ XLALFixedInspiralMasses()

SimInspiralTable * XLALFixedInspiralMasses ( SimInspiralTable inj,
REAL4  mass1Fix,
REAL4  mass2Fix 
)

Set masses to fixed values for an inspiral injection.

Parameters
injinjection for which masses will be set
mass1Fixfixed mass of first component
mass2Fixfixed mass of second component

Definition at line 247 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralMasses()

SimInspiralTable * XLALRandomInspiralMasses ( SimInspiralTable inj,
RandomParams randParams,
MassDistribution  mDistr,
REAL4  mass1Min,
REAL4  mass1Max,
REAL4  mass2Min,
REAL4  mass2Max,
REAL4  minTotalMass,
REAL4  maxTotalMass 
)

Generates random masses for an inspiral injection.

Parameters
injinjection for which masses will be set
randParamsrandom parameter details
mDistrthe mass distribution to use
mass1Minminimum mass for first component
mass1Maxmaximum mass for first component
mass2Minminimum mass for second component
mass2Maxmaximum mass for second component
minTotalMassminimum total mass of binaty
maxTotalMassmaximum total mass of binary

Definition at line 265 of file InspiralInjectionParams.c.

◆ XLALGaussianInspiralMasses()

SimInspiralTable * XLALGaussianInspiralMasses ( SimInspiralTable inj,
RandomParams randParams,
REAL4  mass1Min,
REAL4  mass1Max,
REAL4  mass1Mean,
REAL4  mass1Std,
REAL4  mass2Min,
REAL4  mass2Max,
REAL4  mass2Mean,
REAL4  mass2Std 
)

Generates masses for an inspiral injection.

Masses are Gaussian distributed with the requested mean and standard deviation.

Parameters
injinjection for which masses will be set
randParamsrandom parameter details
mass1Minminimum mass for first component
mass1Maxmaximum mass for first component
mass1Meanmean value for mass1
mass1Stdstandard deviation of mass1
mass2Minminimum mass for second component
mass2Maxmaximum mass for second component
mass2Meanmean value of mass2
mass2Stdstandard deviation of mass2

Definition at line 326 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralTotalMassRatio()

SimInspiralTable * XLALRandomInspiralTotalMassRatio ( SimInspiralTable inj,
RandomParams randParams,
MassDistribution  mDist,
REAL4  minTotalMass,
REAL4  maxTotalMass,
REAL4  minMassRatio,
REAL4  maxMassRatio 
)

Generates masses for an inspiral injection.

Total mass and mass ratio are uniformly distributed

Parameters
injinjection for which masses will be set
randParamsrandom parameter details
mDistthe mass distribution to use
minTotalMassminimum total mass of binary
maxTotalMassmaximum total mass of binary
minMassRatiominimum mass ratio
maxMassRatiomaximum mass ratio

Definition at line 365 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralTotalMassFraction()

SimInspiralTable * XLALRandomInspiralTotalMassFraction ( SimInspiralTable inj,
RandomParams randParams,
MassDistribution  mDist,
REAL4  minTotalMass,
REAL4  maxTotalMass,
REAL4  minMassRatio,
REAL4  maxMassRatio 
)

Generates masses for an inspiral injection.

Total mass and mass fraction m1 / M are uniformly distributed

Parameters
injinjection for which masses will be set
randParamsrandom parameter details
mDistthe mass distribution to use
minTotalMassminimum total mass of binary
maxTotalMassmaximum total mass of binary
minMassRatiominimum mass ratio
maxMassRatiomaximum mass ratio

Definition at line 407 of file InspiralInjectionParams.c.

◆ XLALRandomInspiralSpins()

SimInspiralTable * XLALRandomInspiralSpins ( SimInspiralTable inj,
RandomParams randParams,
REAL4  spin1Min,
REAL4  spin1Max,
REAL4  spin2Min,
REAL4  spin2Max,
REAL4  kappa1Min,
REAL4  kappa1Max,
REAL4  abskappa1Min,
REAL4  abskappa1Max,
AlignmentType  alignInj,
SpinDistribution  distribution,
REAL4  spin1Mean,
REAL4  spin1Std,
REAL4  spin2Mean,
REAL4  spin2Std 
)

Generates spins for an inspiral injection.

Spin magnitudes lie between the specified max and min values.

The parameter alignInj controls whether spins are aligned with the orbital angular momentum according to two separate coordinate conventions (along z-axis as for IMRPhenom, or in x-z plane as for SpinTaylor).

For single-spin-like systems as treated in the 'PTF' paper (Pan, Buonanno, Chen and Vallisneri, gr-qc/03100034) the component of spin1 along the direction of orbital angular momentum (where m1>m2) is specified by the kappa1 bounds.

Otherwise, orientations for spin1 and spin2 are random.

Parameters
injinjection for which spins will be set
randParamsrandom parameter details
spin1Minminimum magnitude of spin1
spin1Maxmaximum magnitude of spin1
spin2Minminimum magnitude of spin2
spin2Maxmaximum magnitude of spin2
kappa1Minminimum value of spin1 . L_N
kappa1Maxmaximum value of spin1 . L_N
abskappa1Minminimum absolute value of spin1 . L_N
abskappa1Maxmaximum absolute value of spin1 . L_N
alignInjchoice of convention for aligned spins
distributionthe spin magnitude distribution to use
spin1Meanmean value for |spin1| gaussian
spin1Stdstandard deviation for |spin1|
spin2Meanmean value for |spin2| gaussian
spin2Stdstandard deviation for |spin2|

Definition at line 456 of file InspiralInjectionParams.c.

◆ XLALRandomNRInjectTotalMass()

SimInspiralTable * XLALRandomNRInjectTotalMass ( SimInspiralTable inj,
RandomParams randParams,
REAL4  minTotalMass,
REAL4  maxTotalMass,
SimInspiralTable nrInjParams 
)

Generates random masses for an inspiral injection.

Parameters
injinjection for which masses will be set
randParamsrandom parameter details
minTotalMassminimum total mass of binary
maxTotalMassmaximum total mass of binary
nrInjParamsparameters of NR injection

Definition at line 635 of file InspiralInjectionParams.c.

◆ XLALInspiralSiteTimeAndDist()

SimInspiralTable * XLALInspiralSiteTimeAndDist ( SimInspiralTable inj,
const LALDetector detector,
LIGOTimeGPS endTime,
REAL4 effDist 
)

Set end time and effective distance of an injection for a detector.

Parameters
injthe injection details
detectorthe detector of interest
endTimethe end time to populate
effDistthe effective distance to populate

Definition at line 672 of file InspiralInjectionParams.c.

◆ XLALPopulateSimInspiralSiteInfo()

SimInspiralTable * XLALPopulateSimInspiralSiteInfo ( SimInspiralTable inj)

Set the end time and effective distance for all detectors for this injection.

Parameters
injthe injection

Definition at line 709 of file InspiralInjectionParams.c.

◆ generateActuation()

COMPLEX8FrequencySeries * generateActuation ( COMPLEX8FrequencySeries resp,
REAL4  ETMcal,
REAL4  pendF,
REAL4  pendQ 
)

Populate a frequency series with the actuation response.

Here, we just use the pendulum part of the actuation function

Definition at line 754 of file InspiralInjectionParams.c.

Enumeration Type Documentation

◆ lalinspiral_time_distribution

enum containing the different ways in which the time step to injections can be distributed

Enumerator
LALINSPIRAL_UNKNOWN_TIME_DIST 
LALINSPIRAL_FIXED_TIME_DIST 
LALINSPIRAL_UNIFORM_TIME_DIST 
LALINSPIRAL_EXPONENTIAL_TIME_DIST 
LALINSPIRAL_FILE_TIME_DIST 

Definition at line 34 of file InspiralInjectionParams.h.

◆ LoudnessDistribution

enum containing the different ways in which the loudness of injections can be distributed

Enumerator
unknownLoudnessDist 
distFromSourceFile 
uniformDistance 
uniformDistanceSquared 
uniformLogDistance 
uniformVolume 
starFormationRate 
uniformSnr 
uniformLogSnr 
uniformVolumeSnr 

Definition at line 49 of file InspiralInjectionParams.h.

◆ SkyLocationDistribution

enum containing the different ways in which the sky location of injections can be distributed

Enumerator
unknownLocationDist 
locationFromSourceFile 
locationFromExttrigFile 
uniformSkyLocation 
fixedSkyLocation 
locationFromIPNFile 

Definition at line 69 of file InspiralInjectionParams.h.

◆ MassDistribution

enum containing the different ways in which the masses of injections can be distributed

Enumerator
unknownMassDist 
massFromSourceFile 
massFromNRFile 
uniformTotalMass 
uniformComponentMass 
logComponentMass 
gaussianMassDist 
uniformTotalMassRatio 
logMassUniformTotalMassRatio 
m1m2SquareGrid 
fixMasses 
uniformTotalMassFraction 

Definition at line 85 of file InspiralInjectionParams.h.

◆ InclDistribution

enum containing the different ways in which the inclinations of injections can be distributed

Enumerator
unknownInclDist 
uniformInclDist 
gaussianInclDist 
fixedInclDist 

Definition at line 107 of file InspiralInjectionParams.h.

◆ SpinDistribution

enum containing the different ways in which the spin magnitudes of injections can be distributed

Enumerator
unknownSpinDist 
uniformSpinDist 
gaussianSpinDist 

Definition at line 121 of file InspiralInjectionParams.h.

◆ AlignmentType

enum for two distinct ways a spin-aligned injection is realized depending on the waveform family

Enumerator
alongzAxis 
inxzPlane 
notAligned 

Definition at line 134 of file InspiralInjectionParams.h.