lsst.meas.algorithms g745f638ac9+e09a3f3a79
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase Class Reference
Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase:

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, inputFiles)
 
def makeSchema (self, dtype)
 

Public Attributes

 indexer
 

Static Public Attributes

bool canMultiprocess = False
 
 ConfigClass = ConvertReferenceCatalogConfig
 

Detailed Description

Base class for producing and loading indexed reference catalogs,
shared between gen2 and gen3.

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 no off-diagonal covariance terms, such as covariance
  between RA and Dec, or between PM RA and PM Dec. Support for such
  covariance would have to be added to to the config, including consideration
  of the units in the input catalog.

Definition at line 267 of file ingestIndexReferenceTask.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.__init__ (   self,
args,
**  kwargs 
)

Definition at line 289 of file ingestIndexReferenceTask.py.

Member Function Documentation

◆ makeSchema()

def lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.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 363 of file ingestIndexReferenceTask.py.

◆ run()

def lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.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 295 of file ingestIndexReferenceTask.py.

Member Data Documentation

◆ canMultiprocess

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

Definition at line 286 of file ingestIndexReferenceTask.py.

◆ ConfigClass

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

Definition at line 287 of file ingestIndexReferenceTask.py.

◆ indexer

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogBase.indexer

Definition at line 291 of file ingestIndexReferenceTask.py.


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