lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.ingestIndexReferenceTask.IngestIndexedReferenceConfig:

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
	epoch_name
	epoch_format
	epoch_scale
	extra_col_names

Detailed Description

For gen2 backwards compatibility.

Definition at line 299 of file ingestIndexReferenceTask.py.

Member Function Documentation

setDefaults()

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

inherited

Definition at line 254 of file ingestIndexReferenceTask.py.

    def setDefaults(self):
        # Newly ingested reference catalogs always have the latest format_version.
        self.dataset_config.format_version = LATEST_FORMAT_VERSION
        # gen3 refcats are all depth=7
        self.dataset_config.indexer['HTM'].depth = 7
 

validate()

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

inherited

Definition at line 260 of file ingestIndexReferenceTask.py.

    def validate(self):
        pexConfig.Config.validate(self)
 
        def assertAllOrNone(*names):
            """Raise ValueError unless all the named fields are set or are
            all none (or blank)
            """
            setNames = [name for name in names if bool(getattr(self, name))]
            if len(setNames) in (len(names), 0):
                return
            prefix = "Both or neither" if len(names) == 2 else "All or none"
            raise ValueError("{} of {} must be set, but only {} are set".format(
                prefix, ", ".join(names), ", ".join(setNames)))
 
        if not (self.ra_name and self.dec_name and self.mag_column_list):
            raise ValueError(
                "ra_name and dec_name and at least one entry in mag_column_list must be supplied.")
        if self.mag_err_column_map and set(self.mag_column_list) != set(self.mag_err_column_map.keys()):
            raise ValueError(
                "mag_err_column_map specified, but keys do not match mag_column_list: {} != {}".format(
                    sorted(self.mag_err_column_map.keys()), sorted(self.mag_column_list)))
        assertAllOrNone("ra_err_name", "dec_err_name", "coord_err_unit")
        if self.coord_err_unit is not None:
            result = astropy.units.Unit(self.coord_err_unit, parse_strict='silent')
            if isinstance(result, astropy.units.UnrecognizedUnit):
                msg = f"{self.coord_err_unit} is not a valid astropy unit string."
                raise pexConfig.FieldValidationError(IngestIndexedReferenceConfig.coord_err_unit, self, msg)
 
        assertAllOrNone("epoch_name", "epoch_format", "epoch_scale")
        assertAllOrNone("pm_ra_name", "pm_dec_name")
        assertAllOrNone("pm_ra_err_name", "pm_dec_err_name")
        assertAllOrNone("parallax_name", "parallax_err_name")
        if self.pm_ra_err_name and not self.pm_ra_name:
            raise ValueError('"pm_ra/dec_name" must be specified if "pm_ra/dec_err_name" are specified')
        if (self.pm_ra_name or self.parallax_name) and not self.epoch_name:
            raise ValueError(
                '"epoch_name" must be specified if "pm_ra/dec_name" or "parallax_name" are specified')
 
 

Member Data Documentation

coord_err_unit

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.coord_err_unit

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Unit of RA/Dec error fields (astropy.unit.Unit compatible)",
        optional=True
    )

Definition at line 157 of file ingestIndexReferenceTask.py.

dataset_config

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.dataset_config

staticinherited

Initial value:

=  pexConfig.ConfigField(
        dtype=DatasetConfig,
        doc="Configuration for reading the ingested data",
    )

Definition at line 122 of file ingestIndexReferenceTask.py.

dec_err_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.dec_err_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of Dec error column",
        optional=True,
    )

Definition at line 152 of file ingestIndexReferenceTask.py.

dec_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.dec_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of Dec column (values in decimal degrees)",
    )

Definition at line 143 of file ingestIndexReferenceTask.py.

epoch_format

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.epoch_format

staticinherited

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 238 of file ingestIndexReferenceTask.py.

epoch_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.epoch_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of epoch column",
        optional=True,
    )

Definition at line 233 of file ingestIndexReferenceTask.py.

epoch_scale

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.epoch_scale

staticinherited

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 243 of file ingestIndexReferenceTask.py.

extra_col_names

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.extra_col_names

staticinherited

Initial value:

=  pexConfig.ListField(
        dtype=str,
        default=[],
        doc='Extra columns to add to the reference catalog.'
    )

Definition at line 248 of file ingestIndexReferenceTask.py.

file_reader

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.file_reader

staticinherited

Initial value:

=  pexConfig.ConfigurableField(
        target=ReadTextCatalogTask,
        doc='Task to use to read the files.  Default is to expect text files.'
    )

Definition at line 135 of file ingestIndexReferenceTask.py.

id_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.id_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        optional=True,
        doc='Name of column to use as an identifier (optional).'
    )

Definition at line 188 of file ingestIndexReferenceTask.py.

is_photometric_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.is_photometric_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        optional=True,
        doc='Name of column stating if satisfactory for photometric calibration (optional).'
    )

Definition at line 173 of file ingestIndexReferenceTask.py.

is_resolved_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.is_resolved_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        optional=True,
        doc='Name of column stating if the object is resolved (optional).'
    )

Definition at line 178 of file ingestIndexReferenceTask.py.

is_variable_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.is_variable_name

staticinherited

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 183 of file ingestIndexReferenceTask.py.

mag_column_list

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.mag_column_list

staticinherited

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 162 of file ingestIndexReferenceTask.py.

mag_err_column_map

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.mag_err_column_map

staticinherited

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 167 of file ingestIndexReferenceTask.py.

manager

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.manager

staticinherited

Initial value:

=  pexConfig.ConfigurableField(
        target=convertRefcatManager.ConvertRefcatManager,
        doc="Multiprocessing manager to perform the actual conversion of values, file-by-file."
    )

Definition at line 131 of file ingestIndexReferenceTask.py.

n_processes

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.n_processes

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc=("Number of python processes to use when ingesting."),
        default=1
    )

Definition at line 126 of file ingestIndexReferenceTask.py.

parallax_err_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.parallax_err_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of parallax error column",
        optional=True,
    )

Definition at line 223 of file ingestIndexReferenceTask.py.

parallax_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.parallax_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of parallax column",
        optional=True,
    )

Definition at line 218 of file ingestIndexReferenceTask.py.

parallax_scale

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.parallax_scale

staticinherited

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 228 of file ingestIndexReferenceTask.py.

pm_dec_err_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.pm_dec_err_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of proper motion Dec error column",
        optional=True,
    )

Definition at line 208 of file ingestIndexReferenceTask.py.

pm_dec_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.pm_dec_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of proper motion Dec column",
        optional=True,
    )

Definition at line 198 of file ingestIndexReferenceTask.py.

pm_ra_err_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.pm_ra_err_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of proper motion RA error column",
        optional=True,
    )

Definition at line 203 of file ingestIndexReferenceTask.py.

pm_ra_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.pm_ra_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of proper motion RA column",
        optional=True,
    )

Definition at line 193 of file ingestIndexReferenceTask.py.

pm_scale

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.pm_scale

staticinherited

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 213 of file ingestIndexReferenceTask.py.

ra_err_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.ra_err_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of RA error column",
        optional=True,
    )

Definition at line 147 of file ingestIndexReferenceTask.py.

ra_name

lsst.meas.algorithms.ingestIndexReferenceTask.ConvertReferenceCatalogConfig.ra_name

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Name of RA column (values in decimal degrees)",
    )

Definition at line 139 of file ingestIndexReferenceTask.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/ingestIndexReferenceTask.py