Inheritance diagram for lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Detailed Description
Definition at line 274 of file convertReferenceCatalog.py.
Member Function Documentation
◆ setDefaults()
| lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.setDefaults | ( | self | ) |
Definition at line 414 of file convertReferenceCatalog.py.
414 def setDefaults(self):
415 # Newly ingested reference catalogs always have the latest format_version.
416 self.dataset_config.format_version = LATEST_FORMAT_VERSION
417 # gen3 refcats are all depth=7
418 self.dataset_config.indexer['HTM'].depth = 7
419
◆ validate()
| lsst.meas.algorithms.convertReferenceCatalog.ConvertReferenceCatalogConfig.validate | ( | self | ) |
Definition at line 420 of file convertReferenceCatalog.py.
420 def validate(self):
421 super().validate()
422
423 def assertAllOrNone(*names):
424 """Raise ValueError unless all the named fields are set or are
425 all none (or blank).
426 """
427 setNames = [name for name in names if bool(getattr(self, name))]
428 if len(setNames) in (len(names), 0):
429 return
430 prefix = "Both or neither" if len(names) == 2 else "All or none"
431 raise ValueError("{} of {} must be set, but only {} are set".format(
432 prefix, ", ".join(names), ", ".join(setNames)))
433
434 if not (self.ra_name and self.dec_name and self.mag_column_list):
435 raise ValueError(
436 "ra_name and dec_name and at least one entry in mag_column_list must be supplied.")
437 if self.mag_err_column_map and set(self.mag_column_list) != set(self.mag_err_column_map.keys()):
438 raise ValueError(
439 "mag_err_column_map specified, but keys do not match mag_column_list: {} != {}".format(
440 sorted(self.mag_err_column_map.keys()), sorted(self.mag_column_list)))
441 assertAllOrNone("ra_err_name", "dec_err_name", "coord_err_unit")
442 if self.coord_err_unit is not None:
443 result = astropy.units.Unit(self.coord_err_unit, parse_strict='silent')
444 if isinstance(result, astropy.units.UnrecognizedUnit):
445 msg = f"{self.coord_err_unit} is not a valid astropy unit string."
446 raise pexConfig.FieldValidationError(ConvertReferenceCatalogConfig.coord_err_unit, self, msg)
447
448 assertAllOrNone("epoch_name", "epoch_format", "epoch_scale")
449 assertAllOrNone("pm_ra_name", "pm_dec_name")
450 assertAllOrNone("pm_ra_err_name", "pm_dec_err_name")
451 assertAllOrNone("parallax_name", "parallax_err_name")
452 if self.pm_ra_err_name and not self.pm_ra_name:
453 raise ValueError('"pm_ra/dec_name" must be specified if "pm_ra/dec_err_name" are specified')
454 if (self.pm_ra_name or self.parallax_name) and not self.epoch_name:
455 raise ValueError(
456 '"epoch_name" must be specified if "pm_ra/dec_name" or "parallax_name" are specified')
457
458 # Need all the error field names set if we are including covariances.
459 if self.full_position_information:
460 # Since full_position_information is True, this will only pass for
461 # the "All" case.
462 assertAllOrNone("full_position_information",
463 "ra_err_name", "dec_err_name", "coord_err_unit",
464 "epoch_name", "epoch_format", "epoch_scale",
465 "pm_ra_name", "pm_dec_name",
466 "pm_ra_err_name", "pm_dec_err_name",
467 "parallax_name", "parallax_err_name"
468 )
469
470
Member Data Documentation
◆ 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 310 of file convertReferenceCatalog.py.
◆ dataset_config
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=DatasetConfig,
doc="Configuration for reading the ingested data",
)
Definition at line 275 of file convertReferenceCatalog.py.
◆ dec_err_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of Dec error column",
optional=True,
)
Definition at line 305 of file convertReferenceCatalog.py.
◆ dec_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of Dec column (values in decimal degrees)",
)
Definition at line 296 of file convertReferenceCatalog.py.
◆ 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 398 of file convertReferenceCatalog.py.
◆ epoch_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of epoch column",
optional=True,
)
Definition at line 393 of file convertReferenceCatalog.py.
◆ 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 403 of file convertReferenceCatalog.py.
◆ extra_col_names
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc='Extra columns to add to the reference catalog.'
)
Definition at line 408 of file convertReferenceCatalog.py.
◆ 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 288 of file convertReferenceCatalog.py.
◆ 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 386 of file convertReferenceCatalog.py.
◆ id_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
optional=True,
doc='Name of column to use as an identifier (optional).'
)
Definition at line 341 of file convertReferenceCatalog.py.
◆ 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 326 of file convertReferenceCatalog.py.
◆ 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 331 of file convertReferenceCatalog.py.
◆ 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 336 of file convertReferenceCatalog.py.
◆ 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 315 of file convertReferenceCatalog.py.
◆ 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 320 of file convertReferenceCatalog.py.
◆ 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 284 of file convertReferenceCatalog.py.
◆ n_processes
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc=("Number of python processes to use when ingesting."),
default=1
)
Definition at line 279 of file convertReferenceCatalog.py.
◆ parallax_err_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of parallax error column",
optional=True,
)
Definition at line 376 of file convertReferenceCatalog.py.
◆ parallax_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of parallax column",
optional=True,
)
Definition at line 371 of file convertReferenceCatalog.py.
◆ 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 381 of file convertReferenceCatalog.py.
◆ pm_dec_err_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion Dec error column",
optional=True,
)
Definition at line 361 of file convertReferenceCatalog.py.
◆ pm_dec_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion Dec column",
optional=True,
)
Definition at line 351 of file convertReferenceCatalog.py.
◆ pm_ra_err_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion RA error column",
optional=True,
)
Definition at line 356 of file convertReferenceCatalog.py.
◆ pm_ra_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of proper motion RA column",
optional=True,
)
Definition at line 346 of file convertReferenceCatalog.py.
◆ 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 366 of file convertReferenceCatalog.py.
◆ ra_err_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of RA error column",
optional=True,
)
Definition at line 300 of file convertReferenceCatalog.py.
◆ ra_name
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of RA column (values in decimal degrees)",
)
Definition at line 292 of file convertReferenceCatalog.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+0433e6603d/python/lsst/meas/algorithms/convertReferenceCatalog.py
