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 May 14, 2024
1 parent 0458a0a commit 193d728
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion _sources/moddoc_core.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2238,7 +2238,7 @@ Collection of timestreams indexed by logical detector ID

``G3TimestreamMap( (G3TimestreamMap)arg2)``

``G3TimestreamMap( (StringVector)keys, (object)data [, (G3Time)start=<spt3g.core.G3Time object at 0x7ff4a92a9510> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7ff4a92a9580> [, (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 0x7f38367c3510> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f38367c3580> [, (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
5 changes: 3 additions & 2 deletions _sources/moddoc_dfmux.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -878,13 +878,14 @@ data at fixed intervals.

Also emits a Wiring frame from the housekeeping data. This requires a
recent (as of November 2018) version of pydfmux in order to read mapped
channel names from each board.
channel names from each board. If ignore_wiring=False, assumes that
the wiring map is handled by a separate process.

If collecting real-time data, you may want to set subprocess=True when
adding this module.

*Constructor:*
``HousekeepingConsumer(self)``
``HousekeepingConsumer(self, ignore_wiring=False)``



Expand Down
2 changes: 1 addition & 1 deletion moddoc_core.html
Original file line number Diff line number Diff line change
Expand Up @@ -1547,7 +1547,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">0x7ff4a92a9510&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">0x7ff4a92a9580&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">0x7f38367c3510&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">0x7f38367c3580&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
5 changes: 3 additions & 2 deletions moddoc_dfmux.html
Original file line number Diff line number Diff line change
Expand Up @@ -599,11 +599,12 @@ <h2>Modules in spt3g.dfmux<a class="headerlink" href="#modules-in-spt3g-dfmux" t
data at fixed intervals.</p>
<p>Also emits a Wiring frame from the housekeeping data. This requires a
recent (as of November 2018) version of pydfmux in order to read mapped
channel names from each board.</p>
channel names from each board. If ignore_wiring=False, assumes that
the wiring map is handled by a separate process.</p>
<p>If collecting real-time data, you may want to set subprocess=True when
adding this module.</p>
<dl class="simple">
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">HousekeepingConsumer(self)</span></code></p>
<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">HousekeepingConsumer(self,</span> <span class="pre">ignore_wiring=False)</span></code></p>
</dd>
</dl>
<p id="spt3g-dfmux-housekeeping-periodichousekeepingcollector"><strong>spt3g.dfmux.Housekeeping.PeriodicHousekeepingCollector</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 193d728

Please sign in to comment.