|
lsst.afw g712618294e+4813a5392e
|
Functions | |
| def | makeMapper (sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None) |
| def | makeMergedSchema (sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None) |
| def | copyIntoCatalog (catalog, target, sourceSchema=None, sourcePrefix=None, targetPrefix=None) |
| def | matchesToCatalog (matches, matchMeta) |
| def | matchesFromCatalog (catalog, sourceSlotConfig=None) |
| def | copyAliasMapWithPrefix (inSchema, outSchema, prefix="") |
| def | reindexCatalog (catalog, indices, deep=True) |
| def lsst.afw.table.catalogMatches.copyAliasMapWithPrefix | ( | inSchema, | |
| outSchema, | |||
prefix = "" |
|||
| ) |
Copy an alias map from one schema into another. This copies the alias map of one schema into another, optionally prepending a prefix to both the "from" and "to" names of the alias (the example use case here is for the "match" catalog created by `lsst.meas.astrom.denormalizeMatches` where prefixes ``src_`` and ``ref_`` are added to the source and reference field entries, respectively). Parameters ---------- inSchema : `lsst.afw.table.Schema` The input schema whose `lsst.afw.table.AliasMap` is to be copied to ``outSchema``. outSchema : `lsst.afw.table.Schema` The output schema into which the `lsst.afw.table.AliasMap` from ``inSchema`` is to be copied (modified in place). prefix : `str`, optional An optional prefix to add to both the "from" and "to" names of the alias (default is an empty string). Returns ------- outSchema : `lsst.afw.table.Schema` The output schema with the alias mappings from `inSchema` added.
Definition at line 225 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.copyIntoCatalog | ( | catalog, | |
| target, | |||
sourceSchema = None, |
|||
sourcePrefix = None, |
|||
targetPrefix = None |
|||
| ) |
Copy entries from one Catalog into another.
Parameters
----------
catalog : :py:class:`lsst.afw.table.base.Catalog`
Source catalog to be copied from.
target : :py:class:`lsst.afw.table.base.Catalog`
Target catalog to be copied to (edited in place).
sourceSchema : :py:class:`lsst.afw.table.Schema`, optional
Schema of source catalog.
sourcePrefix : `str`, optional
If set, only those keys with that prefix will be copied.
targetPrefix : `str`, optional
If set, prepend it to the copied (target) key name
Returns
-------
target : :py:class:`lsst.afw.table.base.Catalog`
Target catalog that is edited in place.
Definition at line 94 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.makeMapper | ( | sourceSchema, | |
| targetSchema, | |||
sourcePrefix = None, |
|||
targetPrefix = None |
|||
| ) |
Create a SchemaMapper between the input source and target schemas.
Parameters
----------
sourceSchema : :py:class:`lsst.afw.table.Schema`
Input source schema that fields will be mapped from.
targetSchema : :py:class:`lsst.afw.table.Schema`
Target schema that fields will be mapped to.
sourcePrefix : `str`, optional
If set, only those keys with that prefix will be mapped.
targetPrefix : `str`, optional
If set, prepend it to the mapped (target) key name.
Returns
-------
SchemaMapper : :py:class:`lsst.afw.table.SchemaMapper`
Mapping between source and target schemas.
Definition at line 41 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.makeMergedSchema | ( | sourceSchema, | |
| targetSchema, | |||
sourcePrefix = None, |
|||
targetPrefix = None |
|||
| ) |
Return a schema that is a deep copy of a mapping between source and target schemas.
Parameters
----------
sourceSchema : :py:class:`lsst.afw.table.Schema`
Input source schema that fields will be mapped from.
targetSchema : :py:class:`lsst.afw.atable.Schema`
Target schema that fields will be mapped to.
sourcePrefix : `str`, optional
If set, only those keys with that prefix will be mapped.
targetPrefix : `str`, optional
If set, prepend it to the mapped (target) key name.
Returns
-------
schema : :py:class:`lsst.afw.table.Schema`
Schema that is the result of the mapping between source and target schemas.
Definition at line 72 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.matchesFromCatalog | ( | catalog, | |
sourceSlotConfig = None |
|||
| ) |
Generate a list of ReferenceMatches from a Catalog of "unpacked matches".
Parameters
----------
catalog : :py:class:`lsst.afw.table.BaseCatalog`
Catalog of matches. Must have schema where reference entries
are prefixed with ``ref_`` and source entries are prefixed with
``src_``.
sourceSlotConfig : `lsst.meas.base.baseMeasurement.SourceSlotConfig`, optional
Configuration for source slots.
Returns
-------
matches : :py:class:`lsst.afw.table.ReferenceMatch`
List of matches.
Definition at line 187 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.matchesToCatalog | ( | matches, | |
| matchMeta | |||
| ) |
Denormalise matches into a Catalog of "unpacked matches".
Parameters
----------
matches : `~lsst.afw.table.match.SimpleMatch`
Unpacked matches, i.e. a list of Match objects whose schema
has "first" and "second" attributes which, resepectively,
contain the reference and source catalog entries, and a
"distance" field (the measured distance between the reference
and source objects).
matchMeta : `~lsst.daf.base.PropertySet`
Metadata for matches (must have .add attribute).
Returns
-------
mergedCatalog : :py:class:`lsst.afw.table.BaseCatalog`
Catalog of matches (with ``ref_`` and ``src_`` prefix identifiers for
referece and source entries, respectively, including alias
maps from reference and source catalogs)
Definition at line 131 of file catalogMatches.py.
| def lsst.afw.table.catalogMatches.reindexCatalog | ( | catalog, | |
| indices, | |||
deep = True |
|||
| ) |
Apply a numpy index array to an afw Catalog
Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
Catalog to reindex.
indices : `numpy.ndarray` of `int`
Index array.
deep : `bool`
Whether or not to make a deep copy of the original catalog.
Returns
-------
new : subclass of `lsst.afw.table.BaseCatalog`
Reindexed catalog. Records are shallow copies of those in ``catalog``.
Definition at line 259 of file catalogMatches.py.