Main¶
- class jwst.associations.Main(args=None, pool=None)[source]¶
Bases:
object
Generate Associations from an Association Pool
- Parameters:
args ([str, ...], or None) –
The command line arguments. Can be one of
pool (None or AssociationPool) – If
None
, a pool file must be specified in theargs
. Otherwise, anAssociationPool
- rules¶
The rules used for association creation.
- Type:
- associations¶
The list of generated associations.
- Type:
[
Association
, …]
Notes
Refer to the Association Generator documentation for a full description.
Attributes Summary
The pool of exposures that do not belong to any association.
Methods Summary
cli
([args, pool])Run the full association generation process
configure
([args, pool])Configure to prepare for generation
generate
()Generate the associations
parse_args
([args, has_pool])Set command line arguments
save
()Save the associations to disk.
Attributes Documentation
- orphaned¶
The pool of exposures that do not belong to any association.
Methods Documentation
- classmethod cli(args=None, pool=None)[source]¶
Run the full association generation process
- Parameters:
args ([str, ...], or None) –
The command line arguments. Can be one of
pool (None or AssociationPool) – If
None
, a pool file must be specified in theargs
. Otherwise, anAssociationPool
- Returns:
generator – A fully executed association generator.
- Return type:
- configure(args=None, pool=None)[source]¶
Configure to prepare for generation
- Parameters:
args ([str, ...], or None) –
The command line arguments. Can be one of
pool (None or AssociationPool) – If
None
, a pool file must be specified in theargs
. Otherwise, anAssociationPool