minke.distribution.
burst_dist
(minimum, maximum, size=1)[source]¶Generate an hrss drawn from the distribution [ r + 50/r ] as desired by the Burst group for observing MDCs
minke.distribution.
even_time
(start, stop, rate, jitter=0)[source]¶Produce an evenly-distributed set of times which has some jitter.
Parameters: |
|
---|---|
Returns: |
|
minke.distribution.
favorable_sky
(net, time)[source]¶Wander through the skies, searching for a most favorable location — draw extrinsic parameters as if the network antenna pattern magnitude were the PDF.
minke.distribution.
log_uniform
(lower, upper, number)[source]¶Draw uniformly in the log of a predefined range.
Parameters: |
|
---|---|
Returns: |
|
minke.distribution.
supernova_angle
(num, divisions=10)[source]¶Draw from a discrete distribution of angles.
minke.distribution.
uniform_dec
(num)[source]¶Declination distribution: uniform in sin(dec). num controls the number of draws.
minke.distribution.
uniform_interval
(interval, num)[source]¶Return a number, or a list of numbers which are sampled from a uniform distribution.
Parameters: |
|
---|---|
Returns: |
|
Notes
minke.distribution.
uniform_phi
(num)[source]¶Uniform in (0, 2pi) distribution. num controls the number of draws.
minke.distribution.
uniform_sky
(number=1)[source]¶Get a set of (RA, declination, polarization) randomized appopriately to astrophysical sources isotropically distributed in the sky.
88b d88 88 88 888b d888 “” 88 88`8b d8‘88 88 88 8b d8’ 88 88 8b,dPPYba, 88 ,d8 ,adPPYba, 88 `8b d8’ 88 88 88P’ `”8a 88 ,a8” a8P_____88 88 `8b d8’ 88 88 88 88 8888[ 8PP” 88 `888’ 88 88 88 88 88”Yba, “8b, ,aa 88 `8’ 88 88 88 88 88 `Y8a `”Ybbd8”’
This file is a part of Minke, a tool for generating simulated gravitational wave signals, used for characterising and training search algorithms.
Minke was created by Daniel Williams, based on work started by Chris Pankow and others, and is built around the LALSimulation library.
minke.mdctools.
Frame
(start, duration, ifo)[source]¶Represents a frame, in order to prepare the injection frames
Methods
generate_gwf (mdc, directory[, channel, …]) |
Produce the gwf file which corresponds to the MDC set over the period of this frame. |
get_rowlist (mdcs) |
Return the rows from an MDC set which correspond to this frame. |
calculate_n_injections | |
generate_log |
generate_gwf
(mdc, directory, channel='SCIENCE', force=False, rate=16384.0)[source]¶Produce the gwf file which corresponds to the MDC set over the period of this frame.
Parameters: |
|
---|
minke.mdctools.
FrameSet
(frame_list)[source]¶Methods
full_frameset (mdc, directory[, channel, force]) |
Produce the gwf files which corresponds to the MDC set over the period of the frames in this collection. |
full_logfile (mdc, location) |
Produce a log file for the entire frame set |
full_frameset
(mdc, directory, channel='SCIENCE', force=False)[source]¶Produce the gwf files which corresponds to the MDC set over the period of the frames in this collection.
Parameters: |
|
---|
minke.mdctools.
HWFrameSet
(ifos=['H1', 'L1'])[source]¶Methods
full_frameset (mdc, directory[, force]) |
Produce the gwf files which corresponds to the MDC set over the period of the frames in this collection. |
full_frameset
(mdc, directory, force=False)[source]¶Produce the gwf files which corresponds to the MDC set over the period of the frames in this collection.
Parameters: |
|
---|
minke.mdctools.
HWInj
(ifos)[source]¶Bases: minke.mdctools.Frame
Represents a hardware injection frame.
Injection frames must be an ASCII file of the hoft sampled at the antenna sampling rate, appropriately convolved with an antenna response function.
As a result of the simplicity of this specific output format we do not need information such as start-time in the file itself, however we should have a sensible naming scheme for the ASCII files since they will need to be produced as sidecars for an xml file.
Methods
generate_gwf (mdc, directory[, channel, …]) |
Produce the gwf file which corresponds to the MDC set over the period of this frame. |
generate_pcal (mdc, directory[, force, rate]) |
Produce the PCAL-ready hardware injection files as an ASCII list sampled at the detector’s sample rate. |
get_rowlist (mdcs) |
Return the rows from an MDC set which correspond to this frame. |
calculate_n_injections | |
generate_log |
generate_pcal
(mdc, directory, force=False, rate=16384)[source]¶Produce the PCAL-ready hardware injection files as an ASCII list sampled at the detector’s sample rate.
Parameters: |
|
---|
minke.mdctools.
MDCSet
(detectors, name='MDC Set')[source]¶Methods
directory_path () |
Generate the directory where the frames from this MDC should be stored, so, e.g. |
gravEn_row (row, frame) |
Produces a gravEn-style log row for a row of the simBurstTable. |
load_xml (filename[, full, start, stop]) |
Load the MDC Set from an XML file containing the SimBurstTable. |
plot_hist (parameter) |
Plot a histogram of a waveform parameter. |
plot_skymap () |
Plot a skymap of the injections distribution in RA and DEC on a Hammer projection. |
save_xml (filename) |
Save the MDC set as an XML SimBurstTable. |
directory_path
()[source]¶Generate the directory where the frames from this MDC should be stored, so, e.g. Gaussians 0d100 would go in “ga/ga0d100/”
Returns: |
|
---|
gravEn_row
(row, frame)[source]¶Produces a gravEn-style log row for a row of the simBurstTable.
Parameters: |
|
---|---|
Returns: |
|
hist_parameters
= {'BTLWNB': ['hrss', 'ra', 'dec'], 'Dimmelmeier+08': ['hrss', 'ra', 'dec'], 'Gaussian': ['hrss', 'psi', 'ra', 'dec'], 'SineGaussian': ['hrss', 'psi', 'ra', 'dec']}¶inj_families_abb
= {'ADI': 'adi', 'BTLWNB': 'wnb', 'Dimmelmeier+08': 'd08', 'Gaussian': 'ga', 'Mueller+12': 'm12', 'Ott+13': 'o13', 'Scheidegger+10': 's10', 'SineGaussian': 'sg'}¶inj_families_names
= {'adi': 'ADI', 'd08': 'Dimmelmeier+08', 'ga': 'Gaussian', 'm12': 'Mueller+12', 'o13': 'Ott+13', 's10': 'Scheidegger+10', 'sg': 'SineGaussian', 'wnb': 'BTLWNB'}¶load_xml
(filename, full=True, start=None, stop=None)[source]¶Load the MDC Set from an XML file containing the SimBurstTable.
Parameters: |
|
---|
plot_hist
(parameter)[source]¶Plot a histogram of a waveform parameter.
Parameters: |
|
---|---|
Returns: |
|
plot_skymap
()[source]¶Plot a skymap of the injections distribution in RA and DEC on a Hammer projection.
Returns: |
|
---|
save_xml
(filename)[source]¶Save the MDC set as an XML SimBurstTable.
Parameters: |
|
---|
waveforms
= []¶minke.sources.
ADI
(time, sky_dist=<function uniform_sky>, filepath='stamp_adi_a_tapered.mat', decomposed_path=None)[source]¶Bases: minke.sources.LongDuration
Accretion disk instability waveforms which are generated using the method described in LIGO-T1100093, at https://dcc.ligo.org/LIGO-T1100093. The waveforms are based off a model by MH van Putten,
M. H. van Putten, A. Levinson, H. K. Lee, T. Regimbau, M. Punturo, and G. M. Harry. Phys. Rev. D., 69(4), 044007, 2004. M. H. van Putten. Phys. Rev. Lett., 87(9), 091101, 2001.
The waveforms are stored in .mat binary files which can be read-in by SciPy.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of the ADI waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
decompose
(numrel_file, sample_rate=16384.0, step_back=0.01)[source]¶Produce the spherial harmonic decompositions of the ADI waveform. This is a special case since it is axisymmetric.
Parameters: |
|
---|---|
Returns: |
|
waveform
= 'ADI'¶minke.sources.
Dimmelmeier08
(time, sky_dist=<function uniform_sky>, filepath='signal_s15a2o05_ls.dat', decomposed_path=None)[source]¶Bases: minke.sources.Supernova
The Dimmelmeier08 waveform.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of the Dimmelmeier numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
decompose
(numrel_file, sample_rate=16384.0, step_back=0.01)[source]¶Produce the spherial harmonic decompositions of the Dimmelmeier numerical waveform. This is a special case since it is axisymmetric.
Parameters: |
|
---|---|
Returns: |
|
waveform
= 'Dimmelmeier+08'¶minke.sources.
Gaussian
(duration, hrss, time, sky_dist=<function uniform_sky>, seed=0)[source]¶Bases: minke.sources.Waveform
A class to represent a Gaussian injection.
Methods
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
waveform
= 'Gaussian'¶minke.sources.
LongDuration
[source]¶Bases: minke.sources.Supernova
A superclass to handle the spherial harmonic decompositions which long duration numerical relativity bursts may require.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of a numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
supernova
= True¶waveform
= 'LongDuration'¶minke.sources.
Mueller2012
(theta, phi, time, sky_dist=<function uniform_sky>, filepath=None, family='L15-3', decomposed_path=None)[source]¶Bases: minke.sources.Supernova
The Mueller2012 waveform.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of a numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
decompose
(numrel_file, sample_rate=16384.0, step_back=0.01)[source]¶Produce the spherial harmonic decompositions of a numerical waveform.
Parameters: |
|
---|---|
Returns: |
|
has_memory
= True¶waveform
= 'Mueller+12'¶minke.sources.
Ott2013
(theta, phi, time, sky_dist=<function uniform_sky>, distance=0.01, filepath=None, family='s27fheat1p05', decomposed_path=None)[source]¶Bases: minke.sources.Supernova
The Ott+2013 supernova waveform
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of a numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
waveform
= 'Ott+13'¶minke.sources.
Scheidegger2010
(theta, phi, time, sky_dist=<function uniform_sky>, filepath=None, family='R1E1CA_L', decomposed_path=None)[source]¶Bases: minke.sources.Supernova
The Scheidegger2010 waveform.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of a numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
waveform
= 'Scheidegger+10'¶minke.sources.
SineGaussian
(q, frequency, hrss, polarisation, time, sky_dist=<function uniform_sky>, seed=0)[source]¶Bases: minke.sources.Waveform
A class to represent a SineGaussian injection.
Methods
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
waveform
= 'SineGaussian'¶minke.sources.
Supernova
[source]¶Bases: minke.sources.Waveform
A superclass to handle the spherial harmonic decompositions which all supernova waveforms require.
Methods
construct_Hlm (Ixx, Ixy, Ixz, Iyy, Iyz, Izz) |
Construct the expansion parameters Hlm from T1000553. |
decompose (numrel_file[, sample_rate, step_back]) |
Produce the spherial harmonic decompositions of a numerical waveform. |
generate_tail ([sampling, length, h_max]) |
Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform. |
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
construct_Hlm
(Ixx, Ixy, Ixz, Iyy, Iyz, Izz, l=2, m=2)[source]¶Construct the expansion parameters Hlm from T1000553. Returns the expansion parameters for l=2, m=m
decompose
(numrel_file, sample_rate=16384.0, step_back=0.01)[source]¶Produce the spherial harmonic decompositions of a numerical waveform.
Parameters: |
|
---|---|
Returns: |
|
file_distance
= 0.01¶generate_tail
(sampling=16384.0, length=1, h_max=1e-23)[source]¶Generate a “low frequency tail” to append to the end of the waveform to overcome problems related to memory in the waveform.
This code was adapted from an iPython notebook provided by Marek Szczepanczyk.
The tail needs to be added to the waveform after all of the other corrections have been applied (DW: I think)
Parameters: |
|
---|
Notes
convolved with the antenna pattern.
supernova
= True¶waveform
= 'Supernova'¶minke.sources.
Waveform
[source]¶Bases: object
Generic container for different source types. Currently, it checks for the waveform type and initializes itself appropriately. In the future, different sources should subclass this and override the generation routines.
Methods
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
expnum
= 1¶numrel_data
= []¶parse_polarisation
(polarisation)[source]¶Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle.
Parameters: |
|
---|
sim
= []¶waveform
= 'Generic'¶minke.sources.
WhiteNoiseBurst
(duration, bandwidth, frequency, time, hrss=None, egw=None, sky_dist=<function uniform_sky>, seed=0)[source]¶Bases: minke.sources.Waveform
A class to represent a WNB injection.
Methods
interpolate (x_old, y_old, x_new) |
Convenience funtion to avoid repeated code |
parse_polarisation (polarisation) |
Convert a string description of a polarisation to an ellipse eccentricity and an ellipse angle. |
plot () |
Produce a plot of the injection. |
waveform
= 'BTLWNB'¶