lsst.meas.algorithms.testUtils.MockReferenceObjectLoaderFromFiles Class Reference

Inheritance diagram for lsst.meas.algorithms.testUtils.MockReferenceObjectLoaderFromFiles:

Public Member Functions
	__init__ (self, filenames, name='cal_ref_cat', config=None, htmLevel=4)

Protected Member Functions
	_createDataIdsAndRefcats (self, filenames, htmLevel, name)

Detailed Description

A mock of ReferenceObjectLoader using files on disk.

This mock ReferenceObjectLoader uses a set of files on disk to create
mock dataIds and data reference handles that can be accessed
without a butler. The files must be afw catalog files in the reference
catalog format, sharded with HTM pixelization.

Parameters
----------
filenames : `list` [`str`]
    Names of files to use.
config : `lsst.meas.astrom.LoadReferenceObjectsConfig`, optional
    Configuration object if necessary to override defaults.
htmLevel : `int`, optional
    HTM level to use for the loader.

Definition at line 209 of file testUtils.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.algorithms.testUtils.MockReferenceObjectLoaderFromFiles.__init__	(		self,
			filenames,
			name = 'cal_ref_cat',
			config = None,
			htmLevel = 4 )

Definition at line 226 of file testUtils.py.

    def __init__(self, filenames, name='cal_ref_cat', config=None, htmLevel=4):
        dataIds, refCats = self._createDataIdsAndRefcats(filenames, htmLevel, name)
 
        super().__init__(dataIds, refCats, name=name, config=config)
 

Member Function Documentation

_createDataIdsAndRefcats()

lsst.meas.algorithms.testUtils.MockReferenceObjectLoaderFromFiles._createDataIdsAndRefcats ( self, filenames, htmLevel, name )

protected

Create mock dataIds and refcat handles.

Parameters
----------
filenames : `list` [`str`]
    Names of files to use.
htmLevel : `int`
    HTM level to use for the loader.
name : `str`
    Name of reference catalog (for logging).

Returns
-------
dataIds : `list` [`MockRefcatDataId`]
    List of mock dataIds.
refCats : `list` [`lsst.pipe.base.InMemoryDatasetHandle`]
    List of mock deferred dataset handles.

Raises
------
RuntimeError if any file contains sources that cover more than one HTM
    pixel at level ``htmLevel``.

Definition at line 231 of file testUtils.py.

    def _createDataIdsAndRefcats(self, filenames, htmLevel, name):
        """Create mock dataIds and refcat handles.
 
        Parameters
        ----------
        filenames : `list` [`str`]
            Names of files to use.
        htmLevel : `int`
            HTM level to use for the loader.
        name : `str`
            Name of reference catalog (for logging).
 
        Returns
        -------
        dataIds : `list` [`MockRefcatDataId`]
            List of mock dataIds.
        refCats : `list` [`lsst.pipe.base.InMemoryDatasetHandle`]
            List of mock deferred dataset handles.
 
        Raises
        ------
        RuntimeError if any file contains sources that cover more than one HTM
            pixel at level ``htmLevel``.
        """
        pixelization = sphgeom.HtmPixelization(htmLevel)
        htm = esutil.htm.HTM(htmLevel)
 
        dataIds = []
        refCats = []
 
        for filename in filenames:
            cat = afwTable.BaseCatalog.readFits(filename)
 
            ids = htm.lookup_id(np.rad2deg(cat['coord_ra']), np.rad2deg(cat['coord_dec']))
 
            if len(np.unique(ids)) != 1:
                raise RuntimeError(f"File {filename} contains more than one pixel at level {htmLevel}")
 
            dataIds.append(MockRefcatDataId(pixelization.pixel(ids[0])))
            refCats.append(InMemoryDatasetHandle(cat, name=name))
 
        return dataIds, refCats
 
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+3a7c1ac5f1/python/lsst/meas/algorithms/testUtils.py