lsst.meas.algorithms  22.0.1-24-g3793161d+f9245b0dec
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask Class Reference
Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask:
lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase

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.

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.

◆ 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.

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: