autowisp.database.user_interface module

Class Inheritance Diagram

Define interface to the pipeline database.

autowisp.database.user_interface._get_config_info(version, step='All')

Return info for displaying the configuration with given version.

autowisp.database.user_interface._get_db_conditions(db_session)

Return dict of condition IDs containing sets of expression IDs.

autowisp.database.user_interface._parse_json_config(json_config)

Organize the given JSON configuration to parameters and conditions.

Parameters:

json_config – JSON configuration to be parsed. Formatted as a decision tree, where the path through the tree defines the combination of condition expressions that must be satisfied and the leaf at the end specifies the value for the parameter .

Returns:

parameter name: [

{

‘expressions’: set(expression ID index in below list),

’value’: value of parameter if all expressions are satisfied

},

…

]

[str]:

list of expression strings

Return type:

dict

autowisp.database.user_interface._save_conditions(configuration, expression_db_ids, db_session)

Create new conditions encounted in configuration and add their IDs.

autowisp.database.user_interface._save_expressions(expressions, db_session)

Save new expressions to database and update configuration with DB IDs.

autowisp.database.user_interface.add_camera_type_channels(camera_type_id, properties, db_session)

Add channels to the given camera type and return partial channel entries.

Parameters:

• camera_type_id (int) – The ID of the camera type to which to add channels.

• properties (dict-like) – The information being changed for the survey. For each channel to add there should be exactly two keywords: "channel-{channel_id}-name" and "channel-{channel_id}-slice". Where {channel_id} should be either an int specifying the identifier of the channel in the database or "new" specifying a new channel to add. {channel_id}``entries should be unique (for example only one new channel can be added). Channel slices have the format: ``"{x_offset}:{x_step};{y_offset}:{y_step}". Anything not related to channels is ignored.

• db_session – The database session to use for updating.

Returns:

The channel ID and property (one of "name" or "slice") which is not fully specified or is mal-formatted. If more than one, the one wit the lowest ID is returned. If the new channel is unspecified, the channel returned is None. If everything is fully specified None, None is returned.

Return type:

int or None, str or None

autowisp.database.user_interface.apply_master_config(master_settings)

Apply user-supplied master settings to the default step / master info.

This is the pure-Python core of what the BUI uses to take the user’s chosen master configuration and produce the step_dependencies / master_info arguments for autowisp.database.initialize_database.initialize_database().

Parameters:

master_settings –

Mapping keyed by "master-<type>-<param>", with values:

• "<type>-enabled": "always" or an int-as-string ("0" to disable, "1" to enable).

• "<type>-split", "<type>-match": iterables of header expressions.

Both plain dict and Django QueryDict are accepted; the list-valued keys are read via .getlist(...) when available and otherwise via mapping[key].

Returns:

deep copies of the database.defaults values with disabled masters pruned and the must_match / split_by sets replaced from master_settings.

Return type:

tuple of (step_dependencies, master_info)

autowisp.database.user_interface.export_survey_to_json(destination, **limit_to)

Create JSON file storing selected survey information.

autowisp.database.user_interface.get_db_configuration(version, db_session, step_id=None, max_version_only=False)

Return list of Configuration instances given version.

autowisp.database.user_interface.get_editable_attributes(db_class)

List the user-editable attributes for the given component DB class.

autowisp.database.user_interface.get_human_name(column_name)

Return human friendly name for the given column.

autowisp.database.user_interface.get_json_config(version=0, step='All', **dump_kwargs)

Return the configuration as a JSON object.

autowisp.database.user_interface.get_processing_sequence(db_session, no_lc_postprocessing=False)

Return the sequence of (step, image type) the pipeline can run.

Parameters:

• db_session – The database session to issue queries.

• no_lc_postprocessing (bool) – If True, any steps which are blocked by create_lightcurves are not included.

autowisp.database.user_interface.get_progress(step, *args, **kwargs)

Return info about completed work ona given step.

autowisp.database.user_interface.get_progress_images(step_id, image_type_id, config_version, db_session)

Return number of images in final state and by status for given step/imtype.

Parameters:

• step – Step instance for which to return the progress.

• image_type – ImageType instance for which to return the progress.

• config_version – Version of the configuration for which to report progress.

• db_session – Database session to use.

Returns:

Information on the images in final state. The

entries are channel name, example status (>0 indicates success <0 indicates falure), number of images of that channel that have that status sign and are flagged final.

[str, int]: Information about the images not in final state. The

entries are channel name, number of non-final images of that channel.

[str, int, int]: The pending images broken by status. The format is

the same as the final state information, except for images not flagged as in final state for the given step.

Return type:

[str, int, int]

autowisp.database.user_interface.get_progress_lightcurves(step_id, image_type_id, config_version, db_session)

Same as get_progress_images() but for lightcurve steps.

autowisp.database.user_interface.import_json_to_survey(json_file)

Add to the survey configuration from given JSON encoding string.

autowisp.database.user_interface.list_channels(db_session)

List the combine set of channels for all cameras.

autowisp.database.user_interface.list_steps()

List the pipeline steps.

autowisp.database.user_interface.main()

Run the import or export action specified on the command line.

autowisp.database.user_interface.master_config_json_to_settings(json_obj)

Translate a master_config.json structure into master settings.

The JSON has the shape {master_type: {"enabled": ..., "split": [...], "match": [...]}, ...}, where master_type is "zero", "dark", "flat", etc. The returned mapping uses "master-<type>-<param>" keys for every (type, param) pair iterated over by the BUI – master_info is the canonical iteration order, with both highflat and lowflat collapsed onto flat so the keys produced here match what the BUI’s session storage uses.

Parameters:

json_obj – The result of json.load(...) on a master-config file.

Returns:

Suitable as master_settings for apply_master_config().

Return type:

dict[str, str | list[str]]

autowisp.database.user_interface.parse_command_line()

Return the parsed command line configuration.

autowisp.database.user_interface.parse_config_overwrites(lines)

Parse plain-text configuration lines into an overwrites dict.

Each non-blank, non-comment, non-section line is parsed as key or key = value (: is also accepted as the separator). Trailing # comments are stripped. ; is not a comment marker – semicolons in unquoted values are preserved as data. Quoted values keep their inner content (the surrounding quotes are removed). Section headers ([name]) and blank lines are skipped.

Keys that are never valid as DB parameter overrides are silently dropped, mirroring what the BUI’s static/home/js/create.project.js does before populating the textarea: project-home (the project directory itself) and split-channels (generated from camera information). The list is a subset of what autowisp.database.initialize_database.StepCreator already refuses to insert as a Parameter row.

Parameters:

lines – Iterable of strings, one per config line. Trailing newlines are tolerated.

Returns:

Suitable for the overwrite_default_config argument of autowisp.database.initialize_database.initialize_database(). Keys without a value are stored as None.

Return type:

dict[str, list[tuple[None, str | None]]]

autowisp.database.user_interface.plural(word)

Mostly working pluralization.

autowisp.database.user_interface.save_json_config(json_config, version)

Save configuration provided in JSON format to the database.

autowisp.database.user_interface.update_db_entry(db_session, properties, db_class, entry_id, component_type=None)

Add/update a survey component or type, return its ID and what to autofocus.