From b1d0efaad3a6f98eac1b92a315a44254406844e4 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 2 Dec 2024 22:30:51 +0000
Subject: [PATCH] Update documentation
---
_sources/moddoc_core.rst.txt | 2 +-
_sources/moddoc_maps.rst.txt | 13 ++++++++++---
moddoc_core.html | 2 +-
moddoc_maps.html | 11 +++++++++--
searchindex.js | 2 +-
5 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/_sources/moddoc_core.rst.txt b/_sources/moddoc_core.rst.txt
index b2fe9c8a..88e76c61 100644
--- a/_sources/moddoc_core.rst.txt
+++ b/_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=Frame Objects in spt3g.coreG3TimestreamMap()
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]]]]])
: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( (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)
:Initialize with keys and values from a Python dictionary: {‘key’:’value’}
If True (default), ensure that maps have had weights applied before reprojection. Otherwise, reproject maps without checking the weights.
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 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.
+ReprojectMaps(map_stub=None, rebin=1, interp=False, weighted=True)
ReprojectMaps(map_stub=None, rebin=1, interp=False, weighted=True, partial=False, mask=None)
spt3g.maps.map_modules.SetPolConv
@@ -1750,7 +1757,7 @@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.