LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
Loading...
Searching...
No Matches
Functions
lsst.afw.table.catalogMatches Namespace Reference

Functions

 makeMapper (sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None)
 
 makeMergedSchema (sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None)
 
 copyIntoCatalog (catalog, target, sourceSchema=None, sourcePrefix=None, targetPrefix=None)
 
 matchesToCatalog (matches, matchMeta)
 
 matchesFromCatalog (catalog, sourceSlotConfig=None)
 
 copyAliasMapWithPrefix (inSchema, outSchema, prefix="")
 
 reindexCatalog (catalog, indices, deep=True)
 

Function Documentation

◆ copyAliasMapWithPrefix()

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.

225def copyAliasMapWithPrefix(inSchema, outSchema, prefix=""):
226 """Copy an alias map from one schema into another.
227
228 This copies the alias map of one schema into another, optionally
229 prepending a prefix to both the "from" and "to" names of the alias
230 (the example use case here is for the "match" catalog created by
231 `lsst.meas.astrom.denormalizeMatches` where prefixes ``src_`` and
232 ``ref_`` are added to the source and reference field entries,
233 respectively).
234
235 Parameters
236 ----------
237 inSchema : `lsst.afw.table.Schema`
238 The input schema whose `lsst.afw.table.AliasMap` is to be
239 copied to ``outSchema``.
240 outSchema : `lsst.afw.table.Schema`
241 The output schema into which the `lsst.afw.table.AliasMap`
242 from ``inSchema`` is to be copied (modified in place).
243 prefix : `str`, optional
244 An optional prefix to add to both the "from" and "to" names
245 of the alias (default is an empty string).
246
247 Returns
248 -------
249 outSchema : `lsst.afw.table.Schema`
250 The output schema with the alias mappings from `inSchema`
251 added.
252 """
253 for k, v in inSchema.getAliasMap().items():
254 outSchema.getAliasMap().set(prefix + k, prefix + v)
255
256 return outSchema
257
258
std::vector< SchemaItem< Flag > > * items
daf::base::PropertySet * set
Definition fits.cc:931

◆ copyIntoCatalog()

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.

94def copyIntoCatalog(catalog, target, sourceSchema=None, sourcePrefix=None, targetPrefix=None):
95 """Copy entries from one Catalog into another.
96
97 Parameters
98 ----------
99 catalog : :py:class:`lsst.afw.table.base.Catalog`
100 Source catalog to be copied from.
101 target : :py:class:`lsst.afw.table.base.Catalog`
102 Target catalog to be copied to (edited in place).
103 sourceSchema : :py:class:`lsst.afw.table.Schema`, optional
104 Schema of source catalog.
105 sourcePrefix : `str`, optional
106 If set, only those keys with that prefix will be copied.
107 targetPrefix : `str`, optional
108 If set, prepend it to the copied (target) key name
109
110 Returns
111 -------
112 target : :py:class:`lsst.afw.table.base.Catalog`
113 Target catalog that is edited in place.
114 """
115 if sourceSchema is None:
116 sourceSchema = catalog.schema
117
118 targetSchema = target.schema
119 target.reserve(len(catalog))
120 for i in range(len(target), len(catalog)):
121 target.addNew()
122
123 if len(catalog) != len(target):
124 raise RuntimeError(f"Length mismatch: {len(catalog)} vs {len(target)}")
125
126 m = makeMapper(sourceSchema, targetSchema, sourcePrefix, targetPrefix)
127 for rFrom, rTo in zip(catalog, target):
128 rTo.assign(rFrom, m)
129
130

◆ makeMapper()

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.

41def makeMapper(sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None):
42 """Create a SchemaMapper between the input source and target schemas.
43
44 Parameters
45 ----------
46 sourceSchema : :py:class:`lsst.afw.table.Schema`
47 Input source schema that fields will be mapped from.
48 targetSchema : :py:class:`lsst.afw.table.Schema`
49 Target schema that fields will be mapped to.
50 sourcePrefix : `str`, optional
51 If set, only those keys with that prefix will be mapped.
52 targetPrefix : `str`, optional
53 If set, prepend it to the mapped (target) key name.
54
55 Returns
56 -------
57 SchemaMapper : :py:class:`lsst.afw.table.SchemaMapper`
58 Mapping between source and target schemas.
59 """
60 m = SchemaMapper(sourceSchema, targetSchema)
61 for key, field in sourceSchema:
62 keyName = field.getName()
63 if sourcePrefix is not None:
64 if not keyName.startswith(sourcePrefix):
65 continue
66 else:
67 keyName = field.getName().replace(sourcePrefix, "", 1)
68 m.addMapping(key, (targetPrefix or "") + keyName)
69 return m
70
71

◆ makeMergedSchema()

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.

72def makeMergedSchema(sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None):
73 """Return a schema that is a deep copy of a mapping between source and target schemas.
74
75 Parameters
76 ----------
77 sourceSchema : :py:class:`lsst.afw.table.Schema`
78 Input source schema that fields will be mapped from.
79 targetSchema : :py:class:`lsst.afw.atable.Schema`
80 Target schema that fields will be mapped to.
81 sourcePrefix : `str`, optional
82 If set, only those keys with that prefix will be mapped.
83 targetPrefix : `str`, optional
84 If set, prepend it to the mapped (target) key name.
85
86 Returns
87 -------
88 schema : :py:class:`lsst.afw.table.Schema`
89 Schema that is the result of the mapping between source and target schemas.
90 """
91 return makeMapper(sourceSchema, targetSchema, sourcePrefix, targetPrefix).getOutputSchema()
92
93

◆ matchesFromCatalog()

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.

187def matchesFromCatalog(catalog, sourceSlotConfig=None):
188 """Generate a list of ReferenceMatches from a Catalog of "unpacked matches".
189
190 Parameters
191 ----------
192 catalog : :py:class:`lsst.afw.table.BaseCatalog`
193 Catalog of matches. Must have schema where reference entries
194 are prefixed with ``ref_`` and source entries are prefixed with
195 ``src_``.
196 sourceSlotConfig : `lsst.meas.base.baseMeasurement.SourceSlotConfig`, optional
197 Configuration for source slots.
198
199 Returns
200 -------
201 matches : :py:class:`lsst.afw.table.ReferenceMatch`
202 List of matches.
203 """
204 refSchema = makeMergedSchema(
205 catalog.schema, SimpleTable.makeMinimalSchema(), sourcePrefix="ref_")
206 refCatalog = SimpleCatalog(refSchema)
207 copyIntoCatalog(catalog, refCatalog, sourcePrefix="ref_")
208
209 srcSchema = makeMergedSchema(
210 catalog.schema, SourceTable.makeMinimalSchema(), sourcePrefix="src_")
211 srcCatalog = SourceCatalog(srcSchema)
212 copyIntoCatalog(catalog, srcCatalog, sourcePrefix="src_")
213
214 if sourceSlotConfig is not None:
215 sourceSlotConfig.setupSchema(srcCatalog.schema)
216
217 matches = []
218 distKey = catalog.schema.find("distance").key
219 for ref, src, cat in zip(refCatalog, srcCatalog, catalog):
220 matches.append(ReferenceMatch(ref, src, cat[distKey]))
221
222 return matches
223
224

◆ matchesToCatalog()

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.

131def matchesToCatalog(matches, matchMeta):
132 """Denormalise matches into a Catalog of "unpacked matches".
133
134 Parameters
135 ----------
136 matches : `~lsst.afw.table.match.SimpleMatch`
137 Unpacked matches, i.e. a list of Match objects whose schema
138 has "first" and "second" attributes which, resepectively,
139 contain the reference and source catalog entries, and a
140 "distance" field (the measured distance between the reference
141 and source objects).
142 matchMeta : `~lsst.daf.base.PropertySet`
143 Metadata for matches (must have .add attribute).
144
145 Returns
146 -------
147 mergedCatalog : :py:class:`lsst.afw.table.BaseCatalog`
148 Catalog of matches (with ``ref_`` and ``src_`` prefix identifiers for
149 referece and source entries, respectively, including alias
150 maps from reference and source catalogs)
151 """
152 if len(matches) == 0:
153 raise RuntimeError("No matches provided.")
154
155 refSchema = matches[0].first.getSchema()
156 srcSchema = matches[0].second.getSchema()
157
158 mergedSchema = makeMergedSchema(refSchema, Schema(), targetPrefix="ref_")
159 mergedSchema = makeMergedSchema(
160 srcSchema, mergedSchema, targetPrefix="src_")
161
162 mergedSchema = copyAliasMapWithPrefix(refSchema, mergedSchema, prefix="ref_")
163 mergedSchema = copyAliasMapWithPrefix(srcSchema, mergedSchema, prefix="src_")
164
165 distKey = mergedSchema.addField(
166 "distance", type=np.float64, doc="Distance between ref and src")
167
168 mergedCatalog = BaseCatalog(mergedSchema)
169 copyIntoCatalog([m.first for m in matches], mergedCatalog,
170 sourceSchema=refSchema, targetPrefix="ref_")
171 copyIntoCatalog([m.second for m in matches], mergedCatalog,
172 sourceSchema=srcSchema, targetPrefix="src_")
173 for m, r in zip(matches, mergedCatalog):
174 r.set(distKey, m.distance)
175
176 # obtain reference catalog name if one is setup
177 try:
178 catalogName = os.path.basename(getPackageDir("astrometry_net_data"))
179 except LookupError:
180 catalogName = "NOT_SET"
181 matchMeta.add("REFCAT", catalogName)
182 mergedCatalog.getTable().setMetadata(matchMeta)
183
184 return mergedCatalog
185
186

◆ reindexCatalog()

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.

259def reindexCatalog(catalog, indices, deep=True):
260 """Apply a numpy index array to an afw Catalog
261
262 Parameters
263 ----------
264 catalog : `lsst.afw.table.SourceCatalog`
265 Catalog to reindex.
266 indices : `numpy.ndarray` of `int`
267 Index array.
268 deep : `bool`
269 Whether or not to make a deep copy of the original catalog.
270
271 Returns
272 -------
273 new : subclass of `lsst.afw.table.BaseCatalog`
274 Reindexed catalog. Records are shallow copies of those in ``catalog``.
275 """
276 new = SourceCatalog(catalog.table.clone() if deep else catalog.table)
277 records = [catalog[int(ii)] for ii in indices]
278 new.extend(records, deep=deep)
279 return new