ReserveIsolatedStarsTask¶
ReserveIsolatedStarsTask
is a simple task to generate a consistent selection of reserved stars.
Processing summary¶
ReserveIsolatedStarsTask
uses a hashed string to generate a random seed to select a random subset of the total number of stars.
The hash is generated from the lower 32 bits of the SHA-256 hash of a combination of the configured reserve_name
and an optional extra
string.
In this way, consistent reserve selections can be done based on human-readable names, bands, etc, rather than relying on hard-to-remember numbers.
The return value is a boolean array of the desired length, with reserve_fraction
of the array set to True
.
Python API summary¶
from lsst.pipe.tasks.reserveIsolatedStars import ReserveIsolatedStarsTask
-
class
(config: Optional[Config] = None, name: Optional[str] = None, parentTask: Optional[Task] = None, log: Optional[Union[logging.Logger, lsst.utils.logging.LsstLogAdapter]] = None)ReserveIsolatedStarsTask
Reserve isolated stars with repeatable hash
...
-
attribute
config
Access configuration fields and retargetable subtasks.
-
method
(nstar, extra='')run
Retrieve a selection of reserved stars
...
See also
See the ReserveIsolatedStarsTask
API reference for complete details.