lsst.meas.algorithms ga2680a8a49+142cdb03a3
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig:

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 dataset_config
 
 n_processes
 
 manager
 
 file_reader
 
 ra_name
 
 dec_name
 
 ra_err_name
 
 dec_err_name
 
 coord_err_unit
 
 mag_column_list
 
 mag_err_column_map
 
 is_photometric_name
 
 is_resolved_name
 
 is_variable_name
 
 id_name
 
 pm_ra_name
 
 pm_dec_name
 
 pm_ra_err_name
 
 pm_dec_err_name
 
 pm_scale
 
 parallax_name
 
 parallax_err_name
 
 parallax_scale
 
 full_position_information
 
 epoch_name
 
 epoch_format
 
 epoch_scale
 
 extra_col_names
 

Detailed Description

Definition at line 242 of file convertReferenceCatalog.py.

Member Function Documentation

◆ setDefaults()

def lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.setDefaults (   self)

Definition at line 382 of file convertReferenceCatalog.py.

◆ validate()

def lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.validate (   self)

Definition at line 388 of file convertReferenceCatalog.py.

Member Data Documentation

◆ coord_err_unit

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.coord_err_unit
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Unit of RA/Dec error fields (astropy.unit.Unit compatible)",
optional=True
)

Definition at line 278 of file convertReferenceCatalog.py.

◆ dataset_config

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

Definition at line 243 of file convertReferenceCatalog.py.

◆ dec_err_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.dec_err_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of Dec error column",
optional=True,
)

Definition at line 273 of file convertReferenceCatalog.py.

◆ dec_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.dec_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of Dec column (values in decimal degrees)",
)

Definition at line 264 of file convertReferenceCatalog.py.

◆ epoch_format

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.epoch_format
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Format of epoch column: any value accepted by astropy.time.Time, e.g. 'iso' or 'unix'",
optional=True,
)

Definition at line 366 of file convertReferenceCatalog.py.

◆ epoch_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.epoch_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of epoch column",
optional=True,
)

Definition at line 361 of file convertReferenceCatalog.py.

◆ epoch_scale

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.epoch_scale
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Scale of epoch column: any value accepted by astropy.time.Time, e.g. 'utc'",
optional=True,
)

Definition at line 371 of file convertReferenceCatalog.py.

◆ extra_col_names

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

Definition at line 376 of file convertReferenceCatalog.py.

◆ file_reader

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 256 of file convertReferenceCatalog.py.

◆ full_position_information

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.full_position_information
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Include epoch, proper motions, parallax, and covariances between sky coordinates, proper motion,"
" and parallax in the schema. If true, a custom ``ConvertRefcatManager`` class must exist to"
" compute the output covariances.",
default=False
)

Definition at line 354 of file convertReferenceCatalog.py.

◆ id_name

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

Definition at line 309 of file convertReferenceCatalog.py.

◆ is_photometric_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 294 of file convertReferenceCatalog.py.

◆ is_resolved_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 299 of file convertReferenceCatalog.py.

◆ is_variable_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 304 of file convertReferenceCatalog.py.

◆ mag_column_list

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 283 of file convertReferenceCatalog.py.

◆ mag_err_column_map

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.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 288 of file convertReferenceCatalog.py.

◆ manager

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.manager
static
Initial value:
= pexConfig.ConfigurableField(
target=convertRefcatManager.ConvertRefcatManager,
doc="Multiprocessing manager to perform the actual conversion of values, file-by-file."
)

Definition at line 252 of file convertReferenceCatalog.py.

◆ n_processes

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.n_processes
static
Initial value:
= pexConfig.Field(
dtype=int,
doc=("Number of python processes to use when ingesting."),
default=1
)

Definition at line 247 of file convertReferenceCatalog.py.

◆ parallax_err_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.parallax_err_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of parallax error column",
optional=True,
)

Definition at line 344 of file convertReferenceCatalog.py.

◆ parallax_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.parallax_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of parallax column",
optional=True,
)

Definition at line 339 of file convertReferenceCatalog.py.

◆ parallax_scale

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.parallax_scale
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Scale factor by which to multiply parallax values to obtain units of milliarcsec",
default=1.0,
)

Definition at line 349 of file convertReferenceCatalog.py.

◆ pm_dec_err_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.pm_dec_err_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion Dec error column",
optional=True,
)

Definition at line 329 of file convertReferenceCatalog.py.

◆ pm_dec_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.pm_dec_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion Dec column",
optional=True,
)

Definition at line 319 of file convertReferenceCatalog.py.

◆ pm_ra_err_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.pm_ra_err_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion RA error column",
optional=True,
)

Definition at line 324 of file convertReferenceCatalog.py.

◆ pm_ra_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.pm_ra_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion RA column",
optional=True,
)

Definition at line 314 of file convertReferenceCatalog.py.

◆ pm_scale

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.pm_scale
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Scale factor by which to multiply proper motion values to obtain units of milliarcsec/year",
default=1.0,
)

Definition at line 334 of file convertReferenceCatalog.py.

◆ ra_err_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.ra_err_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of RA error column",
optional=True,
)

Definition at line 268 of file convertReferenceCatalog.py.

◆ ra_name

lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.ra_name
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of RA column (values in decimal degrees)",
)

Definition at line 260 of file convertReferenceCatalog.py.


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