LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
make_field (cls, doc="Configuration for how to generate catalog IDs from data IDs.") | |
IdGenerator | apply (self, DataCoordinate data_id, **Any kwargs) |
Static Public Attributes | |
release_id | |
n_releases | |
Protected Member Functions | |
DimensionPacker | _make_dimension_packer (self, DataCoordinate data_id) |
Base class for configuration of `IdGenerator` instances. This class is abstract (it cannot use `abc.ABCMeta` due to a metaclass conflict), and it should mostly be considered an implementation detail of how the attributes it defines are included in its concrete derived classes. Derived classes must implemented `_make_dimension_packer`. See `IdGenerator` for usage.
Definition at line 54 of file _id_generator.py.
|
protected |
Abstract hook for building a dimension packer from configuration. Parameters ---------- data_id : `DataCoordinate` The data ID the `IdGenerator` will embed into all IDs. This generally must be a fully-expanded data ID (i.e. have dimension records attached), that identifies the "instrument" or "skymap" dimension, though this requirement may be relaxed for certain dimension packer types. Returns ------- packer : `lsst.daf.butler.DimensionPacker` Object that packs data IDs into integers.
Reimplemented in lsst.meas.base._id_generator.DetectorExposureIdGeneratorConfig, lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig, and lsst.meas.base._id_generator.SkyMapIdGeneratorConfig.
Definition at line 151 of file _id_generator.py.
IdGenerator lsst.meas.base._id_generator.BaseIdGeneratorConfig.apply | ( | self, | |
DataCoordinate | data_id, | ||
**Any | kwargs ) |
Construct an `IdGenerator` instance from this configuration. Parameters ---------- data_id : `DataCoordinate` The data ID the `IdGenerator` will embed into all IDs. This generally must be a fully-expanded data ID (i.e. have dimension records attached), that identifies the "instrument" or "skymap" dimension, though this requirement may be relaxed for certain dimension packer types. **kwargs Additional keyword arguments are interpreted as dimension value pairs to include in the data ID. This may be used to provide constraints on dimensions for which records are not available. Returns ------- id_generator : `IdGenerator` Object that generates integer IDs for catalogs and their rows by embedding the given data ID and a configurably-optional release ID. Notes ----- This method is called `apply` for consistency with the pattern of using `lsst.pex.config.ConfigurableField` and `lsst.pex.config.RegistryField` to construct the objects whose configuration they hold. It doesn't actually use those mechanisms because we have many config classes for the one `IdGenerator` class, instead of the other way around, and as a result a "config as factory" approach works better.
Definition at line 112 of file _id_generator.py.
lsst.meas.base._id_generator.BaseIdGeneratorConfig.make_field | ( | cls, | |
doc = "Configuration for how to generate catalog IDs from data IDs." ) |
Return a config field that holds an instance of this class. Parameters ---------- doc : `str`, optional Documentation for the config field. As this configuration almost always plays the same role in any parent config, the default is usually fine. Returns ------- field : `lsst.pex.config.ConfigField` New config field for instances of this class. Notes ----- This method is provided as a convenience to reduce boilerplate downstream: it typically saves an import or two, and it allows the same usually-appropriate docstring to be reused instead of rewritten each time. It does not need to be used in order to use this config class.
Definition at line 86 of file _id_generator.py.
|
static |
Definition at line 75 of file _id_generator.py.
|
static |
Definition at line 65 of file _id_generator.py.