generate_per_candidate

jwst.associations.generator.generate_per_candidate.generate_per_candidate(pool, rule_defs, candidate_ids=None, all_candidates=True, discover=False, version_id=None, finalize=True, merge=False, ignore_default=False, dms_enabled=False)[source]

Generate associations in the pool according to the rules.

Parameters:
poolAssociationPool

The pool to generate from.

rule_defslist of file-like or None

The rule definitions to use. None to use the defaults if ignore_default is False.

candidate_idslist of str or None

List of candidates to produce for. If None, do all possible candidates.

all_candidatesbool

Keep associations generated from candidates when in discovery mode.

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.

dms_enabledbool

Flag for DMS processing, True if command-line argument --DMS was used.

Returns:
associationslist

List of Association.

Notes

Refer to the Association Generator documentation for a full description.