lsst.meas.algorithms  22.0.1-29-g401bd7c4+5d2c66e149
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask Class Reference
Inheritance diagram for lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask:
lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase

Public Member Functions

def __init__ (self, *output_dir=None, **kwargs)
 
def run (self, inputFiles)
 
def makeSchema (self, dtype)
 

Public Attributes

 base_dir
 
 output_dir
 
 ingest_table_file
 
 indexer
 

Static Public Attributes

bool canMultiprocess = False
 
 ConfigClass = ConvertReferenceCatalogConfig
 

Detailed Description

Class for producing HTM-indexed reference catalogs from external
catalog data.

Parameters
----------
output_dir : `str`
    The path to write the output files to, in a subdirectory defined by
    ``DatasetConfig.ref_dataset_name``.

Definition at line 40 of file convertReferenceCatalog.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.__init__ (   self,
output_dir = None,
**  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.

◆ 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

◆ base_dir

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.base_dir

Definition at line 56 of file convertReferenceCatalog.py.

◆ canMultiprocess

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

Definition at line 323 of file ingestIndexReferenceTask.py.

◆ ConfigClass

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.ConfigClass = ConvertReferenceCatalogConfig
staticinherited

Definition at line 324 of file ingestIndexReferenceTask.py.

◆ indexer

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.indexer
inherited

Definition at line 328 of file ingestIndexReferenceTask.py.

◆ ingest_table_file

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.ingest_table_file

Definition at line 58 of file convertReferenceCatalog.py.

◆ output_dir

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.output_dir

Definition at line 57 of file convertReferenceCatalog.py.


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