LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 given value.
36 
37  In order for this method to return the correct result, it must be sorted by parent
38  (i.e. self.isSorted(SourceTable.getParentKey()) must be True). This is naturally the
39  case with SourceCatalogs produced by the detection and deblending tasks, but it may
40  not be true when concatenating multiple such catalogs.
41 
42  Additional Catalogs or sequences whose elements correspond in order to the records
43  of self (i.e. zip(self, *args) is valid) will be subset using the same slice object
44  used on self, and these subsets will be returned along with the subset of self.
45 
46  Parameters
47  ----------
48  parent : `int`
49  ID of the parent to get children for.
50  args : `~lsst.afw.table.Catalog`
51  Additional catalogs to subset for the childrens to return.
52 
53  Returns
54  -------
55  children : iterable of `~lsst.afw.table.SourceRecord`
56  Children sources.
57  """
58  if not self.isSorted(SourceTable.getParentKey()):
59  raise AssertionError(
60  "The table is not sorted by parent, so cannot getChildren")
61  s = self.equal_range(parent, SourceTable.getParentKey())
62  if args:
63  return (self[s],) + tuple(arg[s] for arg in args)
64  else:
65  return self[s]
66 
The documentation for this class was generated from the following file:
Generated on Sat Nov 16 2019 09:15:30 for LSSTApplications by   doxygen 1.8.13