lsst.meas.algorithms g04242d3e92+8eaa23c173
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask Class Reference
Inheritance diagram for lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask:

Public Member Functions

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

Public Attributes

 base_dir
 
 output_dir
 
 ingest_table_file
 
 indexer
 
 config
 
 file_reader
 
 log
 

Static Public Attributes

bool canMultiprocess = False
 
 ConfigClass = ConvertReferenceCatalogConfig
 

Protected Member Functions

 _writeIngestHelperFile (self, result)
 
 _writeConfig (self)
 
 _getOutputFilenames (self, htm)
 
 _writeMasterSchema (self, inputfile)
 
 _reduce_kwargs (self)
 

Static Protected Attributes

str _DefaultName = 'ConvertReferenceCatalogTask'
 

Detailed Description

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

This implements an indexing scheme based on hierarchical triangular
mesh (HTM). The term index really means breaking the catalog into
localized chunks called shards.  In this case each shard contains
the entries from the catalog in a single HTM trixel

For producing catalogs this task makes the following assumptions
about the input catalogs:

- RA, Dec are in decimal degrees.
- Epoch is available in a column, in a format supported by astropy.time.Time.
- There are either no off-diagonal covariance terms, or there are all the
  five-dimensional covariance terms (between RA, Dec, proper motion, and
  parallax). In the latter case, a custom ``ConvertRefcatManager`` must
  exist to handle the covariance terms.

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

Definition at line 471 of file convertReferenceCatalog.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.__init__ ( self,
* output_dir = None,
** kwargs )

Definition at line 500 of file convertReferenceCatalog.py.

Member Function Documentation

◆ _getOutputFilenames()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._getOutputFilenames ( self,
htm )
protected
Get filenames from the butler for each output htm pixel.

Parameters
----------
htm : `lsst.sphgeom.HtmPixelization`
    The HTM pixelization scheme to be used to build filenames.

Returns
-------
filenames : `list [str]`
    List of filenames to write each HTM pixel to.

Definition at line 559 of file convertReferenceCatalog.py.

◆ _reduce_kwargs()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._reduce_kwargs ( self)
protected

Definition at line 631 of file convertReferenceCatalog.py.

◆ _writeConfig()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._writeConfig ( self)
protected
Write the config that was used to generate the refcat.

Definition at line 553 of file convertReferenceCatalog.py.

◆ _writeIngestHelperFile()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._writeIngestHelperFile ( self,
result )
protected
Write the astropy table containing the htm->filename relationship,
used for the ``butler ingest-files`` command after this task completes.

Definition at line 543 of file convertReferenceCatalog.py.

◆ _writeMasterSchema()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._writeMasterSchema ( self,
inputfile )
protected
Generate and save the master catalog schema.

Parameters
----------
inputfile : `str`
    An input file to read to get the input dtype.

Definition at line 614 of file convertReferenceCatalog.py.

◆ makeSchema()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.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

Definition at line 581 of file convertReferenceCatalog.py.

◆ run()

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.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.

Definition at line 511 of file convertReferenceCatalog.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask._DefaultName = 'ConvertReferenceCatalogTask'
staticprotected

Definition at line 498 of file convertReferenceCatalog.py.

◆ base_dir

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.base_dir

Definition at line 504 of file convertReferenceCatalog.py.

◆ canMultiprocess

bool lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.canMultiprocess = False
static

Definition at line 496 of file convertReferenceCatalog.py.

◆ config

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.config

Definition at line 530 of file convertReferenceCatalog.py.

◆ ConfigClass

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.ConfigClass = ConvertReferenceCatalogConfig
static

Definition at line 497 of file convertReferenceCatalog.py.

◆ file_reader

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.file_reader

Definition at line 531 of file convertReferenceCatalog.py.

◆ indexer

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.indexer

Definition at line 507 of file convertReferenceCatalog.py.

◆ ingest_table_file

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.ingest_table_file

Definition at line 506 of file convertReferenceCatalog.py.

◆ log

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.log

Definition at line 537 of file convertReferenceCatalog.py.

◆ output_dir

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogTask.output_dir

Definition at line 505 of file convertReferenceCatalog.py.


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