lsst.meas.algorithms  18.1.0
Public Member Functions | Static 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:

Public Member Functions

def __init__ (self, args, kwargs)
 
def createIndexedCatalog (self, files)
 
def getCatalog (self, dataId, schema)
 
def makeSchema (self, dtype)
 

Static Public Member Functions

def computeCoord (row, ra_name, dec_name)
 

Public Attributes

 butler
 
 indexer
 

Static Public Attributes

bool canMultiprocess = False
 
 ConfigClass = IngestIndexedReferenceConfig
 
 RunnerClass = IngestReferenceRunner
 

Detailed Description

Class for producing and loading indexed reference catalogs.

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, RA error and Dec error are all 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. Gaia is a well
    known example of a catalog that has such terms, and thus should not
    be ingested with this task.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler for reading and writing catalogs

Definition at line 273 of file ingestIndexReferenceTask.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 312 of file ingestIndexReferenceTask.py.

Member Function Documentation

◆ computeCoord()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.computeCoord (   row,
  ra_name,
  dec_name 
)
static
Create an ICRS coord. from a row of a catalog being ingested.

Parameters
----------
row : structured `numpy.array`
    Row from catalog being ingested.
ra_name : `str`
    Name of RA key in catalog being ingested.
dec_name : `str`
    Name of Dec key in catalog being ingested.

Returns
-------
coord : `lsst.geom.SpherePoint`
    ICRS coordinate.

Definition at line 355 of file ingestIndexReferenceTask.py.

◆ createIndexedCatalog()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.createIndexedCatalog (   self,
  files 
)
Index a set of files comprising a reference catalog.

Outputs are persisted in the data repository.

Parameters
----------
files : `list`
    A list of file paths to read.

Definition at line 319 of file ingestIndexReferenceTask.py.

◆ getCatalog()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.getCatalog (   self,
  dataId,
  schema 
)
Get a catalog from the butler or create it if it doesn't exist.

Parameters
----------
dataId : `dict`
    Identifier for catalog to retrieve
schema : `lsst.afw.table.Schema`
    Schema to use in catalog creation if the butler can't get it

Returns
-------
catalog : `lsst.afw.table.SimpleCatalog`
    The catalog specified by `dataId`

Definition at line 519 of file ingestIndexReferenceTask.py.

◆ makeSchema()

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

Member Data Documentation

◆ butler

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.butler

Definition at line 313 of file ingestIndexReferenceTask.py.

◆ canMultiprocess

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

Definition at line 295 of file ingestIndexReferenceTask.py.

◆ ConfigClass

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.ConfigClass = IngestIndexedReferenceConfig
static

Definition at line 296 of file ingestIndexReferenceTask.py.

◆ indexer

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.indexer

Definition at line 315 of file ingestIndexReferenceTask.py.

◆ RunnerClass

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.RunnerClass = IngestReferenceRunner
static

Definition at line 297 of file ingestIndexReferenceTask.py.


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