lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogTask Class Reference

Inheritance diagram for lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogTask:

Public Member Functions
def	run (self, filename)

Static Public Attributes
	ConfigClass = ReadTextCatalogConfig

Detailed Description

Read an object catalog from a text file

Definition at line 59 of file readTextCatalogTask.py.

Member Function Documentation

run()

def lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogTask.run	(		self,
			filename
	)

Read an object catalog from the specified text file

Parameters
----------
filename : `string`
    Path to specified text file

Returns
-------
A numpy structured array containing the specified columns

Definition at line 65 of file readTextCatalogTask.py.

    def run(self, filename):
        """Read an object catalog from the specified text file
 
        Parameters
        ----------
        filename : `string`
            Path to specified text file
 
        Returns
        -------
        A numpy structured array containing the specified columns
        """
        kwargs = {}
        if self.config.colnames:
            kwargs['names'] = self.config.colnames
            # if we specify the column names, then we need to just ignore the header lines.
            kwargs['data_start'] = self.config.header_lines
        else:
            # if we don't specify column names, start the header at this line.
            kwargs['header_start'] = self.config.header_lines
 
        # return a numpy array for backwards compatibility with other readers
        return np.array(Table.read(filename, format=self.config.format,
                                   delimiter=self.config.delimiter,
                                   **kwargs).as_array())

Member Data Documentation

ConfigClass

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogTask.ConfigClass = ReadTextCatalogConfig

static

Definition at line 63 of file readTextCatalogTask.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/readTextCatalogTask.py