LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Public Member Functions | |
def | __init__ (self, butler, *args, **kwargs) |
def | loadSkyCircle (self, ctrCoord, radius, filterName=None, epoch=None, centroids=False) |
def | getShards (self, shardIdList) |
def | loadPixelBox (self, bbox, wcs, filterName=None, photoCalib=None, epoch=None) |
def | getMetadataBox (self, bbox, wcs, filterName=None, photoCalib=None, epoch=None) |
def | getMetadataCircle (self, coord, radius, filterName, photoCalib=None, epoch=None) |
def | joinMatchListWithCatalog (self, matchCat, sourceCat) |
def | applyProperMotions (self, catalog, epoch) |
Static Public Member Functions | |
def | makeMinimalSchema (filterNameList, *addCentroid=False, addIsPhotometric=False, addIsResolved=False, addIsVariable=False, coordErrDim=2, addProperMotion=False, properMotionErrDim=2, addParallax=False) |
Public Attributes | |
dataset_config | |
indexer | |
ref_dataset_name | |
butler | |
Static Public Attributes | |
ConfigClass = LoadIndexedReferenceObjectsConfig | |
Load reference objects from an indexed catalog ingested by IngestIndexReferenceTask. Parameters ---------- butler : `lsst.daf.persistence.Butler` Data butler for reading catalogs
Definition at line 43 of file loadIndexedReferenceObjects.py.
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.__init__ | ( | self, | |
butler, | |||
* | args, | ||
** | kwargs | ||
) |
Construct a LoadReferenceObjectsTask Parameters ---------- butler : `lsst.daf.persistence.Butler` Data butler, for access reference catalogs.
Reimplemented from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.
Definition at line 55 of file loadIndexedReferenceObjects.py.
|
inherited |
Apply proper motion correction to a reference catalog. Adjust position and position error in the ``catalog`` for proper motion to the specified ``epoch``, modifying the catalog in place. Parameters ---------- catalog : `lsst.afw.table.SimpleCatalog` Catalog of positions, containing at least these fields: - Coordinates, retrieved by the table's coordinate key. - ``coord_raErr`` : Error in Right Ascension (rad). - ``coord_decErr`` : Error in Declination (rad). - ``pm_ra`` : Proper motion in Right Ascension (rad/yr, East positive) - ``pm_raErr`` : Error in ``pm_ra`` (rad/yr), optional. - ``pm_dec`` : Proper motion in Declination (rad/yr, North positive) - ``pm_decErr`` : Error in ``pm_dec`` (rad/yr), optional. - ``epoch`` : Mean epoch of object (an astropy.time.Time) epoch : `astropy.time.Time` Epoch to which to correct proper motion. If None, do not apply PM corrections or raise if ``config.requireProperMotion`` is True. Raises ------ RuntimeError Raised if ``config.requireProperMotion`` is set but we cannot apply the proper motion correction for some reason.
Definition at line 197 of file loadReferenceObjects.py.
|
inherited |
Return metadata about the load. This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list. Parameters ---------- bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D` Pixel bounding box. wcs : `lsst.afw.geom.SkyWcs` WCS; used to convert pixel positions to sky coordinates. filterName : `str` or `None`, optional Name of camera filter, or `None` or `""` for the default filter. photoCalib : `None` Deprecated, only included for api compatibility. epoch : `astropy.time.Time` or `None`, optional Epoch to which to correct proper motion and parallax, or None to not apply such corrections. Returns ------- metadata : `lsst.daf.base.PropertyList` Metadata about the load.
Definition at line 1301 of file loadReferenceObjects.py.
|
inherited |
Return metadata about the load. This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list. Parameters ---------- coord : `lsst.geom.SpherePoint` ICRS center of the search region. radius : `lsst.geom.Angle` Radius of the search region. filterName : `str` Name of camera filter, or `None` or `""` for the default filter. photoCalib : `None` Deprecated, only included for api compatibility. epoch : `astropy.time.Time` (optional) Epoch to which to correct proper motion and parallax, or `None` to not apply such corrections. Returns ------- metadata : lsst.daf.base.PropertyList Metadata about the load
Definition at line 1330 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.getShards | ( | self, | |
shardIdList | |||
) |
Get shards by ID. Parameters ---------- shardIdList : `list` of `int` A list of integer shard ids. Returns ------- catalogs : `list` of `lsst.afw.table.SimpleCatalog` A list of reference catalogs, one for each entry in shardIdList.
Definition at line 125 of file loadIndexedReferenceObjects.py.
|
inherited |
Relink an unpersisted match list to sources and reference objects. A match list is persisted and unpersisted as a catalog of IDs produced by afw.table.packMatches(), with match metadata (as returned by the astrometry tasks) in the catalog's metadata attribute. This method converts such a match catalog into a match list, with links to source records and reference object records. Parameters ---------- matchCat : `lsst.afw.table.BaseCatalog` Unperisted packed match list. ``matchCat.table.getMetadata()`` must contain match metadata, as returned by the astrometry tasks. sourceCat : `lsst.afw.table.SourceCatalog` Source catalog. As a side effect, the catalog will be sorted by ID. Returns ------- matchList : `lsst.afw.table.ReferenceMatchVector` Match list.
Definition at line 1366 of file loadReferenceObjects.py.
|
inherited |
Load reference objects that overlap a rectangular pixel region. Parameters ---------- bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D` Bounding box for pixels. wcs : `lsst.afw.geom.SkyWcs` WCS; used to convert pixel positions to sky coordinates and vice-versa. filterName : `str` or `None`, optional Name of filter, or `None` or `""` for the default filter. This is used for flux values in case we have flux limits (which are not yet implemented). photoCalib : `None` Deprecated, only included for api compatibility. epoch : `astropy.time.Time` or `None`, optional Epoch to which to correct proper motion and parallax, or `None` to not apply such corrections. Returns ------- results : `lsst.pipe.base.Struct` A Struct containing the following fields: refCat : `lsst.afw.catalog.SimpleCatalog` A catalog of reference objects with the standard schema, as documented in the main doc string for `LoadReferenceObjects`. The catalog is guaranteed to be contiguous. fluxField : `str` Name of flux field for specified `filterName`. Notes ----- The search algorithm works by searching in a region in sky coordinates whose center is the center of the bbox and radius is large enough to just include all 4 corners of the bbox. Stars that lie outside the bbox are then trimmed from the list.
Definition at line 919 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.loadSkyCircle | ( | self, | |
ctrCoord, | |||
radius, | |||
filterName = None , |
|||
epoch = None , |
|||
centroids = False |
|||
) |
Load reference objects that overlap a circular sky region. Parameters ---------- ctrCoord : `lsst.geom.SpherePoint` ICRS center of search region. radius : `lsst.geom.Angle` Radius of search region. filterName : `str` or `None`, optional Name of filter, or `None` or `""` for the default filter. This is used for flux values in case we have flux limits (which are not yet implemented). epoch : `astropy.time.Time` or `None`, optional Epoch to which to correct proper motion and parallax, or `None` to not apply such corrections. centroids : `bool`, optional Add centroid fields to the loaded Schema. ``loadPixelBox`` expects these fields to exist. Returns ------- results : `lsst.pipe.base.Struct` A Struct containing the following fields: refCat : `lsst.afw.catalog.SimpleCatalog` A catalog of reference objects with the standard schema, as documented in the main doc string for `LoadReferenceObjects`. The catalog is guaranteed to be contiguous. fluxField : `str` Name of flux field for specified `filterName`. Notes ----- Note that subclasses are responsible for performing the proper motion correction, since this is the lowest-level interface for retrieving the catalog.
Reimplemented from lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.
Definition at line 65 of file loadIndexedReferenceObjects.py.
|
staticinherited |
Make a standard schema for reference object catalogs. Parameters ---------- filterNameList : `list` of `str` List of filter names. Used to create <filterName>_flux fields. addIsPhotometric : `bool` If True then add field "photometric". addIsResolved : `bool` If True then add field "resolved". addIsVariable : `bool` If True then add field "variable". coordErrDim : `int` Number of coord error fields; must be one of 0, 2, 3: - If 2 or 3: add fields "coord_raErr" and "coord_decErr". - If 3: also add field "coord_radecErr". addProperMotion : `bool` If True add fields "epoch", "pm_ra", "pm_dec" and "pm_flag". properMotionErrDim : `int` Number of proper motion error fields; must be one of 0, 2, 3; ignored if addProperMotion false: - If 2 or 3: add fields "pm_raErr" and "pm_decErr". - If 3: also add field "pm_radecErr". addParallax : `bool` If True add fields "epoch", "parallax", "parallaxErr" and "parallax_flag". Returns ------- schema : `lsst.afw.table.Schema` Schema for reference catalog, an `lsst.afw.table.SimpleCatalog`. Notes ----- Reference catalogs support additional covariances, such as covariance between RA and proper motion in declination, that are not supported by this method, but can be added after calling this method.
Definition at line 1114 of file loadReferenceObjects.py.
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.butler |
Definition at line 62 of file loadIndexedReferenceObjects.py.
|
static |
Definition at line 52 of file loadIndexedReferenceObjects.py.
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.dataset_config |
Definition at line 57 of file loadIndexedReferenceObjects.py.
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.indexer |
Definition at line 58 of file loadIndexedReferenceObjects.py.
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.ref_dataset_name |
Definition at line 61 of file loadIndexedReferenceObjects.py.