LSSTApplications  19.0.0-14-gb0260a2+492360823e,20.0.0+1c463ce1c5,20.0.0+332b39b81b,20.0.0+34a42eae2c,20.0.0+41b643067b,20.0.0+6e3b0e79d6,20.0.0+8558dd3f48,20.0.0+90990fb0e1,20.0.0+b0de6306d8,20.0.0+b290a576ab,20.0.0+b2ea66fa67,20.0.0+c2e041a55f,20.0.0+dcf29472a8,20.0.0+f45b7d88f4,20.0.0+fd13e6d5b6,20.0.0-1-g10df615+0d65e0fd03,20.0.0-1-g253301a+dcf29472a8,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+20a86399e6,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+41b643067b,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+0eaf4f30a3,20.0.0-11-gda4966f+0cec7fe7b8,20.0.0-17-g98646ba4+f780282b58,20.0.0-2-g25c5319+ec537bc764,20.0.0-2-gec03fae+3bc057fb2a,20.0.0-27-g22bab1b+96b59cb0f5,20.0.0-3-gd2e950e+f45b7d88f4,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-5-gac0d578b1+6c871ee35c,20.0.0-5-gfcebe35+d7a723b4eb,20.0.0-6-g01203fff+106a5fd355,20.0.0-7-g3c4151b+2efbc3ed6b,20.0.0-8-g9573cbd+0eaf4f30a3,20.0.0-8-gc2abeef+41b643067b,w.2020.32
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.afw.table._source.SourceCatalog Class Reference

Public Member Functions

def getChildren (self, parent, *args)
 

Static Public Attributes

string reason = 'Use `getSchema().getAliasMap().get("slot_Centroid")` instead. To be removed after 20.0.0.')
 
 hasCentroidSlot
 
 reason
 
 getCentroidKey
 
 getCentroidErrKey
 
 getCentroidFlagKey
 
 getShapeDefinition
 
 hasShapeSlot
 
 getShapeKey
 
 getShapeErrKey
 
 getShapeFlagKey
 

Detailed Description

Definition at line 33 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 35 of file _source.py.

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

Member Data Documentation

◆ getCentroidErrKey

lsst.afw.table._source.SourceCatalog.getCentroidErrKey
static

Definition at line 81 of file _source.py.

◆ getCentroidFlagKey

lsst.afw.table._source.SourceCatalog.getCentroidFlagKey
static

Definition at line 84 of file _source.py.

◆ getCentroidKey

lsst.afw.table._source.SourceCatalog.getCentroidKey
static

Definition at line 78 of file _source.py.

◆ getShapeDefinition

lsst.afw.table._source.SourceCatalog.getShapeDefinition
static

Definition at line 87 of file _source.py.

◆ getShapeErrKey

lsst.afw.table._source.SourceCatalog.getShapeErrKey
static

Definition at line 96 of file _source.py.

◆ getShapeFlagKey

lsst.afw.table._source.SourceCatalog.getShapeFlagKey
static

Definition at line 99 of file _source.py.

◆ getShapeKey

lsst.afw.table._source.SourceCatalog.getShapeKey
static

Definition at line 93 of file _source.py.

◆ hasCentroidSlot

lsst.afw.table._source.SourceCatalog.hasCentroidSlot
static

Definition at line 75 of file _source.py.

◆ hasShapeSlot

lsst.afw.table._source.SourceCatalog.hasShapeSlot
static

Definition at line 90 of file _source.py.

◆ reason [1/2]

string lsst.afw.table._source.SourceCatalog.reason = 'Use `getSchema().getAliasMap().get("slot_Centroid")` instead. To be removed after 20.0.0.')
static

Definition at line 74 of file _source.py.

◆ reason [2/2]

lsst.afw.table._source.SourceCatalog.reason
static

Definition at line 77 of file _source.py.


The documentation for this class was generated from the following file:
lsst::utils.deprecated.deprecate_pybind11
def deprecate_pybind11(obj, reason, version=None, category=FutureWarning)
Definition: deprecated.py:32