InspiralInjectionParams.c File Reference

Author:
D.Functions for generating random distributions of inspiral parameters for injection purposes
More...

#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <lal/LALStdlib.h>
#include <lal/LALStdio.h>
#include <lal/LIGOMetadataTables.h>
#include <lal/LIGOMetadataUtils.h>
#include <lal/Date.h>
#include <lal/SkyCoordinates.h>
#include <lal/GeneratePPNInspiral.h>
#include <lal/DetectorSite.h>
#include <lal/DetResponse.h>
#include <lal/TimeDelay.h>
#include <lal/InspiralInjectionParams.h>

Include dependency graph for InspiralInjectionParams.c:

Go to the source code of this file.

Functions

 NRCSID (INSPIRALINJECTIONPARAMSC,"$Id: InspiralInjectionParams.c,v 1.13 2008/07/03 23:59:53 dfazi Exp $")
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.
SimInspiralTableXLALRandomInspiralDistance (SimInspiralTable *inj, RandomParams *randParams, DistanceDistribution dDist, REAL4 distMin, REAL4 distMax)
 Generates the distance for an inspiral injection, based on the requested distribution and max/min distances.
SimInspiralTableXLALRandomInspiralSkyLocation (SimInspiralTable *inj, RandomParams *randParams)
 Generates a random sky location (right ascension=longitude, delta=latitude) for an inspiral injection.
void XLALRandomInspiralMilkywayLocation (REAL8 *rightAscension, REAL8 *declination, REAL8 *distance, RandomParams *randParams)
 Generates a location within the Milky Way for an inspiral injection.
SimInspiralTableXLALRandomInspiralOrientation (SimInspiralTable *inj, RandomParams *randParams, InclDistribution iDist, REAL4 inclinationPeak)
 Generates a random orientation (polarization, inclination, coa_phase) for an inspiral injection.
SimInspiralTableXLALRandomInspiralMasses (SimInspiralTable *inj, RandomParams *randParams, MassDistribution mDist, REAL4 mass1Min, REAL4 mass1Max, REAL4 mass2Min, REAL4 mass2Max, REAL4 minTotalMass, REAL4 maxTotalMass)
 Generates random masses for an inspiral injection.
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.
SimInspiralTableXLALRandomInspiralTotalMassRatio (SimInspiralTable *inj, RandomParams *randParams, REAL4 minTotalMass, REAL4 maxTotalMass, REAL4 minMassRatio, REAL4 maxMassRatio)
SimInspiralTableXLALRandomInspiralSpins (SimInspiralTable *inj, RandomParams *randParams, REAL4 spin1Min, REAL4 spin1Max, REAL4 spin2Min, REAL4 spin2Max, REAL4 kappa1Min, REAL4 kappa1Max, REAL4 abskappa1Min, REAL4 abskappa1Max)
 Generates spins for an inspiral injection.
SimInspiralTableXLALRandomNRInjectTotalMass (SimInspiralTable *inj, RandomParams *randParams, REAL4 minTotalMass, REAL4 maxTotalMass, SimInspiralTable *nrInjParams)
 Generates random masses for an inspiral injection.
SimInspiralTableXLALInspiralSiteTimeAndDist (SimInspiralTable *inj, LALDetector *detector, LIGOTimeGPS *endTime, REAL4 *effDist)
 Set end time and effective distance of an injection for a detector.
SimInspiralTableXLALPopulateSimInspiralSiteInfo (SimInspiralTable *inj)
 Set the end time and effective distance for all detectors for this injection.
COMPLEX8FrequencySeriesgenerateActuation (COMPLEX8FrequencySeries *resp, REAL4 ETMcal, REAL4 pendF, REAL4 pendQ)
 Populate a frequency series with the actuation response.


Detailed Description

Author:
D.Functions for generating random distributions of inspiral parameters for injection purposes

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

Id
InspiralInjectionParams.c,v 1.13 2008/07/03 23:59:53 dfazi Exp

Definition in file InspiralInjectionParams.c.


Function Documentation

NRCSID ( INSPIRALINJECTIONPARAMSC  ,
"$Id: InspiralInjectionParams.  c,
v 1.13 2008/07/03 23:59:53 dfazi Exp $"   
)

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:
inj  injection for which time will be set
randParams  random parameter details
startTime  the first time that the injection could be
timeWindow  the time window within which inj must occur

Definition at line 50 of file InspiralInjectionParams.c.

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

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

Parameters:
inj  injection for which distance will be set
randParams  random parameter details
dDist  requested distance distribution
distMin  minimum distance (Mpc)
distMax  maximum distance (Mpc)

Definition at line 68 of file InspiralInjectionParams.c.

SimInspiralTable* XLALRandomInspiralSkyLocation ( SimInspiralTable inj,
RandomParams randParams 
)

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

Parameters:
inj  injection for which sky location will be set
randParams  random parameter details

Definition at line 108 of file InspiralInjectionParams.c.

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

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

Parameters:
rightAscension  right ascension of the milky-way source
declination  declination of the milky-way source
distance  distance to the milky-way source
randParams  random parameter details

Definition at line 120 of file InspiralInjectionParams.c.

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:
inj  injection for which orientation will be set
randParams  random parameter details
iDist  requested inclination distribution
inclinationPeak  width of the peak of the inclination

Definition at line 171 of file InspiralInjectionParams.c.

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

Generates random masses for an inspiral injection.

Parameters:
inj  injection for which masses will be set
randParams  random parameter details
mDist  the mass distribution to use
mass1Min  minimum mass for first component
mass1Max  maximum mass for first component
mass2Min  minimum mass for second component
mass2Max  maximum mass for second component
minTotalMass  minimum total mass of binaty
maxTotalMass  maximum total mass of binary

Definition at line 195 of file InspiralInjectionParams.c.

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:
inj  injection for which masses will be set
randParams  random parameter details
mass1Min  minimum mass for first component
mass1Max  maximum mass for first component
mass1Mean  mean value for mass1
mass1Std  standard deviation of mass1
mass2Min  minimum mass for second component
mass2Max  maximum mass for second component
mass2Mean  mean value of mass2
mass2Std  standard deviation of mass2

Definition at line 254 of file InspiralInjectionParams.c.

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

Parameters:
inj  injection for which masses will be set
randParams  random parameter details
minTotalMass  minimum total mass of binary
maxTotalMass  maximum total mass of binary
minMassRatio  minimum mass ratio
maxMassRatio  maximum mass ratio

Definition at line 291 of file InspiralInjectionParams.c.

SimInspiralTable* XLALRandomInspiralSpins ( SimInspiralTable inj,
RandomParams randParams,
REAL4  spin1Min,
REAL4  spin1Max,
REAL4  spin2Min,
REAL4  spin2Max,
REAL4  kappa1Min,
REAL4  kappa1Max,
REAL4  abskappa1Min,
REAL4  abskappa1Max 
)

Generates spins for an inspiral injection.

Spin magnitudes lie between the specified max and min values. Orientation for spin1 can be constrained by the specified values of kappa1, otherwise are random. Orientation for spin2 are random

Parameters:
inj  injection for which spins will be set
randParams  random parameter details
spin1Min  minimum magnitude of spin1
spin1Max  maximum magnitude of spin1
spin2Min  minimum magnitude of spin2
spin2Max  maximum magnitude of spin2

Definition at line 319 of file InspiralInjectionParams.c.

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

Generates random masses for an inspiral injection.

Parameters:
inj  injection for which masses will be set
randParams  random parameter details
minTotalMass  minimum total mass of binaty
maxTotalMass  maximum total mass of binary
nrInjParams  parameters of NR injection

Definition at line 415 of file InspiralInjectionParams.c.

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

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

Parameters:
inj  the injection details
detector  the detector of interest
endTime  the end time to populate
effDist  the effective distance to populate

Definition at line 453 of file InspiralInjectionParams.c.

SimInspiralTable* XLALPopulateSimInspiralSiteInfo ( SimInspiralTable inj  ) 

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

Parameters:
inj  the injection

Definition at line 490 of file InspiralInjectionParams.c.

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 534 of file InspiralInjectionParams.c.


Generated on Thu Aug 28 03:13:27 2008 for LAL by  doxygen 1.5.2