lsst.meas.algorithms  14.0-18-gf7dca964
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask Class Reference

Class for both producing indexed reference catalogs and for loading them. More...

Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask:

Public Member Functions

def __init__ (self, args, kwargs)
 Constructor for the HTM indexing engine. More...
 
def create_indexed_catalog (self, files)
 Index a set of files comprising a reference catalog. More...
 
def get_catalog (self, dataId, schema)
 Get a catalog from the butler or create it if it doesn't exist. More...
 
def make_schema (self, dtype)
 Make the schema to use in constructing the persisted catalogs. More...
 

Static Public Member Functions

def compute_coord (row, ra_name, dec_name)
 Create a afwCoord object from a np.array row. More...
 

Public Attributes

 butler
 
 indexer
 

Static Public Attributes

bool canMultiprocess = False
 
 ConfigClass = IngestIndexedReferenceConfig
 
 RunnerClass = IngestReferenceRunner
 

Detailed Description

Class for both producing indexed reference catalogs and for loading them.

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

Definition at line 139 of file ingestIndexReferenceTask.py.

Constructor & Destructor Documentation

◆ __init__()

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

Constructor for the HTM indexing engine.

Parameters
[in]butlerdafPersistence.Butler object for reading and writing catalogs

Definition at line 164 of file ingestIndexReferenceTask.py.

Member Function Documentation

◆ compute_coord()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.compute_coord (   row,
  ra_name,
  dec_name 
)
static

Create a afwCoord object from a np.array row.

Parameters
[in]rowdict like object with ra/dec info in degrees
[in]ra_namename of RA key
[in]dec_namename of Dec key
[out]IcrsCoordobject constructed from the RA/Dec values

Definition at line 207 of file ingestIndexReferenceTask.py.

◆ create_indexed_catalog()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.create_indexed_catalog (   self,
  files 
)

Index a set of files comprising a reference catalog.

Outputs are persisted in the data repository.

Parameters
[in]filesA list of file names to read.

Definition at line 175 of file ingestIndexReferenceTask.py.

◆ get_catalog()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.get_catalog (   self,
  dataId,
  schema 
)

Get a catalog from the butler or create it if it doesn't exist.

Parameters
[in]dataIdIdentifier for catalog to retrieve
[in]schemaSchema to use in catalog creation if the butler can't get it
[out]afwTable.SourceCatalogfor the specified identifier

Definition at line 284 of file ingestIndexReferenceTask.py.

◆ make_schema()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.make_schema (   self,
  dtype 
)

Make the schema to use in constructing the persisted catalogs.

Parameters
[in]dtypeA np.dtype to use in constructing the schema
[out]Theschema for the output source catalog.
[out]Amap of catalog keys to use in filling the record

Definition at line 295 of file ingestIndexReferenceTask.py.

Member Data Documentation

◆ butler

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.butler

Definition at line 169 of file ingestIndexReferenceTask.py.

◆ canMultiprocess

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

Definition at line 147 of file ingestIndexReferenceTask.py.

◆ ConfigClass

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

Definition at line 148 of file ingestIndexReferenceTask.py.

◆ indexer

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceTask.indexer

Definition at line 171 of file ingestIndexReferenceTask.py.

◆ RunnerClass

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

Definition at line 149 of file ingestIndexReferenceTask.py.


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