References/API

wss_tools.quip.main Module

QUIP driver.

The main program takes QUIP Operation XML file from WEx. Then, it starts Ginga with custom plugins. For more information, see Getting Started.

Functions

main(args)

Driver for command line script.

get_ginga_plugins(op_type)

Obtain relevant custom plugins from stginga and wss_tools for the given QUIP operation type.

copy_ginga_files([verbose])

Copy Ginga configuration files to HOME directory.

set_ginga_config([mode, gcfg_suffix, verbose])

Replace Ginga files in HOME directory with the appropriate version for the given mode.

shrink_input_images(images[, outpath, ...])

Shrink input images for mosaic, if necessary.

wss_tools.quip.qio Module

Module to handle I/O for files specific to QUIP.

Functions

input_xml(filename)

Ingest input XML from WEx.

validate_input_xml(filename)

Validate schema for QUIP Operation File (quip_operation_file.xsd).

validate_output_out_xml(filename)

Validate schema for QUIP Out File (quip_out.xsd).

validate_output_log_xml(filename)

Validate schema for QUIP Log File (quip_activity_log.xsd).

quip_out_dict([images])

Create a dictionary that can be converted to QUIP Out XML.

Classes

QUIPOpFile(op_type, outdir[, correction_id, ...])

Class to handle generation of QUIP Operation File.

QUIPLog()

Class to handle QUIP actions to document in log file and image history.

QUIPLogEntry(date_str, time_str, imname, ...)

Class to handle each log entry for QUIPLog.

wss_tools.utils.io Module

Module to handle I/O for files.

Functions

output_xml(xmldict, filename)

Write given dictionary to XML.

wss_tools.utils.mosaic Module

This module contains tools for NIRCAM image mosaic.

Classes

NircamMosaic([data_ext, sw_sca_size])

Class to handle NIRCAM mosaic.

wss_tools.utils.recenter Module

Module to recenter images

Functions

recenter(images, outputdir[, doplot])

Recenter images based on NIRCam XY (464,1412) if offset > 10px