lsst.meas.algorithms gab1f63e0c6+d9ba7aec41
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.meas.algorithms.convertReferenceCatalog Namespace Reference

Classes

class  ConvertReferenceCatalogConfig
 
class  ConvertReferenceCatalogTask
 
class  DatasetConfig
 

Functions

 addRefCatMetadata (catalog)
 
 _makeSchema (filterNameList, *addCentroid=False, addIsPhotometric=False, addIsResolved=False, addIsVariable=False, fullPositionInformation=False)
 
 _addExtraColumnsToSchema (schema, dtype, extra_col_names, key_map)
 
 build_argparser ()
 
 run_convert (outputDir, configFile, fileglob)
 
 main ()
 

Variables

int LATEST_FORMAT_VERSION = 2
 

Detailed Description

Convert an external reference catalog into the hierarchical triangular mesh
(HTM) sharded LSST-style format, to be ingested into the butler.

Function Documentation

◆ _addExtraColumnsToSchema()

lsst.meas.algorithms.convertReferenceCatalog._addExtraColumnsToSchema ( schema,
dtype,
extra_col_names,
key_map )
protected
Add extra columns to a schema from a numpy dtype.

Note that schema and key_map will be modified in place.

Parameters
----------
schema : `lsst.afw.table.Schema`
    Schema to append extra columns.
dtype : `numpy.dtype`
    Numpy record array dtype.
extra_col_names : `list` [`str`]
    Extra column names to convert from dtype into schema.
key_map : `dict` [`str`, `lsst.afw.table.Key`]
    Mapping from column name to table key.

Definition at line 220 of file convertReferenceCatalog.py.

◆ _makeSchema()

lsst.meas.algorithms.convertReferenceCatalog._makeSchema ( filterNameList,
* addCentroid = False,
addIsPhotometric = False,
addIsResolved = False,
addIsVariable = False,
fullPositionInformation = False )
protected
Make a standard schema for reference object catalogs.

Parameters
----------
filterNameList : `list` of `str`
    List of filter names. Used to create <filterName>_flux fields.
addCentroid : `bool`
    If True then add fields "centroid" and "hasCentroid".
addIsPhotometric : `bool`
    If True then add field "photometric".
addIsResolved : `bool`
    If True then add field "resolved".
addIsVariable : `bool`
    If True then add field "variable".
fullPositionInformation : `bool`
    If True then add epoch, proper motion, and parallax, along with the
    full five-dimensional covariance between ra and dec coordinates,
    proper motion in ra and dec, and parallax.

Returns
-------
schema : `lsst.afw.table.Schema`
    Schema for reference catalog, an
    `lsst.afw.table.SimpleCatalog`.

Definition at line 69 of file convertReferenceCatalog.py.

◆ addRefCatMetadata()

lsst.meas.algorithms.convertReferenceCatalog.addRefCatMetadata ( catalog)
Add metadata to a new (not yet populated) reference catalog.

Parameters
----------
catalog : `lsst.afw.table.SimpleCatalog`
    Catalog to which metadata should be attached.  Will be modified
    in-place.

Definition at line 53 of file convertReferenceCatalog.py.

◆ build_argparser()

lsst.meas.algorithms.convertReferenceCatalog.build_argparser ( )
Construct an argument parser for the ``convertReferenceCatalog`` script.

Returns
-------
argparser : `argparse.ArgumentParser`
    The argument parser that defines the ``convertReferenceCatalog``
    command-line interface.

Definition at line 638 of file convertReferenceCatalog.py.

◆ main()

lsst.meas.algorithms.convertReferenceCatalog.main ( )

Definition at line 699 of file convertReferenceCatalog.py.

◆ run_convert()

lsst.meas.algorithms.convertReferenceCatalog.run_convert ( outputDir,
configFile,
fileglob )
Run `ConvertReferenceCatalogTask` on the input arguments.

Parameters
----------
outputDir : `str`
    Path to write the output files to.
configFile : `str`
    File specifying the ``ConvertReferenceCatalogConfig`` fields.
fileglob : `str`
    Quoted glob for the files to be read in and converted.

Definition at line 665 of file convertReferenceCatalog.py.

Variable Documentation

◆ LATEST_FORMAT_VERSION

int lsst.meas.algorithms.convertReferenceCatalog.LATEST_FORMAT_VERSION = 2

Definition at line 50 of file convertReferenceCatalog.py.