LSSTApplications  21.0.0+1b62c9342b,21.0.0+45a059f35e,21.0.0-1-ga51b5d4+ceb9cf20a3,21.0.0-2-g103fe59+4d13aff7ba,21.0.0-2-g1367e85+571a348718,21.0.0-2-g2909d54+45a059f35e,21.0.0-2-g45278ab+1b62c9342b,21.0.0-2-g4bc9b9f+ebfe466dad,21.0.0-2-g5242d73+571a348718,21.0.0-2-g54e2caa+07cebfb09d,21.0.0-2-g66bcc37+0b2c5d3971,21.0.0-2-g7f82c8f+08f1f55c36,21.0.0-2-g8dde007+5d1b9cb3f5,21.0.0-2-g8f08a60+73884b2cf5,21.0.0-2-ga326454+08f1f55c36,21.0.0-2-ga63a54e+458e82fbcd,21.0.0-2-gc738bc1+8c4731df06,21.0.0-2-gde069b7+5a8f2956b8,21.0.0-2-ge17e5af+571a348718,21.0.0-2-ge712728+cfa36ee5f9,21.0.0-2-gecfae73+e597808034,21.0.0-2-gfc62afb+571a348718,21.0.0-20-g4449a12+6d1341e0f3,21.0.0-22-gf0532904+1cd928f0c5,21.0.0-3-g4c5b185+c3794955c6,21.0.0-3-g6d51c4a+0b2c5d3971,21.0.0-3-g8076721+5adeb471db,21.0.0-3-gaa929c8+01f4b7cfca,21.0.0-3-gd222c45+afc8332dbe,21.0.0-4-g1383c07+0b2c5d3971,21.0.0-4-g3300ddd+1b62c9342b,21.0.0-4-g5873dc9+9a92674037,21.0.0-4-g8a80011+bd904b6426,21.0.0-5-gcff38f6+844b7f7b93,21.0.0-6-g463d161+18af5fb57b,21.0.0-6-gd3283ba+01f4b7cfca,21.0.0-8-g19111d86+8234efb485,21.0.0-9-g7bed000b9+c7d3cce47e,w.2021.04
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst.afw.table._source.SourceCatalog Class Reference

Public Member Functions

def getChildren (self, parent, *args)
 

Detailed Description

Definition at line 32 of file _source.py.

Member Function Documentation

◆ getChildren()

def lsst.afw.table._source.SourceCatalog.getChildren (   self,
  parent,
args 
)
Return the subset of self for which the parent field equals the
given value.

In order for this method to return the correct result, it must be
sorted by parent (i.e. self.isSorted(SourceTable.getParentKey()) must
be True).  This is naturally the case with SourceCatalogs produced by
the detection and deblending tasks, but it may not be true when
concatenating multiple such catalogs.

Additional Catalogs or sequences whose elements correspond in order to
the records of self (i.e. ``zip(self, *args)`` is valid) will be
subset using the same slice object used on self, and these subsets
will be returned along with the subset of self.

Parameters
----------
parent : `int`
    ID of the parent to get children for.
args : `~lsst.afw.table.Catalog`
    Additional catalogs to subset for the childrens to return.

Returns
-------
children : iterable of `~lsst.afw.table.SourceRecord`
    Children sources.

Definition at line 34 of file _source.py.

34  def getChildren(self, parent, *args):
35  """Return the subset of self for which the parent field equals the
36  given value.
37 
38  In order for this method to return the correct result, it must be
39  sorted by parent (i.e. self.isSorted(SourceTable.getParentKey()) must
40  be True). This is naturally the case with SourceCatalogs produced by
41  the detection and deblending tasks, but it may not be true when
42  concatenating multiple such catalogs.
43 
44  Additional Catalogs or sequences whose elements correspond in order to
45  the records of self (i.e. ``zip(self, *args)`` is valid) will be
46  subset using the same slice object used on self, and these subsets
47  will be returned along with the subset of self.
48 
49  Parameters
50  ----------
51  parent : `int`
52  ID of the parent to get children for.
53  args : `~lsst.afw.table.Catalog`
54  Additional catalogs to subset for the childrens to return.
55 
56  Returns
57  -------
58  children : iterable of `~lsst.afw.table.SourceRecord`
59  Children sources.
60  """
61  if not self.isSorted(SourceTable.getParentKey()):
62  raise AssertionError(
63  "The table is not sorted by parent, so cannot getChildren")
64  s = self.equal_range(parent, SourceTable.getParentKey())
65  if args:
66  return (self[s],) + tuple(arg[s] for arg in args)
67  else:
68  return self[s]

The documentation for this class was generated from the following file: