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 Dec 13, 2024
1 parent 8ad09c8 commit 8e869e8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions _sources/moddoc_core.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2255,7 +2255,7 @@ Collection of timestreams indexed by logical detector ID

``G3TimestreamMap( (G3TimestreamMap)arg2)``

``G3TimestreamMap( (StringVector)keys, (object)data [, (G3Time)start=<spt3g.core.G3Time object at 0x7f87fc109150> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f87fc1091c0> [, (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 0x7f19b0455150> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f19b04551c0> [, (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 Expand Up @@ -2878,9 +2878,9 @@ Read frames from disk. Takes either the path to a file to read or an iterable of


*Constructors:*
``G3Reader( (str)filename [, (int)n_frames_to_read=0 [, (float)timeout=-1.0 [, (bool)track_filename=False]]])``
``G3Reader( (str)filename [, (int)n_frames_to_read=0 [, (float)timeout=-1.0 [, (bool)track_filename=False [, (int)buffersize=1048576]]]])``

``G3Reader( (StringVector)filename [, (int)n_frames_to_read=0 [, (float)timeout=-1.0 [, (bool)track_filename=False]]])``
``G3Reader( (StringVector)filename [, (int)n_frames_to_read=0 [, (float)timeout=-1.0 [, (bool)track_filename=False [, (int)buffersize=1048576]]]])``



Expand Down
6 changes: 3 additions & 3 deletions moddoc_core.html
Original file line number Diff line number Diff line change
Expand Up @@ -1557,7 +1557,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">0x7f87fc109150&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">0x7f87fc1091c0&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">0x7f19b0455150&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">0x7f19b04551c0&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 Expand Up @@ -1893,8 +1893,8 @@ <h2>Modules in spt3g.core<a class="headerlink" href="#modules-in-spt3g-core" tit
<p id="spt3g-core-g3reader"><strong>spt3g.core.G3Reader</strong></p>
<p>Read frames from disk. Takes either the path to a file to read or an iterable of files to be read in sequence. If n_frames_to_read is greater than zero, will stop after n_frames_to_read frames rather than at the end of the file[s]. The timeout parameter can used to enable socket timeout for tcp streams, resulting in EOF behavior on expiry; unfortunately this cannot be used for polling, you have to close the connection. Use the <cite>tell</cite> and <cite>seek</cite> methods to record the position of and seek to the beginning of a particular frame in the file. Set track_filename to True to record the filename for each frame in the ._filename attribute (fragile).</p>
<dl>
<dt><em>Constructors:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">G3Reader(</span> <span class="pre">(str)filename</span> <span class="pre">[,</span> <span class="pre">(int)n_frames_to_read=0</span> <span class="pre">[,</span> <span class="pre">(float)timeout=-1.0</span> <span class="pre">[,</span> <span class="pre">(bool)track_filename=False]]])</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">G3Reader(</span> <span class="pre">(StringVector)filename</span> <span class="pre">[,</span> <span class="pre">(int)n_frames_to_read=0</span> <span class="pre">[,</span> <span class="pre">(float)timeout=-1.0</span> <span class="pre">[,</span> <span class="pre">(bool)track_filename=False]]])</span></code></p>
<dt><em>Constructors:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">G3Reader(</span> <span class="pre">(str)filename</span> <span class="pre">[,</span> <span class="pre">(int)n_frames_to_read=0</span> <span class="pre">[,</span> <span class="pre">(float)timeout=-1.0</span> <span class="pre">[,</span> <span class="pre">(bool)track_filename=False</span> <span class="pre">[,</span> <span class="pre">(int)buffersize=1048576]]]])</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">G3Reader(</span> <span class="pre">(StringVector)filename</span> <span class="pre">[,</span> <span class="pre">(int)n_frames_to_read=0</span> <span class="pre">[,</span> <span class="pre">(float)timeout=-1.0</span> <span class="pre">[,</span> <span class="pre">(bool)track_filename=False</span> <span class="pre">[,</span> <span class="pre">(int)buffersize=1048576]]]])</span></code></p>
</dd>
</dl>
<p id="spt3g-core-g3writer"><strong>spt3g.core.G3Writer</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 8e869e8

Please sign in to comment.