Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 24, 2023
1 parent e21b58a commit d4ec6d8
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 13 deletions.
12 changes: 7 additions & 5 deletions _sources/moddoc_calibration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.

*Constructor:*
``SplitByBand(self, input='CalTimestreams', output_root=None, bands=None, bpm='BolometerProperties')``
``SplitByBand(self, input='CalTimestreams', output_root=None, bands=None, bpm='BolometerProperties', drop_empty=False)``


*Constructor:*
Expand All @@ -390,7 +390,7 @@ Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.

*Constructor:*
``SplitByPixelType(self, input='CalTimestreams', output_root=None, types=None, bpm='BolometerProperties')``
``SplitByPixelType(self, input='CalTimestreams', output_root=None, types=None, bpm='BolometerProperties', drop_empty=False)``


*Constructor:*
Expand All @@ -416,7 +416,7 @@ Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.

*Constructor:*
``SplitByProperty(self, input='CalTimestreams', property=None, property_list=None, output_root=None, bpm='BolometerProperties')``
``SplitByProperty(self, input='CalTimestreams', property=None, property_list=None, output_root=None, bpm='BolometerProperties', drop_empty=False)``


*Constructor:*
Expand All @@ -442,6 +442,8 @@ G3TimestreamMap, G3MapInt, etc.
bpm : str
The key name of the BolometerPropertiesMap from which to extract
the requested `property` for splitting the input map.
drop_empty : bool
If True, drop output maps that don't contain any bolometers.



Expand All @@ -457,7 +459,7 @@ Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.

*Constructor:*
``SplitByWafer(self, input='CalTimestreams', output_root=None, wafers=None, bpm='BolometerProperties')``
``SplitByWafer(self, input='CalTimestreams', output_root=None, wafers=None, bpm='BolometerProperties', drop_empty=False)``


*Constructor:*
Expand All @@ -483,7 +485,7 @@ Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.

*Constructor:*
``SplitTimestreamsByBand(self, input='CalTimestreams', output_root=None, bands=None, bpm='BolometerProperties')``
``SplitTimestreamsByBand(self, input='CalTimestreams', output_root=None, bands=None, bpm='BolometerProperties', drop_empty=False)``


*Constructor:*
Expand Down
2 changes: 1 addition & 1 deletion _sources/moddoc_core.rst.txt
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 0x7fcc9d4c76d0> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7fcc9d4c7740> [, (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 0x7f1ecac8b6d0> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f1ecac8b740> [, (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
12 changes: 7 additions & 5 deletions moddoc_calibration.html
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.</p>
<dl class="simple">
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByBand(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">bands=None,</span> <span class="pre">bpm='BolometerProperties')</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByBand(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">bands=None,</span> <span class="pre">bpm='BolometerProperties',</span> <span class="pre">drop_empty=False)</span></code></p>
</dd>
<dt><em>Constructor:</em></dt><dd><p>Split the input map given by input into several output
maps named output_root + band + GHz (e.g. CalTimestreams150GHz with
Expand All @@ -302,7 +302,7 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.</p>
<dl class="simple">
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByPixelType(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">types=None,</span> <span class="pre">bpm='BolometerProperties')</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByPixelType(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">types=None,</span> <span class="pre">bpm='BolometerProperties',</span> <span class="pre">drop_empty=False)</span></code></p>
</dd>
<dt><em>Constructor:</em></dt><dd><p>Split the input map given by input into several output
maps named output_root + wafer (e.g. CalTimestreamsW172 with
Expand All @@ -320,7 +320,7 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.</p>
<dl>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByProperty(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">property=None,</span> <span class="pre">property_list=None,</span> <span class="pre">output_root=None,</span> <span class="pre">bpm='BolometerProperties')</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByProperty(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">property=None,</span> <span class="pre">property_list=None,</span> <span class="pre">output_root=None,</span> <span class="pre">bpm='BolometerProperties',</span> <span class="pre">drop_empty=False)</span></code></p>
</dd>
<dt><em>Constructor:</em></dt><dd><p>Split the input map given by input into several output
maps named output_root + key (e.g. CalTimestreams + str(property)) with
Expand All @@ -344,6 +344,8 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
<dt>bpm<span class="classifier">str</span></dt><dd><p>The key name of the BolometerPropertiesMap from which to extract
the requested <cite>property</cite> for splitting the input map.</p>
</dd>
<dt>drop_empty<span class="classifier">bool</span></dt><dd><p>If True, drop output maps that don’t contain any bolometers.</p>
</dd>
</dl>
</dd>
</dl>
Expand All @@ -356,7 +358,7 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.</p>
<dl class="simple">
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByWafer(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">wafers=None,</span> <span class="pre">bpm='BolometerProperties')</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitByWafer(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">wafers=None,</span> <span class="pre">bpm='BolometerProperties',</span> <span class="pre">drop_empty=False)</span></code></p>
</dd>
<dt><em>Constructor:</em></dt><dd><p>Split the input map given by input into several output
maps named output_root + wafer (e.g. CalTimestreamsW172 with
Expand All @@ -374,7 +376,7 @@ <h2>Modules in spt3g.calibration<a class="headerlink" href="#modules-in-spt3g-ca
Return the same type of maps as the one it was handed, e.g.
G3TimestreamMap, G3MapInt, etc.</p>
<dl class="simple">
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitTimestreamsByBand(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">bands=None,</span> <span class="pre">bpm='BolometerProperties')</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">SplitTimestreamsByBand(self,</span> <span class="pre">input='CalTimestreams',</span> <span class="pre">output_root=None,</span> <span class="pre">bands=None,</span> <span class="pre">bpm='BolometerProperties',</span> <span class="pre">drop_empty=False)</span></code></p>
</dd>
<dt><em>Constructor:</em></dt><dd><p>Split the input map given by input into several output
maps named output_root + band + GHz (e.g. CalTimestreams150GHz with
Expand Down
2 changes: 1 addition & 1 deletion moddoc_core.html
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">0x7fcc9d4c76d0&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">0x7fcc9d4c7740&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">0x7f1ecac8b6d0&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">0x7f1ecac8b740&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
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit d4ec6d8

Please sign in to comment.