Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jan 24, 2024
1 parent 1972d49 commit 1001c2d
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 11 deletions.
2 changes: 1 addition & 1 deletion _sources/moddoc_core.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2216,7 +2216,7 @@ Collection of timestreams indexed by logical detector ID

``G3TimestreamMap( (G3TimestreamMap)arg2)``

``G3TimestreamMap( (StringVector)keys, (object)data [, (G3Time)start=<spt3g.core.G3Time object at 0x7f0f09a4b6d0> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f0f09a4b740> [, (G3TimestreamUnits)units=spt3g.core.G3TimestreamUnits.None [, (int)compression_level=0 [, (bool)copy_data=True]]]]])`` :
``G3TimestreamMap( (StringVector)keys, (object)data [, (G3Time)start=<spt3g.core.G3Time object at 0x7fd8c1d586d0> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7fd8c1d58740> [, (G3TimestreamUnits)units=spt3g.core.G3TimestreamUnits.None [, (int)compression_level=0 [, (bool)copy_data=True]]]]])`` :
Create a timestream map from a numpy array or other numeric python iterable. Each row of the 2D input array will correspond to a single timestream, with the key set to the correspondingly-indexed entry of <keys>. If <copy_data> is True (default), the data will be copied into the output data structure. If False, the timestream map will provide a view into the given numpy array.

``G3TimestreamMap( (list)arg2)`` :
Expand Down
20 changes: 16 additions & 4 deletions _sources/moddoc_maps.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1385,13 +1385,19 @@ maps and (optionally) polarized weights to store in the output file.
FITS readers (e.g. idlastro). If defined, the compression algorithm to
be used by the Astropy class astropy.io.fits.CompImageHDU.
Can be: 'RICE_1', 'RICE_ONE', 'PLIO_1', 'GZIP_1', 'GZIP_2' or
'HCOMPRESS_1'. Only GZIP_1 and GZIP_2 are lossless.
'HCOMPRESS_1'. Only GZIP_1 and GZIP_2 are lossless, although only
for integer data.
quantize_level : float
Floating point quantization level for compression. Higher values result
in more accurate floating point representation, but worse compression
ratio. See the astropy FITS image documention for details:
https://docs.astropy.org/en/stable/io/fits/api/images.html
overwrite : bool
If True, any existing file with the same name will be ovewritten.


*Definition:*
``SaveMapFrame(frame, output_file=None, hdr=None, compress='GZIP_2', overwrite=False)``
``SaveMapFrame(frame, output_file=None, hdr=None, compress=False, quantize_level=16.0, overwrite=False)``



Expand Down Expand Up @@ -1975,14 +1981,20 @@ over all pixels. The former produces output that is equivalent to using
FITS readers (e.g. idlastro). If defined, the compression algorithm to
be used by the Astropy class astropy.io.fits.CompImageHDU.
Can be: 'RICE_1', 'RICE_ONE', 'PLIO_1', 'GZIP_1', 'GZIP_2' or
'HCOMPRESS_1'. Only GZIP_1 and GZIP_2 are lossless.
'HCOMPRESS_1'. Only GZIP_1 and GZIP_2 are lossless, although only
for integer data.
quantize_level : float
Floating point quantization level for compression. Higher values result
in more accurate floating point representation, but worse compression
ratio. See the astropy FITS image documention for details:
https://docs.astropy.org/en/stable/io/fits/api/images.html
hdr : dict
If defined, extra keywords to be appened to the FITS header. The dict
can contain entries such as ``hdr['NEWKEY'] = 'New value'`` or
``hdr['NEWKEY'] = ('New value', "Comment for New value")``.

*Definition:*
``save_skymap_fits(filename, T, Q=None, U=None, W=None, overwrite=False, compress='GZIP_2', hdr=None)``
``save_skymap_fits(filename, T, Q=None, U=None, W=None, overwrite=False, compress=False, quantize_level=16.0, hdr=None)``



Expand Down
2 changes: 1 addition & 1 deletion moddoc_core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1540,7 +1540,7 @@ <h2>Frame Objects in spt3g.core<a class="headerlink" href="#frame-objects-in-spt
<dt><em>Constructors:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">G3TimestreamMap()</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">G3TimestreamMap(</span> <span class="pre">(G3TimestreamMap)arg2)</span></code></p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">G3TimestreamMap(</span> <span class="pre">(StringVector)keys,</span> <span class="pre">(object)data</span> <span class="pre">[,</span> <span class="pre">(G3Time)start=&lt;spt3g.core.G3Time</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f0f09a4b6d0&gt;</span> <span class="pre">[,</span> <span class="pre">(G3Time)stop=&lt;spt3g.core.G3Time</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f0f09a4b740&gt;</span> <span class="pre">[,</span> <span class="pre">(G3TimestreamUnits)units=spt3g.core.G3TimestreamUnits.None</span> <span class="pre">[,</span> <span class="pre">(int)compression_level=0</span> <span class="pre">[,</span> <span class="pre">(bool)copy_data=True]]]]])</span></code> :</dt><dd><p>Create a timestream map from a numpy array or other numeric python iterable. Each row of the 2D input array will correspond to a single timestream, with the key set to the correspondingly-indexed entry of &lt;keys&gt;. If &lt;copy_data&gt; is True (default), the data will be copied into the output data structure. If False, the timestream map will provide a view into the given numpy array.</p>
<dt><code class="docutils literal notranslate"><span class="pre">G3TimestreamMap(</span> <span class="pre">(StringVector)keys,</span> <span class="pre">(object)data</span> <span class="pre">[,</span> <span class="pre">(G3Time)start=&lt;spt3g.core.G3Time</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7fd8c1d586d0&gt;</span> <span class="pre">[,</span> <span class="pre">(G3Time)stop=&lt;spt3g.core.G3Time</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7fd8c1d58740&gt;</span> <span class="pre">[,</span> <span class="pre">(G3TimestreamUnits)units=spt3g.core.G3TimestreamUnits.None</span> <span class="pre">[,</span> <span class="pre">(int)compression_level=0</span> <span class="pre">[,</span> <span class="pre">(bool)copy_data=True]]]]])</span></code> :</dt><dd><p>Create a timestream map from a numpy array or other numeric python iterable. Each row of the 2D input array will correspond to a single timestream, with the key set to the correspondingly-indexed entry of &lt;keys&gt;. If &lt;copy_data&gt; is True (default), the data will be copied into the output data structure. If False, the timestream map will provide a view into the given numpy array.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">G3TimestreamMap(</span> <span class="pre">(list)arg2)</span></code> :</dt><dd><p>Initialize with keys and values from a Python dictionary: {‘key’:’value’}</p>
</dd>
Expand Down
20 changes: 16 additions & 4 deletions moddoc_maps.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1024,13 +1024,19 @@ <h2>Modules in spt3g.maps<a class="headerlink" href="#modules-in-spt3g-maps" tit
FITS readers (e.g. idlastro). If defined, the compression algorithm to
be used by the Astropy class astropy.io.fits.CompImageHDU.
Can be: ‘RICE_1’, ‘RICE_ONE’, ‘PLIO_1’, ‘GZIP_1’, ‘GZIP_2’ or
‘HCOMPRESS_1’. Only GZIP_1 and GZIP_2 are lossless.</p>
‘HCOMPRESS_1’. Only GZIP_1 and GZIP_2 are lossless, although only
for integer data.</p>
</dd>
<dt>quantize_level<span class="classifier">float</span></dt><dd><p>Floating point quantization level for compression. Higher values result
in more accurate floating point representation, but worse compression
ratio. See the astropy FITS image documention for details:
<a class="reference external" href="https://docs.astropy.org/en/stable/io/fits/api/images.html">https://docs.astropy.org/en/stable/io/fits/api/images.html</a></p>
</dd>
<dt>overwrite<span class="classifier">bool</span></dt><dd><p>If True, any existing file with the same name will be ovewritten.</p>
</dd>
</dl>
</dd>
<dt><em>Definition:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SaveMapFrame(frame,</span> <span class="pre">output_file=None,</span> <span class="pre">hdr=None,</span> <span class="pre">compress='GZIP_2',</span> <span class="pre">overwrite=False)</span></code></p>
<dt><em>Definition:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SaveMapFrame(frame,</span> <span class="pre">output_file=None,</span> <span class="pre">hdr=None,</span> <span class="pre">compress=False,</span> <span class="pre">quantize_level=16.0,</span> <span class="pre">overwrite=False)</span></code></p>
</dd>
</dl>
<p id="spt3g-maps-map-modules-applyweights"><strong>spt3g.maps.map_modules.ApplyWeights</strong></p>
Expand Down Expand Up @@ -1449,15 +1455,21 @@ <h2>Functions in spt3g.maps<a class="headerlink" href="#functions-in-spt3g-maps"
FITS readers (e.g. idlastro). If defined, the compression algorithm to
be used by the Astropy class astropy.io.fits.CompImageHDU.
Can be: ‘RICE_1’, ‘RICE_ONE’, ‘PLIO_1’, ‘GZIP_1’, ‘GZIP_2’ or
‘HCOMPRESS_1’. Only GZIP_1 and GZIP_2 are lossless.</p>
‘HCOMPRESS_1’. Only GZIP_1 and GZIP_2 are lossless, although only
for integer data.</p>
</dd>
<dt>quantize_level<span class="classifier">float</span></dt><dd><p>Floating point quantization level for compression. Higher values result
in more accurate floating point representation, but worse compression
ratio. See the astropy FITS image documention for details:
<a class="reference external" href="https://docs.astropy.org/en/stable/io/fits/api/images.html">https://docs.astropy.org/en/stable/io/fits/api/images.html</a></p>
</dd>
<dt>hdr<span class="classifier">dict</span></dt><dd><p>If defined, extra keywords to be appened to the FITS header. The dict
can contain entries such as <code class="docutils literal notranslate"><span class="pre">hdr['NEWKEY']</span> <span class="pre">=</span> <span class="pre">'New</span> <span class="pre">value'</span></code> or
<code class="docutils literal notranslate"><span class="pre">hdr['NEWKEY']</span> <span class="pre">=</span> <span class="pre">('New</span> <span class="pre">value',</span> <span class="pre">&quot;Comment</span> <span class="pre">for</span> <span class="pre">New</span> <span class="pre">value&quot;)</span></code>.</p>
</dd>
</dl>
</dd>
<dt><em>Definition:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">save_skymap_fits(filename,</span> <span class="pre">T,</span> <span class="pre">Q=None,</span> <span class="pre">U=None,</span> <span class="pre">W=None,</span> <span class="pre">overwrite=False,</span> <span class="pre">compress='GZIP_2',</span> <span class="pre">hdr=None)</span></code></p>
<dt><em>Definition:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">save_skymap_fits(filename,</span> <span class="pre">T,</span> <span class="pre">Q=None,</span> <span class="pre">U=None,</span> <span class="pre">W=None,</span> <span class="pre">overwrite=False,</span> <span class="pre">compress=False,</span> <span class="pre">quantize_level=16.0,</span> <span class="pre">hdr=None)</span></code></p>
</dd>
</dl>
<p id="spt3g-maps-flatten-pol"><strong>spt3g.maps.flatten_pol</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 1001c2d

Please sign in to comment.