lsst.meas.base g11fdef2535+6944cc2ac5
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.meas.base._id_generator.FullIdGenerator Class Reference
Inheritance diagram for lsst.meas.base._id_generator.FullIdGenerator:
lsst.meas.base._id_generator.IdGenerator

Public Member Functions

def __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)
 

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 435 of file _id_generator.py.

Constructor & Destructor Documentation

◆ __init__()

def 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 458 of file _id_generator.py.

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 486 of file _id_generator.py.

◆ 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 494 of file _id_generator.py.

◆ 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 482 of file _id_generator.py.

◆ 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 471 of file _id_generator.py.

◆ 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 490 of file _id_generator.py.

◆ 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 477 of file _id_generator.py.


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