FullIdGenerator#

class lsst.meas.base.FullIdGenerator(dimension_packer: DimensionPacker, data_id: DataCoordinate, release_id: int = 0, n_releases: int = 64)#

Bases: IdGenerator

The subclass of IdGenerator that actually includes packed data IDs and release IDs in its generated IDs.

Parameters#

dimension_packerlsst.daf.butler.DimensionPacker: Object that packs data IDs into integers.
data_idlsst.daf.butler.DataCoordinate: Data ID to embed in all generated IDs and random seeds.
release_idint, optional: Release identifier to embed in generated IDs.
n_releasesint, optional: Number of (contiguous, starting from zero) release_id values to reserve space for. One (not zero) is used to reserve no space.

Notes#

Instances of this class should usually be constructed via configuration instead of by calling the constructor directly; see IdGenerator for details.

Attributes Summary

`catalog_id`	The integer identifier for the full catalog with this data ID, not just one of its rows (`int`).
`data_id`	The data ID that will be embedded in all generated IDs (`DataCoordinate`).
`release_id`	The release ID that will embedded in all generated IDs (`int`).

Methods Summary

`arange`(args, *kwargs)	Generate an array of integer IDs for this catalog.
`make_table_id_factory`()	Construct a new `lsst.afw.table.IdFactory` for this catalog.

Attributes Documentation

catalog_id#

data_id#: The data ID that will be embedded in all generated IDs (DataCoordinate).

release_id#: The release ID that will embedded in all generated IDs (int).

Methods Documentation

arange(*args, **kwargs) → ndarray#

Generate an array of integer IDs for this catalog.

All parameters are forwarded to numpy.arange to generate an array of per-catalog counter integers. These are then combined with the catalog_id` to form the returned array.

The IDs generated by arange will be equivalent to those generated by make_table_id_factory (and by extension, make_source_catalog) only if the counter integers start with 1, not 0, because that’s what IdFactory does.

make_table_id_factory() → IdFactory#: Construct a new lsst.afw.table.IdFactory for this catalog.