generate_per_pool
- jwst.associations.generator.generate_per_pool.generate_per_pool(pool, rule_defs=None, candidate_ids=None, all_candidates=True, discover=False, version_id=None, finalize=True, merge=False, ignore_default=False)[source]
Generate associations on a specified pool.
Association candidates are filtered based on global constraints added to the rules.
- Parameters:
- pool
AssociationPool The pool to generate from.
- rule_defslist of file-like or None
List of rule definitions to use. None to use the defaults if
ignore_defaultisFalse.- candidate_idslist of str or None
List of candidates to produce for.
- all_candidatesbool
Find associations for all possible candidates.
- discoverbool
Find associations that are not candidate-based.
- version_idNone, True, or str
The string to use to tag associations and products:
If None, no tagging occurs.
If
True, use a timestamp.If a string, the string.
- finalizebool
Run all rule methods marked as ‘finalized’.
- mergebool
Merge single associations into a common association with separate products.
- ignore_defaultbool
Ignore the default rules. Use only the user-specified ones.
- pool
- Returns:
- associationslist
List of
Association.
Notes
Refer to the Association Generator documentation for a full description.