lsst.meas.algorithms  20.0.0-7-gc818c6e6+029d0f2626
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask Class Reference

Read an object catalog from a FITS table. More...

Inheritance diagram for lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask:

Public Member Functions

def run (self, filename)
 

Static Public Attributes

 ConfigClass = ReadFitsCatalogConfig
 

Detailed Description

Read an object catalog from a FITS table.

Contents

Description

Read an object catalog from a FITS table. Designed to read foreign catalogs so they can be written out in a form suitable for IngestIndexedReferenceTask.

Task initialisation

Configuration parameters

See ReadFitsCatalogConfig

A complete example of using ReadFitsCatalogTask

Run the following code from the main directory of meas_algorithms:

from lsst.meas.algorithms.readFitsCatalogTask import ReadFitsCatalogTask
filePath = "tests/data/testReadFitsCatalog.fits"
task = ReadFitsCatalogTask()
catalogArray = task.run(filePath)

The resulting catalogArray is a numpy structured array containing fields such as "name", "ra" and "dec" and a few rows of data. For more complicated cases config parameters allow you to rename columns and choose which HDU to read.

Definition at line 54 of file readFitsCatalogTask.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask.run (   self,
  filename 
)
Read an object catalog from the specified FITS file

@param[in] filename  path to FITS file
@return a numpy structured array containing the specified columns

Definition at line 95 of file readFitsCatalogTask.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask.ConfigClass = ReadFitsCatalogConfig
static

Definition at line 93 of file readFitsCatalogTask.py.


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