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.

    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]

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/afw/20.0.0-16-gfab17e72e+fdf35455f6/python/lsst/afw/table/_source.py