lsst.meas.algorithms  14.0-20-gc5946167
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig:

Public Member Functions

def validate (self)
 

Static Public Attributes

 dataset_config
 
 file_reader
 
 ra_name
 
 dec_name
 
 mag_column_list
 
 mag_err_column_map
 
 is_photometric_name
 
 is_resolved_name
 
 is_variable_name
 
 id_name
 
 extra_col_names
 

Detailed Description

Definition at line 76 of file ingestIndexReferenceTask.py.

Member Function Documentation

◆ validate()

def lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.validate (   self)

Definition at line 130 of file ingestIndexReferenceTask.py.

Member Data Documentation

◆ dataset_config

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.dataset_config
static
Initial value:
= pexConfig.ConfigField(
dtype=DatasetConfig,
doc="Configuration for reading the ingested data",
)

Definition at line 77 of file ingestIndexReferenceTask.py.

◆ dec_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.dec_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of Dec column",
)

Definition at line 89 of file ingestIndexReferenceTask.py.

◆ extra_col_names

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.extra_col_names
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc='Extra columns to add to the reference catalog.'
)

Definition at line 124 of file ingestIndexReferenceTask.py.

◆ file_reader

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.file_reader
static
Initial value:
= pexConfig.ConfigurableField(
target=ReadTextCatalogTask,
doc='Task to use to read the files. Default is to expect text files.'
)

Definition at line 81 of file ingestIndexReferenceTask.py.

◆ id_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.id_name
static
Initial value:
= pexConfig.Field(
dtype=str,
optional=True,
doc='Name of column to use as an identifier (optional).'
)

Definition at line 119 of file ingestIndexReferenceTask.py.

◆ is_photometric_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.is_photometric_name
static
Initial value:
= pexConfig.Field(
dtype=str,
optional=True,
doc='Name of column stating if satisfactory for photometric calibration (optional).'
)

Definition at line 104 of file ingestIndexReferenceTask.py.

◆ is_resolved_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.is_resolved_name
static
Initial value:
= pexConfig.Field(
dtype=str,
optional=True,
doc='Name of column stating if the object is resolved (optional).'
)

Definition at line 109 of file ingestIndexReferenceTask.py.

◆ is_variable_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.is_variable_name
static
Initial value:
= pexConfig.Field(
dtype=str,
optional=True,
doc='Name of column stating if the object is measured to be variable (optional).'
)

Definition at line 114 of file ingestIndexReferenceTask.py.

◆ mag_column_list

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.mag_column_list
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="The values in the reference catalog are assumed to be in AB magnitudes. "
"List of column names to use for photometric information. At least one entry is required."
)

Definition at line 93 of file ingestIndexReferenceTask.py.

◆ mag_err_column_map

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.mag_err_column_map
static
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=str,
default={},
doc="A map of magnitude column name (key) to magnitude error column (value)."
)

Definition at line 98 of file ingestIndexReferenceTask.py.

◆ ra_name

lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig.ra_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of RA column",
)

Definition at line 85 of file ingestIndexReferenceTask.py.


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