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

Public Member Functions
	run (self, filename)

Static Public Attributes
	ConfigClass = ReadFitsCatalogConfig

Static Protected Attributes
str	_DefaultName = 'readCatalog'

Detailed Description

Read an object catalog from a FITS table

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 47 of file readFitsCatalogTask.py.

Member Function Documentation

◆ run()

lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask.run	(		self,
			filename )

Read an object catalog from the specified FITS file

Parameters
----------
filename : `str`
    Path to specified FITS file

Returns
-------
table : `np.array`
    a numpy structured array containing the specified columns

Definition at line 57 of file readFitsCatalogTask.py.

    def run(self, filename):
        """Read an object catalog from the specified FITS file
 
        Parameters
        ----------
        filename : `str`
            Path to specified FITS file
 
        Returns
        -------
        table : `np.array`
            a numpy structured array containing the specified columns
        """
 
        # Set character_as_bytes=False to ensure that all string columns are
        # set to python string types rather than byte arrays.
        table = Table.read(filename, hdu=self.config.hdu, character_as_bytes=False)
        if table is None:
            raise RuntimeError("No data found in %s HDU %s" % (filename, self.config.hdu))
 
        if not self.config.column_map:
            # take the data as it is
            return table.as_array()
 
        missingnames = set(self.config.column_map.keys()) - set(table.columns.keys())
        if missingnames:
            raise RuntimeError("Columns %s in column_map were not found in %s" % (missingnames, filename))
 
        for inname, outname in self.config.column_map.items():
            table.columns[inname].name = outname
        return table.as_array()

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.readFitsCatalogTask.ReadFitsCatalogTask._DefaultName = 'readCatalog'

staticprotected

Definition at line 54 of file readFitsCatalogTask.py.

◆ ConfigClass

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

static

Definition at line 55 of file readFitsCatalogTask.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+889fc9d533/python/lsst/meas/algorithms/readFitsCatalogTask.py

Public Member Functions