lsst.meas.algorithms g583670f1f2+5289d273bb
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig:

Static Public Attributes

 header_lines
 
 colnames
 
 delimiter
 
 format
 
 fill_values
 
 replace_missing_floats_with_nan
 

Detailed Description

Definition at line 33 of file readTextCatalogTask.py.

Member Data Documentation

◆ colnames

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.colnames
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc="An ordered list of column names to use in ingesting the catalog. "
"With an empty list, column names will be discovered from the first line "
"after the skipped header lines."
)

Definition at line 39 of file readTextCatalogTask.py.

◆ delimiter

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.delimiter
static
Initial value:
= pexConfig.Field(
dtype=str,
default=',',
doc='Delimiter to use when reading text reference files. Comma is default.'
)

Definition at line 46 of file readTextCatalogTask.py.

◆ fill_values

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.fill_values
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=None,
optional=True,
doc=("A list giving [<match_string>, <fill_value>], which is used to mask"
" the given values in the input file. '0' is suggested for the fill value in order to prevent"
" changing the column datatype. The default behavior is to fill empty data with zeros. See "
"https://docs.astropy.org/en/stable/io/ascii/read.html#bad-or-missing-values for more details."
"Use `replace_missing_floats_with_nan` to change floats to NaN instead of <fill_value>.")
)

Definition at line 57 of file readTextCatalogTask.py.

◆ format

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.format
static
Initial value:
= pexConfig.Field(
dtype=str,
default='csv',
doc=("Format of files to read, from the astropy.table I/O list here:"
"http://docs.astropy.org/en/stable/io/unified.html#built-in-table-readers-writers")
)

Definition at line 51 of file readTextCatalogTask.py.

◆ header_lines

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.header_lines
static
Initial value:
= pexConfig.Field(
dtype=int,
default=0,
doc='Number of lines to skip when reading the text reference file.'
)

Definition at line 34 of file readTextCatalogTask.py.

◆ replace_missing_floats_with_nan

lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig.replace_missing_floats_with_nan
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, replace missing data in float columns with NaN instead of zero. If `fill_values` is "
"set, this parameter with replace the floats identified as missing by `fill_values`, and the fill"
" value from `fill_values` will be overridden with NaN for floats."
)

Definition at line 67 of file readTextCatalogTask.py.


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