jwst.associations Package

Association Generator

The Association Generator takes a list of items, an Association Pool, and creates sub-lists of those items depending on each item’s attributes. How the sub-lists are created is defined by Association Rules.

For more, see the documentation overview.

Functions

generate(pool, rules[, version_id])

Generate associations in the pool according to the rules.

libpath(filepath)

Return the full path to the module library.

load_asn(serialized[, format, first, …])

Load an Association from a file or object

Classes

Association([version_id])

Association Base Class

AssociationError

Basic errors related to Associations

AssociationNotAConstraint

No matching constraint found

AssociationNotValidError

Given data structure is not a valid association

AssociationPool([data, masked, names, …])

Association Pool

AssociationRegistry([definition_files, …])

The available assocations

Main([args, pool])

Generate Associations from an Association Pool

ProcessItem(obj)

Items to be processed

ProcessList([items, rules, work_over, …])

A Process list

ProcessQueue

Make a deque iterable and mutable

ProcessQueueSorted([init])

Sort ProcessItem based on work_over

RegistryMarker()

Mark rules, callbacks, and modules for inclusion into a registry

Class Inheritance Diagram

Inheritance diagram of jwst.associations.association.Association, jwst.associations.exceptions.AssociationError, jwst.associations.exceptions.AssociationNotAConstraint, jwst.associations.exceptions.AssociationNotValidError, jwst.associations.pool.AssociationPool, jwst.associations.registry.AssociationRegistry, jwst.associations.main.Main, jwst.associations.lib.process_list.ProcessItem, jwst.associations.lib.process_list.ProcessList, jwst.associations.lib.process_list.ProcessQueue, jwst.associations.lib.process_list.ProcessQueueSorted, jwst.associations.registry.RegistryMarker