-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
174 lines (165 loc) · 11.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Documentation — riroriro 1.0.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="riroriro Documentation" href="riroriro/index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="riroriro/index.html" title="riroriro Documentation"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">riroriro 1.0.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h1>
<p>This is the documentation for the functions of riroriro. Tutorials for the usage of these functions can be found at <a class="reference external" href="https://github.com/wvanzeist/riroriro_tutorials">https://github.com/wvanzeist/riroriro_tutorials</a></p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="riroriro/index.html">riroriro Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/index.html#reference-api">Reference/API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/inspiralfuns.html">inspiralfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#get-m-and-eta">get_M_and_eta</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#startx">startx</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#endx">endx</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#pnderiv">PNderiv</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#pn-parameter-integration">PN_parameter_integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#inspiral-time-conversion">inspiral_time_conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#inspiral-phase-freq-integration">inspiral_phase_freq_integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#radius-calculation">radius_calculation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#a1-a2-calculation">a1_a2_calculation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#inspiral-strain-polarisations">inspiral_strain_polarisations</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#inspiral-strain-amplitude">inspiral_strain_amplitude</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/inspiralfuns.html#list-size-reducer">list_size_reducer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/mergerfirstfuns.html">mergerfirstfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergerfirstfuns.html#quasi-normal-modes">quasi_normal_modes</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergerfirstfuns.html#girs-coefficients">gIRS_coefficients</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergerfirstfuns.html#merger-freq-calculation">merger_freq_calculation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergerfirstfuns.html#fhat-differentiation">fhat_differentiation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergerfirstfuns.html#merger-time-conversion">merger_time_conversion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/matchingfuns.html">matchingfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#mqdiff">MQdiff</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#min-switch-ind-finder">min_switch_ind_finder</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#final-i-index-finder">final_i_index_finder</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#time-offset-finder">time_offset_finder</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#time-frequency-stitching">time_frequency_stitching</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/matchingfuns.html#frequency-si-units">frequency_SI_units</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/mergersecondfuns.html">mergersecondfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#merger-phase-calculation">merger_phase_calculation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#phase-stitching">phase_stitching</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#merger-strain-amplitude">merger_strain_amplitude</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#amplitude-stitching">amplitude_stitching</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#merger-polarisations">merger_polarisations</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/mergersecondfuns.html#polarisation-stitching">polarisation_stitching</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/gwexporter.html">gwexporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/gwexporter.html#waveform-exporter">waveform_exporter</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/gwexporter.html#waveform-arrayer">waveform_arrayer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/snrcalculatorfuns.html">snrcalculatorfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#polynomial-redshift">polynomial_redshift</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#redshift-distance-adjustment">redshift_distance_adjustment</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#frequency-limits">frequency_limits</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#findchirp-fourier">findchirp_fourier</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#amplitude-interpolation">amplitude_interpolation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/snrcalculatorfuns.html#individual-detector-snr">individual_detector_SNR</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/horizondistfuns.html">horizondistfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/horizondistfuns.html#compact-snr-calculation">compact_SNR_calculation</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/horizondistfuns.html#horizon-distance-calculation">horizon_distance_calculation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/detectabilityfuns.html">detectabilityfuns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="riroriro/detectabilityfuns.html#cdf-generator">cdf_generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/detectabilityfuns.html#detectability-calculator">detectability_calculator</a></li>
<li class="toctree-l2"><a class="reference internal" href="riroriro/detectabilityfuns.html#specific-orientation-snr">specific_orientation_SNR</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="riroriro/tests.html">tests</a></li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h4>Next topic</h4>
<p class="topless"><a href="riroriro/index.html"
title="next chapter">riroriro Documentation</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="riroriro/index.html" title="riroriro Documentation"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">riroriro 1.0.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Documentation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2021, Wouter van Zeist.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
</div>
</body>
</html>