Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rmjarvis committed Oct 15, 2023
1 parent 81e7d2f commit ed6db48
Show file tree
Hide file tree
Showing 376 changed files with 145,368 additions and 0 deletions.
Binary file added docs/_build/doctrees/arbitrary.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/bandpass.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/bessel.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/bounds.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/catalog.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cd.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/chromatic.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/chromaticobject.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/composite.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_galsim.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_image.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_input.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_objects.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_output.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_process.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_special.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_stamp.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_top.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/config_values.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/corr_noise.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_bounds.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_hsm.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_image.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_interp.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_math.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_noise.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_photon.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cpp_sb.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/dcr.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/des.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/deviate.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/errors.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/fft.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/fits.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/gal.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/gsobject.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/gsparams.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/history.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/hsm.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/image.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/image_class.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/install.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/install_conda.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/install_pip.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/integ.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/interpolant.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/misc.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/nfwhalo.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/noise.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/older.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/overview.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/phase_psf.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/photon.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/photon_array.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/photon_ops.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/pos.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/powerspectrum.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/pse.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/psf.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/random.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/real_gal.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/roman.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/sb.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/sed.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/sensor.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/shared.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/shear.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/simple.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/spectral.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/table.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/transform.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/tutorials.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/units.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/utilities.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/wcs.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/wl.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/zernike.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: cdd86a73548bdf0128207251d195919c
tags: 645f666f9bcd5a90fca523b33c5a78b7
647 changes: 647 additions & 0 deletions docs/_build/html/_modules/coord/angle.html

Large diffs are not rendered by default.

275 changes: 275 additions & 0 deletions docs/_build/html/_modules/coord/angleunit.html

Large diffs are not rendered by default.

1,252 changes: 1,252 additions & 0 deletions docs/_build/html/_modules/coord/celestial.html

Large diffs are not rendered by default.

448 changes: 448 additions & 0 deletions docs/_build/html/_modules/galsim/_utilities.html

Large diffs are not rendered by default.

363 changes: 363 additions & 0 deletions docs/_build/html/_modules/galsim/airy.html

Large diffs are not rendered by default.

770 changes: 770 additions & 0 deletions docs/_build/html/_modules/galsim/bandpass.html

Large diffs are not rendered by default.

604 changes: 604 additions & 0 deletions docs/_build/html/_modules/galsim/bounds.html

Large diffs are not rendered by default.

399 changes: 399 additions & 0 deletions docs/_build/html/_modules/galsim/box.html

Large diffs are not rendered by default.

713 changes: 713 additions & 0 deletions docs/_build/html/_modules/galsim/catalog.html

Large diffs are not rendered by default.

355 changes: 355 additions & 0 deletions docs/_build/html/_modules/galsim/cdmodel.html

Large diffs are not rendered by default.

3,791 changes: 3,791 additions & 0 deletions docs/_build/html/_modules/galsim/chromatic.html

Large diffs are not rendered by default.

286 changes: 286 additions & 0 deletions docs/_build/html/_modules/galsim/config/bandpass.html

Large diffs are not rendered by default.

654 changes: 654 additions & 0 deletions docs/_build/html/_modules/galsim/config/extra.html

Large diffs are not rendered by default.

186 changes: 186 additions & 0 deletions docs/_build/html/_modules/galsim/config/extra_badpix.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>galsim.config.extra_badpix &mdash; GalSim 2.5.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../../index.html" class="icon icon-home">
GalSim
</a>
<div class="version">
2.5
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installation Instructions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../image.html">Images and Related Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../sb.html">Surface Brightness Profiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../chromatic.html">Wavelength-dependent Profiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../units.html">Units</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../wcs.html">World Coordinate Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../random.html">Noise and Random Values</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../wl.html">Weak Lensing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../photon.html">Photon Shooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../utilities.html">Helper Functions and Classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../errors.html">Errors and Warnings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../config.html">The Config Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../hsm.html">The HSM Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../des.html">The DES Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../roman.html">The Roman Space Telescope Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../cpp.html">C++ Layer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../shared.html">Shared Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../history.html">Revision History</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">GalSim</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">galsim.config.extra_badpix</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for galsim.config.extra_badpix</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright (c) 2012-2023 by the GalSim developers team on GitHub</span>
<span class="c1"># https://github.com/GalSim-developers</span>
<span class="c1">#</span>
<span class="c1"># This file is part of GalSim: The modular galaxy image simulation toolkit.</span>
<span class="c1"># https://github.com/GalSim-developers/GalSim</span>
<span class="c1">#</span>
<span class="c1"># GalSim is free software: redistribution and use in source and binary forms,</span>
<span class="c1"># with or without modification, are permitted provided that the following</span>
<span class="c1"># conditions are met:</span>
<span class="c1">#</span>
<span class="c1"># 1. Redistributions of source code must retain the above copyright notice, this</span>
<span class="c1"># list of conditions, and the disclaimer given in the accompanying LICENSE</span>
<span class="c1"># file.</span>
<span class="c1"># 2. Redistributions in binary form must reproduce the above copyright notice,</span>
<span class="c1"># this list of conditions, and the disclaimer given in the documentation</span>
<span class="c1"># and/or other materials provided with the distribution.</span>
<span class="c1">#</span>

<span class="kn">from</span> <span class="nn">.extra</span> <span class="kn">import</span> <span class="n">ExtraOutputBuilder</span><span class="p">,</span> <span class="n">RegisterExtraOutput</span>
<span class="kn">from</span> <span class="nn">..image</span> <span class="kn">import</span> <span class="n">ImageS</span>

<span class="c1"># The badpix extra output type is currently just a placeholder for when we eventually add</span>
<span class="c1"># defects, saturation, etc. Now it always just builds an Image with all 0&#39;s.</span>

<div class="viewcode-block" id="BadPixBuilder"><a class="viewcode-back" href="../../../config_output.html#galsim.config.extra_badpix.BadPixBuilder">[docs]</a><span class="k">class</span> <span class="nc">BadPixBuilder</span><span class="p">(</span><span class="n">ExtraOutputBuilder</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This builds a bad pixel mask image to go along with each regular data image.</span>

<span class="sd"> There&#39;s not much here currently, since GalSim doesn&#39;t yet have any image artifacts that</span>
<span class="sd"> would be appropriate to do something with here. So this is mostly just a placeholder for</span>
<span class="sd"> when we eventually add defects, saturation, etc.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="c1"># The function to call at the end of building each stamp</span>
<span class="k">def</span> <span class="nf">processStamp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj_num</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<span class="c1"># Note: This is just a placeholder for now. Once we implement defects, saturation, etc.,</span>
<span class="c1"># these features should be marked in the badpix mask. For now though, all pixels = 0.</span>
<span class="k">if</span> <span class="n">base</span><span class="p">[</span><span class="s1">&#39;do_noise_in_stamps&#39;</span><span class="p">]:</span>
<span class="n">badpix_im</span> <span class="o">=</span> <span class="n">ImageS</span><span class="p">(</span><span class="n">base</span><span class="p">[</span><span class="s1">&#39;current_stamp&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">bounds</span><span class="p">,</span> <span class="n">wcs</span><span class="o">=</span><span class="n">base</span><span class="p">[</span><span class="s1">&#39;wcs&#39;</span><span class="p">],</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scratch</span><span class="p">[</span><span class="n">obj_num</span><span class="p">]</span> <span class="o">=</span> <span class="n">badpix_im</span>

<span class="c1"># The function to call at the end of building each image</span>
<span class="k">def</span> <span class="nf">processImage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">obj_nums</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<span class="n">image</span> <span class="o">=</span> <span class="n">ImageS</span><span class="p">(</span><span class="n">base</span><span class="p">[</span><span class="s1">&#39;image_bounds&#39;</span><span class="p">],</span> <span class="n">wcs</span><span class="o">=</span><span class="n">base</span><span class="p">[</span><span class="s1">&#39;wcs&#39;</span><span class="p">],</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scratch</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mf">0.</span><span class="p">:</span>
<span class="c1"># If we have been accumulating the variance on the stamps, build the total from them.</span>
<span class="c1"># Make sure to only use the stamps for objects in this image.</span>
<span class="k">for</span> <span class="n">obj_num</span> <span class="ow">in</span> <span class="n">obj_nums</span><span class="p">:</span>
<span class="n">stamp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scratch</span><span class="p">[</span><span class="n">obj_num</span><span class="p">]</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">stamp</span><span class="o">.</span><span class="n">bounds</span> <span class="o">&amp;</span> <span class="n">image</span><span class="o">.</span><span class="n">bounds</span>
<span class="k">if</span> <span class="n">b</span><span class="o">.</span><span class="n">isDefined</span><span class="p">():</span> <span class="c1"># pragma: no branch</span>
<span class="c1"># This next line is equivalent to:</span>
<span class="c1"># image[b] |= stamp[b]</span>
<span class="c1"># except that this doesn&#39;t work through the proxy. We can only call methods</span>
<span class="c1"># that don&#39;t start with _. Hence using the more verbose form here.</span>
<span class="n">image</span><span class="o">.</span><span class="n">setSubImage</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">image</span><span class="o">.</span><span class="n">subImage</span><span class="p">(</span><span class="n">b</span><span class="p">)</span> <span class="o">|</span> <span class="n">stamp</span><span class="p">[</span><span class="n">b</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Otherwise, build the bad pixel mask here.</span>
<span class="c1"># Again, nothing here yet.</span>
<span class="k">pass</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">image</span></div>


<span class="c1"># Register this as a valid extra output</span>
<span class="n">RegisterExtraOutput</span><span class="p">(</span><span class="s1">&#39;badpix&#39;</span><span class="p">,</span> <span class="n">BadPixBuilder</span><span class="p">())</span>
</pre></div>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023, GalSim-developers.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit ed6db48

Please sign in to comment.