lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask Class Reference

Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask:

Public Member Functions
def	__init__ (self, *args, butler=None, **kwargs)
def	run (self, inputFiles)
def	makeSchema (self, dtype)

Public Attributes
	butler
	indexer

Static Public Attributes
	RunnerClass = IngestReferenceRunner
	ConfigClass = IngestIndexedReferenceConfig
bool	canMultiprocess = False

Detailed Description

Class for producing and loading indexed reference catalogs (gen2 version).

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler for reading and writing catalogs

Definition at line 497 of file ingestIndexReferenceTask.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.__init__	(		self,
		*	args,
			butler = None,
		**	kwargs
	)

Definition at line 519 of file ingestIndexReferenceTask.py.

    def __init__(self, *args, butler=None, **kwargs):
        self.butler = butler
        super().__init__(*args, **kwargs)
 

Member Function Documentation

makeSchema()

def lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.makeSchema (   self,   dtype  )

inherited

Make the schema to use in constructing the persisted catalogs.

Parameters
----------
dtype : `numpy.dtype`
    Data type describing each entry in ``config.extra_col_names``
    for the catalogs being ingested.

Returns
-------
schemaAndKeyMap : `tuple` of (`lsst.afw.table.Schema`, `dict`)
    A tuple containing two items:
    - The schema for the output source catalog.
    - A map of catalog keys to use in filling the record

Definition at line 400 of file ingestIndexReferenceTask.py.

    def makeSchema(self, dtype):
        """Make the schema to use in constructing the persisted catalogs.
 
        Parameters
        ----------
        dtype : `numpy.dtype`
            Data type describing each entry in ``config.extra_col_names``
            for the catalogs being ingested.
 
        Returns
        -------
        schemaAndKeyMap : `tuple` of (`lsst.afw.table.Schema`, `dict`)
            A tuple containing two items:
            - The schema for the output source catalog.
            - A map of catalog keys to use in filling the record
        """
        # make a schema with the standard fields
        schema = LoadReferenceObjectsTask.makeMinimalSchema(
            filterNameList=self.config.mag_column_list,
            addCentroid=False,
            addIsPhotometric=bool(self.config.is_photometric_name),
            addIsResolved=bool(self.config.is_resolved_name),
            addIsVariable=bool(self.config.is_variable_name),
            coordErrDim=2 if bool(self.config.ra_err_name) else 0,
            addProperMotion=2 if bool(self.config.pm_ra_name) else 0,
            properMotionErrDim=2 if bool(self.config.pm_ra_err_name) else 0,
            addParallax=bool(self.config.parallax_name),
        )
        keysToSkip = set(("id", "centroid_x", "centroid_y", "hasCentroid"))
        key_map = {fieldName: schema[fieldName].asKey() for fieldName in schema.getOrderedNames()
                   if fieldName not in keysToSkip}
 
        def addField(name):
            if dtype[name].kind == 'U':
                # dealing with a string like thing.  Need to get type and size.
                at_size = dtype[name].itemsize
                return schema.addField(name, type=str, size=at_size)
            else:
                at_type = dtype[name].type
                return schema.addField(name, at_type)
 
        for col in self.config.extra_col_names:
            key_map[col] = addField(col)
        return schema, key_map
 

run()

def lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.run (   self,   inputFiles  )

inherited

Index a set of files comprising a reference catalog.

Outputs are persisted in the butler repository.

Parameters
----------
inputFiles : `list`
    A list of file paths to read.

Definition at line 332 of file ingestIndexReferenceTask.py.

    def run(self, inputFiles):
        """Index a set of files comprising a reference catalog.
 
        Outputs are persisted in the butler repository.
 
        Parameters
        ----------
        inputFiles : `list`
            A list of file paths to read.
        """
        self._preRun()
        schema, key_map = self._saveMasterSchema(inputFiles[0])
        # create an HTM we can interrogate about pixel ids
        htm = lsst.sphgeom.HtmPixelization(self.indexer.htm.get_depth())
        filenames = self._getButlerFilenames(htm)
        worker = self.config.manager.target(filenames,
                                            self.config,
                                            self.file_reader,
                                            self.indexer,
                                            schema,
                                            key_map,
                                            htm.universe()[0],
                                            addRefCatMetadata,
                                            self.log)
        result = worker.run(inputFiles)
 
        self._persistConfig()
        self._postRun(result)
 

Member Data Documentation

butler

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.butler

Definition at line 520 of file ingestIndexReferenceTask.py.

canMultiprocess

bool lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.canMultiprocess = False

staticinherited

Definition at line 323 of file ingestIndexReferenceTask.py.

ConfigClass

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.ConfigClass = IngestIndexedReferenceConfig

static

Definition at line 506 of file ingestIndexReferenceTask.py.

indexer

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.indexer

inherited

Definition at line 328 of file ingestIndexReferenceTask.py.

RunnerClass

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.RunnerClass = IngestReferenceRunner

static

Definition at line 505 of file ingestIndexReferenceTask.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/ingestIndexReferenceTask.py