Update documentation

_sources/moddoc_core.rst.txt

@@ -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 0x7f7ad3055150> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7f7ad30551c0> [, (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 0x7fb16e655150> [, (G3Time)stop=<spt3g.core.G3Time object at 0x7fb16e6551c0> [, (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)`` :

_sources/moddoc_maps.rst.txt

@@ -1758,9 +1758,16 @@ currently implemented.
 	weighted : bool
 	    If True (default), ensure that maps have had weights applied before
 	    reprojection.  Otherwise, reproject maps without checking the weights.
+	partial :  bool=False
+	    If True, the reproj will be performed on a partial map (of the output map),
+	    defined by the mask. If the mask is not provided, it will be determined from
+	    the non-zero pixels of the first reprojected map.
+	mask : G3SkyMapMask, G3SkyMap, or np.ndarray, Optional.
+	    Mask to be used for partial reproject. This should be of the same size as the
+	    output map. For numpy array, all zeros/inf/nan/hp.UNSEEN pixels are skipped.
 
 *Constructor:*
-	``ReprojectMaps(map_stub=None, rebin=1, interp=False, weighted=True)``
+	``ReprojectMaps(map_stub=None, rebin=1, interp=False, weighted=True, partial=False, mask=None)``
 
 
 
@@ -2393,7 +2400,7 @@ vector of them) specified as a (longitude, latitude) pair.
 
 **spt3g.maps.reproj_map**
 
-``reproj_map( (object)in_map, (G3SkyMap)out_map [, (int)rebin=1 [, (bool)interp=False]]) -> None :``
-    Reprojects the data from in_map onto out_map.  out_map can have a different projection, size, resolution, etc.  Optionally account for sub-pixel structure by setting rebin > 1 and/or enable bilinear interpolation of values from the input map by setting interp=True.  Use the maps' coord_ref attributes to rotate between Equatorial and Galactic coordinate systems.  Use the maps' pol_conv attributes to switch between COSMO and IAU polarization conventions.  If output attributes are not set, they will be copied from the input map.
+``reproj_map( (object)in_map, (G3SkyMap)out_map [, (int)rebin=1 [, (bool)interp=False [, (G3SkyMapMask)mask=None]]]) -> None :``
+    Reprojects the data from in_map onto out_map.  out_map can have a different projection, size, resolution, etc.  Optionally account for sub-pixel structure by setting rebin > 1 and/or enable bilinear interpolation of values from the input map by setting interp=True.  Use the maps' coord_ref attributes to rotate between Equatorial and Galactic coordinate systems.  Use the maps' pol_conv attributes to switch between COSMO and IAU polarization conventions.  If output attributes are not set, they will be copied from the input map. out_map_mask, if given, skip the unused pixelsand set these pixels to 0.
 
 

moddoc_core.html

@@ -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">0x7f7ad3055150&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">0x7f7ad30551c0&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">0x7fb16e655150&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">0x7fb16e6551c0&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>

moddoc_maps.html

@@ -1297,9 +1297,16 @@ <h2>Modules in spt3g.maps<a class="headerlink" href="#modules-in-spt3g-maps" tit
 <dt>weighted<span class="classifier">bool</span></dt><dd><p>If True (default), ensure that maps have had weights applied before
 reprojection.  Otherwise, reproject maps without checking the weights.</p>
 </dd>
+<dt>partial<span class="classifier">bool=False</span></dt><dd><p>If True, the reproj will be performed on a partial map (of the output map),
+defined by the mask. If the mask is not provided, it will be determined from
+the non-zero pixels of the first reprojected map.</p>
+</dd>
+<dt>mask<span class="classifier">G3SkyMapMask, G3SkyMap, or np.ndarray, Optional.</span></dt><dd><p>Mask to be used for partial reproject. This should be of the same size as the
+output map. For numpy array, all zeros/inf/nan/hp.UNSEEN pixels are skipped.</p>
+</dd>
 </dl>
 </dd>
-<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">ReprojectMaps(map_stub=None,</span> <span class="pre">rebin=1,</span> <span class="pre">interp=False,</span> <span class="pre">weighted=True)</span></code></p>
+<dt><em>Constructor:</em></dt><dd><p><code class="docutils literal notranslate"><span class="pre">ReprojectMaps(map_stub=None,</span> <span class="pre">rebin=1,</span> <span class="pre">interp=False,</span> <span class="pre">weighted=True,</span> <span class="pre">partial=False,</span> <span class="pre">mask=None)</span></code></p>
 </dd>
 </dl>
 <p id="spt3g-maps-map-modules-setpolconv"><strong>spt3g.maps.map_modules.SetPolConv</strong></p>
@@ -1750,7 +1757,7 @@ <h2>Functions in spt3g.maps<a class="headerlink" href="#functions-in-spt3g-maps"
 </dl>
 <p id="spt3g-maps-reproj-map"><strong>spt3g.maps.reproj_map</strong></p>
 <dl class="simple">
-<dt><code class="docutils literal notranslate"><span class="pre">reproj_map(</span> <span class="pre">(object)in_map,</span> <span class="pre">(G3SkyMap)out_map</span> <span class="pre">[,</span> <span class="pre">(int)rebin=1</span> <span class="pre">[,</span> <span class="pre">(bool)interp=False]])</span> <span class="pre">-&gt;</span> <span class="pre">None</span> <span class="pre">:</span></code></dt><dd><p>Reprojects the data from in_map onto out_map.  out_map can have a different projection, size, resolution, etc.  Optionally account for sub-pixel structure by setting rebin &gt; 1 and/or enable bilinear interpolation of values from the input map by setting interp=True.  Use the maps’ coord_ref attributes to rotate between Equatorial and Galactic coordinate systems.  Use the maps’ pol_conv attributes to switch between COSMO and IAU polarization conventions.  If output attributes are not set, they will be copied from the input map.</p>
+<dt><code class="docutils literal notranslate"><span class="pre">reproj_map(</span> <span class="pre">(object)in_map,</span> <span class="pre">(G3SkyMap)out_map</span> <span class="pre">[,</span> <span class="pre">(int)rebin=1</span> <span class="pre">[,</span> <span class="pre">(bool)interp=False</span> <span class="pre">[,</span> <span class="pre">(G3SkyMapMask)mask=None]]])</span> <span class="pre">-&gt;</span> <span class="pre">None</span> <span class="pre">:</span></code></dt><dd><p>Reprojects the data from in_map onto out_map.  out_map can have a different projection, size, resolution, etc.  Optionally account for sub-pixel structure by setting rebin &gt; 1 and/or enable bilinear interpolation of values from the input map by setting interp=True.  Use the maps’ coord_ref attributes to rotate between Equatorial and Galactic coordinate systems.  Use the maps’ pol_conv attributes to switch between COSMO and IAU polarization conventions.  If output attributes are not set, they will be copied from the input map. out_map_mask, if given, skip the unused pixelsand set these pixels to 0.</p>
 </dd>
 </dl>
 </section>