lsst.meas.algorithms.loadReferenceObjects._FilterCatalog Class Reference

Public Member Functions
def	__init__ (self, region)
def	__call__ (self, refCat, catRegion)

Public Attributes
	region

Detailed Description

This is a private helper class which filters catalogs by
row based on the row being inside the region used to initialize
the class.

Parameters
----------
region : `lsst.sphgeom.Region`
    The spatial region which all objects should lie within

Definition at line 149 of file loadReferenceObjects.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.algorithms.loadReferenceObjects._FilterCatalog.__init__	(		self,
			region
	)

Definition at line 159 of file loadReferenceObjects.py.

    def __init__(self, region):
        self.region = region
 

Member Function Documentation

__call__()

def lsst.meas.algorithms.loadReferenceObjects._FilterCatalog.__call__	(		self,
			refCat,
			catRegion
	)

This call method on an instance of this class takes in a reference
catalog, and the region from which the catalog was generated.

If the catalog region is entirely contained within the region used to
initialize this class, then all the entries in the catalog must be
within the region and so the whole catalog is returned.

If the catalog region is not entirely contained, then the location for
each record is tested against the region used to initialize the class.
Records which fall inside this region are added to a new catalog, and
this catalog is then returned.

Parameters
---------
refCat : `lsst.afw.table.SourceCatalog`
    SourceCatalog to be filtered.
catRegion : `lsst.sphgeom.Region`
    Region in which the catalog was created

Definition at line 162 of file loadReferenceObjects.py.

    def __call__(self, refCat, catRegion):
        """This call method on an instance of this class takes in a reference
        catalog, and the region from which the catalog was generated.
 
        If the catalog region is entirely contained within the region used to
        initialize this class, then all the entries in the catalog must be
        within the region and so the whole catalog is returned.
 
        If the catalog region is not entirely contained, then the location for
        each record is tested against the region used to initialize the class.
        Records which fall inside this region are added to a new catalog, and
        this catalog is then returned.
 
        Parameters
        ---------
        refCat : `lsst.afw.table.SourceCatalog`
            SourceCatalog to be filtered.
        catRegion : `lsst.sphgeom.Region`
            Region in which the catalog was created
        """
        if catRegion.isWithin(self.region):
            # no filtering needed, region completely contains refcat
            return refCat
 
        filteredRefCat = type(refCat)(refCat.table)
        for record in refCat:
            if self.region.contains(record.getCoord().getVector()):
                filteredRefCat.append(record)
        return filteredRefCat
 
 

Member Data Documentation

region

lsst.meas.algorithms.loadReferenceObjects._FilterCatalog.region

Definition at line 160 of file loadReferenceObjects.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/loadReferenceObjects.py