Utility

class jwst.associations.lib.rules_level3_base.Utility[source]

Bases: object

Utility functions that understand DMS Level 3 associations.

Attributes Summary

asnreg_marked

asnreg_role

Methods Summary

finalize(associations)

Check validity and duplications in an association list.

get_candidate_list(value)

Parse the candidate list from a item value.

rename_to_level2(level1b_name[, exp_type, ...])

Rename a Level 1b Exposure to a Level2 name.

resequence(associations)

Resequence the numbering for the Level3 association types.

Attributes Documentation

asnreg_marked = True
asnreg_role = 'utility'

Methods Documentation

static finalize(associations)[source]

Check validity and duplications in an association list.

Parameters:
associations[Association[, …]]

List of associations.

Returns:
finalized_associations[Association[, …]]

The validated list of associations.

static get_candidate_list(value)[source]

Parse the candidate list from a item value.

Parameters:
valuestr

The value from the item to parse. Usually item['ASN_CANDIDATE'].

Returns:
[ACID, …]

The list of parsed candidates.

static rename_to_level2(level1b_name, exp_type=None, use_integrations=False, member_exptype='science')[source]

Rename a Level 1b Exposure to a Level2 name.

The basic transform is changing the suffix uncal to cal, calints, or rate.

Parameters:
level1b_namestr

The Level 1b exposure name.

exp_typestr

JWST exposure type. If not specified, it will be presumed that the name should get a Level2b name.

use_integrationsbool

Use ‘calints’ instead of ‘cal’ as the suffix.

member_exptypestr

The association member exposure type, such as “science”.

Returns:
str

The Level 2b name.

static resequence(associations)[source]

Resequence the numbering for the Level3 association types.