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.

    def 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.
        """
        if not self.isSorted(SourceTable.getParentKey()):
            raise AssertionError(
                "The table is not sorted by parent, so cannot getChildren")
        s = self.equal_range(parent, SourceTable.getParentKey())
        if args:
            return (self[s],) + tuple(arg[s] for arg in args)
        else:
            return self[s]
 
 
SourceTable.getCentroidDefinition = deprecate_pybind11(

Member Data Documentation

getCentroidErrKey

lsst.afw.table._source.SourceCatalog.getCentroidErrKey

static

Definition at line 78 of file _source.py.

getCentroidFlagKey

lsst.afw.table._source.SourceCatalog.getCentroidFlagKey

static

Definition at line 81 of file _source.py.

getCentroidKey

lsst.afw.table._source.SourceCatalog.getCentroidKey

static

Definition at line 75 of file _source.py.

getShapeDefinition

lsst.afw.table._source.SourceCatalog.getShapeDefinition

static

Definition at line 84 of file _source.py.

getShapeErrKey

lsst.afw.table._source.SourceCatalog.getShapeErrKey

static

Definition at line 93 of file _source.py.

getShapeFlagKey

lsst.afw.table._source.SourceCatalog.getShapeFlagKey

static

Definition at line 96 of file _source.py.

getShapeKey

lsst.afw.table._source.SourceCatalog.getShapeKey

static

Definition at line 90 of file _source.py.

hasCentroidSlot

lsst.afw.table._source.SourceCatalog.hasCentroidSlot

static

Definition at line 72 of file _source.py.

hasShapeSlot

lsst.afw.table._source.SourceCatalog.hasShapeSlot

static

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

reason [2/2]

lsst.afw.table._source.SourceCatalog.reason

static

Definition at line 74 of file _source.py.

---

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

• /j/snowflake/release/lsstsw/stack/1a1d771/Linux64/afw/20.0.0/python/lsst/afw/table/_source.py