Skip to content

Updated doc #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aguinot merged 1 commit into from
Mar 27, 2025
Merged

Updated doc #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/_build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/euclidlike.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/euclidlike_imsim.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/examples.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/history.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/install.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/modules.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/overview.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/scripts.doctree
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/_build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4eb1993e7d6d79d4c633c84663c8829c
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 20cf15dc9d9b1bbfde449aaf17d3d217
tags: 645f666f9bcd5a90fca523b33c5a78b7
13 changes: 7 additions & 6 deletions docs/_build/html/_modules/euclidlike/backgrounds.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -86,10 +86,13 @@ <h1>Source code for euclidlike.backgrounds</h1><div class="highlight"><pre>
<span class="sd"> Get the expected sky level for a Euclid observation due to zodiacal light for this bandpass</span>
<span class="sd"> and position.</span>

<span class="sd"> This routine can take an arbitray galsim.Bandpass() and calculate the zodiacal background</span>
<span class="sd"> This routine can take an arbitrary galsim.Bandpass() and calculate the zodiacal background</span>
<span class="sd"> directly. This is approximately 3x slower than using lookup tables.</span>

<span class="sd"> The numbers that are returned are in units of e-/arcsec^2. The result can either be multiplied</span>
<span class="sd"> This routine starts by calling another routine to get the zodiacal background in</span>
<span class="sd"> photons/m^2/arcsec^2/sec. After multiplying by the collecting area in m^2 and exposure time in sec,</span>
<span class="sd"> while using a bandpass including the quantum efficiency (to go from photons to electrons), </span>
<span class="sd"> the numbers that are returned are in units of e-/arcsec^2. The result can either be multiplied</span>
<span class="sd"> by the approximate pixel area to get e-/pix, or the result can be used with wcs.makeSkyImage()</span>
<span class="sd"> to make an image of the sky that properly includes the actual pixel area as a function of</span>
<span class="sd"> position on the detector.</span>
Expand Down Expand Up @@ -152,11 +155,9 @@ <h1>Source code for euclidlike.backgrounds</h1><div class="highlight"><pre>
<span class="n">bandpass</span><span class="o">.</span><span class="n">func</span><span class="p">(</span><span class="n">bandpass</span><span class="o">.</span><span class="n">wave_list</span><span class="p">))</span>

<span class="c1"># Now, convert to the right units, and return. (See docstring for explanation.)</span>
<span class="c1"># Multiply by exposure time.</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">gain</span>
<span class="c1"># Multiply by exposure time, collecting area in m^2</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">collecting_area</span>
<span class="n">sky_val</span> <span class="o">*=</span> <span class="n">exptime</span>
<span class="n">sky_val</span> <span class="o">*=</span> <span class="n">gain</span>
<span class="n">sky_val</span> <span class="o">*=</span> <span class="n">collecting_area</span><span class="o">/</span><span class="mf">1e4</span>

<span class="c1"># The result is now the sky level in e-/arcsec^2.</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/euclidlike/bandpass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down
9 changes: 7 additions & 2 deletions docs/_build/html/_modules/euclidlike/euclidlike_psf.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -193,7 +193,12 @@ <h1>Source code for euclidlike.euclidlike_psf</h1><div class="highlight"><pre>
<span class="sd"> In addition, the provided PSF images are normalized for obscuration, </span>
<span class="sd"> vignetting and baffle effects. However, GalSim internally handles the </span>
<span class="sd"> obscuration, so we remove this part of the normalization by dividing the</span>
<span class="sd"> PSF images by collecting_area / ((diameter/2)**2*np.pi). As a result, the sum of the pixel values in the renormalized PSF images is very close to 1.</span>
<span class="sd"> PSF images by collecting_area / ((diameter/2)**2*np.pi). As a result, the sum of the pixel</span>
<span class="sd"> values in the renormalized PSF images is very close to 1.</span>

<span class="sd"> Members of the Euclid Consortium with access to the internal PSF toolkit can reproduce the</span>
<span class="sd"> precomputed PSF images using the `Develop` branch as of 21 May 2024 using the config file</span>
<span class="sd"> `data/config.zip`.</span>
<span class="sd"> </span>

<span class="sd"> Parameters:</span>
Expand Down
10 changes: 5 additions & 5 deletions docs/_build/html/_modules/euclidlike/euclidlike_wcs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -267,10 +267,10 @@ <h1>Source code for euclidlike.euclidlike_wcs</h1><div class="highlight"><pre>
<span class="n">header</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
<span class="p">(</span><span class="s1">&#39;CRVAL1&#39;</span><span class="p">,</span> <span class="n">crval</span><span class="o">.</span><span class="n">ra</span> <span class="o">/</span> <span class="n">coord</span><span class="o">.</span><span class="n">degrees</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;CRVAL2&#39;</span><span class="p">,</span> <span class="n">crval</span><span class="o">.</span><span class="n">dec</span> <span class="o">/</span> <span class="n">coord</span><span class="o">.</span><span class="n">degrees</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;CD1_1&#39;</span><span class="p">,</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">-</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD1_2&#39;</span><span class="p">,</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD2_1&#39;</span><span class="p">,</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">-</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD2_2&#39;</span><span class="p">,</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD1_1&#39;</span><span class="p">,</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD1_2&#39;</span><span class="p">,</span> <span class="o">-</span><span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD1_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD2_1&#39;</span><span class="p">,</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;CD2_2&#39;</span><span class="p">,</span> <span class="o">-</span><span class="n">sin_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_1&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]</span> <span class="o">+</span> <span class="n">cos_pa_sca</span> <span class="o">*</span> <span class="n">PVs</span><span class="p">[</span><span class="s2">&quot;CD2_2&quot;</span><span class="p">][</span><span class="n">i_ccd</span><span class="p">]),</span>
<span class="p">])</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">PVs</span><span class="o">.</span><span class="n">dtype</span><span class="o">.</span><span class="n">names</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;PV&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/euclidlike_imsim/bandpass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/_modules/euclidlike_imsim/ccd.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=39bb1c6d"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -274,7 +274,7 @@ <h1>Source code for euclidlike_imsim.ccd</h1><div class="highlight"><pre>
<span class="sd"> logger: If given, a logger object to log progress.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># check ignore noise</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg_noise</span><span class="p">[</span><span class="s2">&quot;ignore_noise&quot;</span><span class="p">]:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg_noise</span><span class="p">[</span><span class="s2">&quot;use_noise&quot;</span><span class="p">]:</span>
<span class="k">return</span>

<span class="k">if</span> <span class="s2">&quot;noise_image&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">base</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
Expand Down
Loading
Loading