LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.meas.algorithms.loadReferenceObjects._FilterCatalog Class Reference

Public Member Functions

 __init__ (self, region)
 
 __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 75 of file loadReferenceObjects.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 85 of file loadReferenceObjects.py.

85 def __init__(self, region):
86 self.region = region
87

Member Function Documentation

◆ __call__()

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 88 of file loadReferenceObjects.py.

88 def __call__(self, refCat, catRegion):
89 """This call method on an instance of this class takes in a reference
90 catalog, and the region from which the catalog was generated.
91
92 If the catalog region is entirely contained within the region used to
93 initialize this class, then all the entries in the catalog must be
94 within the region and so the whole catalog is returned.
95
96 If the catalog region is not entirely contained, then the location for
97 each record is tested against the region used to initialize the class.
98 Records which fall inside this region are added to a new catalog, and
99 this catalog is then returned.
100
101 Parameters
102 ---------
103 refCat : `lsst.afw.table.SourceCatalog`
104 SourceCatalog to be filtered.
105 catRegion : `lsst.sphgeom.Region`
106 Region in which the catalog was created
107 """
108 if catRegion.isWithin(self.region):
109 # no filtering needed, region completely contains refcat
110 return refCat
111
112 filteredRefCat = type(refCat)(refCat.table)
113 for record in refCat:
114 if self.region.contains(record.getCoord().getVector()):
115 filteredRefCat.append(record)
116 return filteredRefCat
117
118

Member Data Documentation

◆ region

lsst.meas.algorithms.loadReferenceObjects._FilterCatalog.region

Definition at line 86 of file loadReferenceObjects.py.


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