docs update for move

mikekatz04 · Mar 22, 2024 · fe7287e · fe7287e
1 parent 01c54a5
commit fe7287e
Show file tree

Hide file tree

Showing 17 changed files with 592 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/mikekatz04/BBHx/tags).
 
-Current Version: 1.0.7
+Current Version: 1.0.8
 
 ## Authors
 

diff --git a/bbhx/likelihood.py b/bbhx/likelihood.py
@@ -253,7 +253,9 @@ class HeterodynedLikelihood:
     `arXiv:2109.02728 <https://arxiv.org/abs/2109.02728>`_. We implement the method
     as described in `arXiv:1806.08792 <https://arxiv.org/abs/1806.08792>`_.
 
-    This class also works with higher order harmonic modes. TODO: fill in.
+    This class also works with higher order harmonic modes, but it has not been tested extensivally.
+    It only does a direct summation over the modes rather than heterodyning per mode. So, it is less reliable,
+    but in practice it produces a solid posterior distribution.
 
     This class has GPU capabilities.
 

diff --git a/docs/doctrees/README.doctree b/docs/doctrees/README.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/user/like.doctree b/docs/doctrees/user/like.doctree
diff --git a/docs/html/README.html b/docs/html/README.html
@@ -259,7 +259,7 @@ <h3>Versioning<a class="headerlink" href="#versioning" title="Link to this headi
 <p>We use <a class="reference external" href="http://semver.org/">SemVer</a> for versioning. For the versions
 available, see the <a class="reference external" href="https://github.com/mikekatz04/BBHx/tags">tags on this
 repository</a>.</p>
-<p>Current Version: 1.0.7</p>
+<p>Current Version: 1.0.8</p>
 </section>
 <section id="authors">
 <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>

diff --git a/docs/html/_sources/README.rst.txt b/docs/html/_sources/README.rst.txt
@@ -191,7 +191,7 @@ We use `SemVer <http://semver.org/>`__ for versioning. For the versions
 available, see the `tags on this
 repository <https://github.com/mikekatz04/BBHx/tags>`__.
 
-Current Version: 1.0.7
+Current Version: 1.0.8
 
 Authors
 -------

diff --git a/docs/html/_sources/user/like.rst.txt b/docs/html/_sources/user/like.rst.txt
@@ -8,3 +8,11 @@ Direct Likelihood Computation
     :members:
     :show-inheritance:
     :inherited-members:
+
+Heterodyned Likelihood Computation
+*************************************
+
+.. autoclass:: bbhx.likelihood.HeterodynedLikelihood
+    :members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -96,6 +96,7 @@ <h1 id="index">Index</h1>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
+ | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
@@ -193,15 +194,17 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.c3_dm">c3_dm (bbhx.waveforms.phenomhm.PhenomHMAmpPhase attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.c3_rd">c3_rd (bbhx.waveforms.phenomhm.PhenomHMAmpPhase attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="user/utils.html#bbhx.utils.interpolate.CubicSplineInterpolant.c3_shaped">c3_shaped (bbhx.utils.interpolate.CubicSplineInterpolant property)</a>
 </li>
-      <li><a href="user/response.html#bbhx.response.fastfdresponse.LISATDIResponse.citation">citation (bbhx.response.fastfdresponse.LISATDIResponse property)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.citation">citation (bbhx.likelihood.HeterodynedLikelihood property)</a>
 
       <ul>
+        <li><a href="user/response.html#bbhx.response.fastfdresponse.LISATDIResponse.citation">(bbhx.response.fastfdresponse.LISATDIResponse property)</a>
+</li>
         <li><a href="user/main.html#bbhx.waveformbuild.BBHWaveformFD.citation">(bbhx.waveformbuild.BBHWaveformFD property)</a>
 </li>
         <li><a href="user/utils.html#bbhx.waveformbuild.TemplateInterpFD.citation">(bbhx.waveformbuild.TemplateInterpFD property)</a>
@@ -219,22 +222,30 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.d">d (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
       <li><a href="user/like.html#bbhx.likelihood.Likelihood.d_d">d_d (bbhx.likelihood.Likelihood attribute)</a>
 </li>
       <li><a href="user/like.html#bbhx.likelihood.Likelihood.data_channels">data_channels (bbhx.likelihood.Likelihood attribute)</a>
 </li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.data_freqs">data_freqs (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.data_constants">data_constants (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.Likelihood.data_freqs">data_freqs (bbhx.likelihood.Likelihood attribute)</a>
+</li>
       <li><a href="user/main.html#bbhx.waveformbuild.BBHWaveformFD.data_length">data_length (bbhx.waveformbuild.BBHWaveformFD attribute)</a>
 
       <ul>
         <li><a href="user/utils.html#bbhx.waveformbuild.TemplateInterpFD.data_length">(bbhx.waveformbuild.TemplateInterpFD attribute)</a>
 </li>
       </ul></li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.data_stream_length">data_stream_length (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.data_stream_length">data_stream_length (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+
+      <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.data_stream_length">(bbhx.likelihood.Likelihood attribute)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -253,10 +264,18 @@ <h2 id="E">E</h2>
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.freqs">freqs (bbhx.waveforms.phenomhm.PhenomHMAmpPhase property)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.f_dense">f_dense (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.f_m">f_m (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.freqs">freqs (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+
+      <ul>
+        <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.freqs">(bbhx.waveforms.phenomhm.PhenomHMAmpPhase property)</a>
+</li>
+      </ul></li>
       <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.freqs_shaped">freqs_shaped (bbhx.waveforms.phenomhm.PhenomHMAmpPhase property)</a>
 </li>
   </ul></td>
@@ -265,7 +284,29 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.get_ll">get_ll() (bbhx.likelihood.Likelihood method)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.get_ll">get_ll() (bbhx.likelihood.HeterodynedLikelihood method)</a>
+
+      <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.get_ll">(bbhx.likelihood.Likelihood method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.h0_sparse">h0_sparse (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.h_sparse">h_sparse (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.hdyn_d_h">hdyn_d_h (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.hdyn_h_h">hdyn_h_h (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood">HeterodynedLikelihood (class in bbhx.likelihood)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -277,6 +318,8 @@ <h2 id="I">I</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.init_heterodyne_info">init_heterodyne_info() (bbhx.likelihood.HeterodynedLikelihood method)</a>
+</li>
       <li><a href="user/main.html#bbhx.waveformbuild.BBHWaveformFD.interp_response">interp_response (bbhx.waveformbuild.BBHWaveformFD attribute)</a>
 </li>
   </ul></td>
@@ -291,9 +334,15 @@ <h2 id="L">L</h2>
         <li><a href="user/utils.html#bbhx.waveformbuild.TemplateInterpFD.length">(bbhx.waveformbuild.TemplateInterpFD attribute)</a>
 </li>
       </ul></li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.like_gen">like_gen (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.length_f_het">length_f_het (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.like_gen">like_gen (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 
       <ul>
+        <li><a href="user/like.html#id4">(bbhx.likelihood.HeterodynedLikelihood property)</a>
+</li>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.like_gen">(bbhx.likelihood.Likelihood attribute)</a>
+</li>
         <li><a href="user/like.html#id0">(bbhx.likelihood.Likelihood property)</a>
 </li>
       </ul></li>
@@ -392,8 +441,12 @@ <h2 id="P">P</h2>
         <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.phase">(bbhx.waveforms.phenomhm.PhenomHMAmpPhase property)</a>
 </li>
       </ul></li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.phase_marginalize">phase_marginalize (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.phase_marginalize">phase_marginalize (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+
+      <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.phase_marginalize">(bbhx.likelihood.Likelihood attribute)</a>
 </li>
+      </ul></li>
       <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.phenomd_ringdown_freqs">phenomd_ringdown_freqs (bbhx.waveforms.phenomhm.PhenomHMAmpPhase attribute)</a>
 </li>
   </ul></td>
@@ -404,31 +457,51 @@ <h2 id="P">P</h2>
 </li>
       <li><a href="user/utils.html#bbhx.utils.utility.pointer_adjust">pointer_adjust() (in module bbhx.utils.utility)</a>
 </li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.psd">psd (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.psd">psd (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+
+      <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.psd">(bbhx.likelihood.Likelihood attribute)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.reference_d_d">reference_d_d (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.reference_d_h">reference_d_h (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.reference_h_h">reference_h_h (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.reference_ll">reference_ll (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="user/response.html#bbhx.response.fastfdresponse.LISATDIResponse.response_gen">response_gen (bbhx.response.fastfdresponse.LISATDIResponse attribute)</a>
 
       <ul>
         <li><a href="user/main.html#bbhx.waveformbuild.BBHWaveformFD.response_gen">(bbhx.waveformbuild.BBHWaveformFD attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.return_extracted_snr">return_extracted_snr (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.return_extracted_snr">return_extracted_snr (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
+
+      <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.return_extracted_snr">(bbhx.likelihood.Likelihood attribute)</a>
 </li>
+      </ul></li>
       <li><a href="user/waveforms.html#bbhx.waveforms.phenomhm.PhenomHMAmpPhase.run_phenomd">run_phenomd (bbhx.waveforms.phenomhm.PhenomHMAmpPhase attribute)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.sens_mat">sens_mat (bbhx.likelihood.HeterodynedLikelihood property)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="user/utils.html#bbhx.utils.transform.SSB_to_LISA">SSB_to_LISA() (in module bbhx.utils.transform)</a>
 </li>
@@ -444,9 +517,11 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="user/utils.html#bbhx.waveformbuild.TemplateInterpFD.template_channels">template_channels (bbhx.waveformbuild.TemplateInterpFD property)</a>
 </li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.template_gen">template_gen (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.template_gen">template_gen (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 
       <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.template_gen">(bbhx.likelihood.Likelihood attribute)</a>
+</li>
         <li><a href="user/utils.html#bbhx.waveformbuild.TemplateInterpFD.template_gen">(bbhx.waveformbuild.TemplateInterpFD attribute)</a>
 </li>
       </ul></li>
@@ -476,9 +551,11 @@ <h2 id="T">T</h2>
 <h2 id="U">U</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.use_gpu">use_gpu (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.use_gpu">use_gpu (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 
       <ul>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.use_gpu">(bbhx.likelihood.Likelihood attribute)</a>
+</li>
         <li><a href="user/response.html#bbhx.response.fastfdresponse.LISATDIResponse.use_gpu">(bbhx.response.fastfdresponse.LISATDIResponse attribute)</a>
 </li>
         <li><a href="user/main.html#bbhx.waveformbuild.BBHWaveformFD.use_gpu">(bbhx.waveformbuild.BBHWaveformFD attribute)</a>
@@ -514,9 +591,13 @@ <h2 id="X">X</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="user/utils.html#bbhx.utils.interpolate.CubicSplineInterpolant.x_shaped">x_shaped (bbhx.utils.interpolate.CubicSplineInterpolant property)</a>
 </li>
-      <li><a href="user/like.html#bbhx.likelihood.Likelihood.xp">xp (bbhx.likelihood.Likelihood attribute)</a>
+      <li><a href="user/like.html#bbhx.likelihood.HeterodynedLikelihood.xp">xp (bbhx.likelihood.HeterodynedLikelihood attribute)</a>
 
       <ul>
+        <li><a href="user/like.html#id5">(bbhx.likelihood.HeterodynedLikelihood property)</a>
+</li>
+        <li><a href="user/like.html#bbhx.likelihood.Likelihood.xp">(bbhx.likelihood.Likelihood attribute)</a>
+</li>
         <li><a href="user/like.html#id1">(bbhx.likelihood.Likelihood property)</a>
 </li>
         <li><a href="user/response.html#bbhx.response.fastfdresponse.LISATDIResponse.xp">(bbhx.response.fastfdresponse.LISATDIResponse attribute)</a>