lsst.meas.base g876c692160+f87cda0c5b
|
Public Member Functions | |
__init__ (self, DimensionPacker dimension_packer, DataCoordinate data_id, int release_id=DEFAULT_RELEASE_ID, int n_releases=DEFAULT_N_RELEASES) | |
DataCoordinate | data_id (self) |
int | release_id (self) |
int | catalog_id (self) |
str | __str__ (self) |
IdFactory | make_table_id_factory (self) |
np.ndarray | arange (self, *args, **kwargs) |
Public Attributes | |
data_id | |
catalog_id | |
Protected Attributes | |
_bits | |
_release_id | |
_data_id | |
_packed_data_id | |
The subclass of `IdGenerator` that actually includes packed data IDs and release IDs in its generated IDs. Parameters ---------- dimension_packer : `lsst.daf.butler.DimensionPacker` Object that packs data IDs into integers. data_id : `lsst.daf.butler.DataCoordinate` Data ID to embed in all generated IDs and random seeds. release_id : `int`, optional Release identifier to embed in generated IDs. n_releases : `int`, 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.
Definition at line 419 of file _id_generator.py.
lsst.meas.base._id_generator.FullIdGenerator.__init__ | ( | self, | |
DimensionPacker | dimension_packer, | ||
DataCoordinate | data_id, | ||
int | release_id = DEFAULT_RELEASE_ID, | ||
int | n_releases = DEFAULT_N_RELEASES ) |
Definition at line 442 of file _id_generator.py.
str lsst.meas.base._id_generator.FullIdGenerator.__str__ | ( | self | ) |
Return a human-readable representation of the data ID (or a note about its absence) for use in log and error messages.
Reimplemented from lsst.meas.base._id_generator.IdGenerator.
Definition at line 470 of file _id_generator.py.
np.ndarray lsst.meas.base._id_generator.FullIdGenerator.arange | ( | self, | |
* | args, | ||
** | kwargs ) |
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 `~lsst.afw.table.IdFactory` does.
Reimplemented from lsst.meas.base._id_generator.IdGenerator.
Definition at line 478 of file _id_generator.py.
int lsst.meas.base._id_generator.FullIdGenerator.catalog_id | ( | self | ) |
The integer identifier for the full catalog with this data ID, not just one of its rows (`int`). This combines the packed data ID and release ID, but not the counter.
Reimplemented from lsst.meas.base._id_generator.IdGenerator.
Definition at line 466 of file _id_generator.py.
DataCoordinate lsst.meas.base._id_generator.FullIdGenerator.data_id | ( | self | ) |
The data ID that will be embedded in all generated IDs (`DataCoordinate`).
Definition at line 455 of file _id_generator.py.
IdFactory lsst.meas.base._id_generator.FullIdGenerator.make_table_id_factory | ( | self | ) |
Construct a new `lsst.afw.table.IdFactory` for this catalog.
Reimplemented from lsst.meas.base._id_generator.IdGenerator.
Definition at line 474 of file _id_generator.py.
int lsst.meas.base._id_generator.FullIdGenerator.release_id | ( | self | ) |
The release ID that will embedded in all generated IDs (`int`).
Definition at line 461 of file _id_generator.py.
|
protected |
Definition at line 449 of file _id_generator.py.
|
protected |
Definition at line 451 of file _id_generator.py.
|
protected |
Definition at line 452 of file _id_generator.py.
|
protected |
Definition at line 450 of file _id_generator.py.
lsst.meas.base._id_generator.FullIdGenerator.catalog_id |
Definition at line 476 of file _id_generator.py.
lsst.meas.base._id_generator.FullIdGenerator.data_id |
Definition at line 472 of file _id_generator.py.