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
Functions
lsst.afw.table.catalogMatches Namespace Reference

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)
 

Function Documentation

◆ copyAliasMapWithPrefix()

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.

225 def 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 
items
std::vector< SchemaItem< Flag > > * items
Definition: BaseColumnView.cc:142
set
daf::base::PropertySet * set
Definition: fits.cc:912
lsst::afw::table.catalogMatches.copyAliasMapWithPrefix
def copyAliasMapWithPrefix(inSchema, outSchema, prefix="")
Definition: catalogMatches.py:225

◆ copyIntoCatalog()

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.

94 def 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 
lsst::afw::table.catalogMatches.makeMapper
def makeMapper(sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None)
Definition: catalogMatches.py:41
lsst::afw::table.catalogMatches.copyIntoCatalog
def copyIntoCatalog(catalog, target, sourceSchema=None, sourcePrefix=None, targetPrefix=None)
Definition: catalogMatches.py:94

◆ makeMapper()

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.

41 def 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()

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.

72 def 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 
lsst::afw::table.catalogMatches.makeMergedSchema
def makeMergedSchema(sourceSchema, targetSchema, sourcePrefix=None, targetPrefix=None)
Definition: catalogMatches.py:72

◆ matchesFromCatalog()

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.

187 def 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 
lsst::afw::table.catalogMatches.matchesFromCatalog
def matchesFromCatalog(catalog, sourceSlotConfig=None)
Definition: catalogMatches.py:187
lsst::afw::table::ReferenceMatch
Match< SimpleRecord, SourceRecord > ReferenceMatch
Definition: fwd.h:104
lsst::afw::table::SourceCatalog
SortedCatalogT< SourceRecord > SourceCatalog
Definition: fwd.h:85
lsst::afw::table::SimpleCatalog
SortedCatalogT< SimpleRecord > SimpleCatalog
Definition: fwd.h:79

◆ matchesToCatalog()

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.

131 def 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 
lsst::afw::table.catalogMatches.matchesToCatalog
def matchesToCatalog(matches, matchMeta)
Definition: catalogMatches.py:131
lsst::afw::table::BaseCatalog
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72
lsst::cpputils::getPackageDir
std::string getPackageDir(std::string const &packageName)
return the root directory of a setup package
Definition: packaging.cc:33

◆ reindexCatalog()

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.

259 def 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
lsst::afw::table.catalogMatches.reindexCatalog
def reindexCatalog(catalog, indices, deep=True)
Definition: catalogMatches.py:259
Generated on Fri Nov 26 2021 10:16:17 for LSST Applications by doxygen 1.9.1