lsst.meas.base._id_generator.FullIdGenerator Class Reference

Inheritance diagram for lsst.meas.base._id_generator.FullIdGenerator:

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

Detailed Description

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.

Constructor & Destructor Documentation

__init__()

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.

    ):
        self._bits = _IdGeneratorBits(dimension_packer, n_releases)
        self._release_id = release_id
        self._data_id = data_id.subset(self._bits.packer.dimensions)
        self._packed_data_id = self._bits.packer.pack(self._data_id)
 

Member Function Documentation

__str__()

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.

    def __str__(self) -> str:
        # Docstring inherited.
        return str(self.data_id)
 

arange()

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.

    def arange(self, *args, **kwargs) -> np.ndarray:
        # Docstring inherited.
        lower = super().arange(*args, **kwargs)
        if np.any(lower >= self._bits.n_counters):
            arg_terms = [repr(arg) for arg in args] + [f"{k}={v!r}" for k, v in kwargs.items()]
            raise ValueError(
                f"Integer range from numpy.arange({arg_terms}) has "
                f"{(lower >= self._bits.n_counters).sum()} values that are not "
                f"below the upper bound of {self._bits.n_counters}."
            )
        return lower + self.catalog_id * self._bits.n_counters
 
 
@dataclasses.dataclass

catalog_id()

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.

    def catalog_id(self) -> int:
        # Docstring inherited.
        return self._packed_data_id + self._bits.n_data_ids * self._release_id
 

data_id()

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.

    def data_id(self) -> DataCoordinate:
        """The data ID that will be embedded in all generated IDs
        (`DataCoordinate`)."""
        return self._data_id
 

make_table_id_factory()

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.

    def make_table_id_factory(self) -> IdFactory:
        # Docstring inherited.
        return IdFactory.makeSource(self.catalog_id, self._bits.counter_bits)
 

release_id()

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.

    def release_id(self) -> int:
        """The release ID that will embedded in all generated IDs (`int`)."""
        return self._release_id
 

Member Data Documentation

_bits

lsst.meas.base._id_generator.FullIdGenerator._bits

protected

Definition at line 449 of file _id_generator.py.

_data_id

lsst.meas.base._id_generator.FullIdGenerator._data_id

protected

Definition at line 451 of file _id_generator.py.

_packed_data_id

lsst.meas.base._id_generator.FullIdGenerator._packed_data_id

protected

Definition at line 452 of file _id_generator.py.

_release_id

lsst.meas.base._id_generator.FullIdGenerator._release_id

protected

Definition at line 450 of file _id_generator.py.

catalog_id

lsst.meas.base._id_generator.FullIdGenerator.catalog_id

Definition at line 476 of file _id_generator.py.

data_id

lsst.meas.base._id_generator.FullIdGenerator.data_id

Definition at line 472 of file _id_generator.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g6c1bc301e9+51106c2951/python/lsst/meas/base/_id_generator.py