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
ReserveIsolatedStarsTask(config=None, name=None, parentTask=None, log=None) Reserve isolated stars with repeatable hash
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run(nstar, extra='') Retrieve a selection of reserved stars
...
See also
See the ReserveIsolatedStarsTask API reference for complete details.
Configuration fields¶
reserve_fraction¶
- Default
0.1- Field type
- Range
[0.0,1.0]
Fraction of stars to reserve. None if == 0.
reserve_name¶
Name to use for random seed selection hash.