sofia_redux.visualization: The Eye of SOFIA

Package Overview

• Design Philosophy
• Module Summaries
• Class UML Diagram

Model Classes

• Models
  • Overview
  • Diagram
  • Model Levels
  • Interaction Between Levels
  • Reading in Data
• Fitting Curves to Data
  • Selecting Data
  • Method
  • Displaying Results
• Reference Spectral Data
  • Reference Data
  • Reference Window

Display Classes

• Artists and Blitting
  • Background
  • Matplotlib Artists
  • Drawing
  • Gallery
  • Blitting
• Plotting
  • Overview
  • Diagram
  • Initial Plot Creation
  • Atrophy System
• Signals
  • Overview
  • Defined
  • Used

Reference/API

Core Interface

sofia_redux.visualization.eye Module

Classes

Eye([args, view_])

Run the Eye of SOFIA.

Class Inheritance Diagram

sofia_redux.visualization.controller Module

Standalone front-end for Eye of SOFIA display tool.

Functions

main()	The Eye of SOFIA spectral viewer.
parse_args(args)	Parse command line arguments.
check_args(args)	Check arguments for validity.

Support Methods

sofia_redux.visualization.setup Module

Classes

Setup(parent)

Setup GUI controls and callbacks.

Class Inheritance Diagram

sofia_redux.visualization.signals Module

Classes

Signals()

Custom signals used in the Eye GUI.

Class Inheritance Diagram

Display Module

sofia_redux.visualization.display.gallery Module

Classes

Gallery()

Track display gallery for viewer plots.

Class Inheritance Diagram

sofia_redux.visualization.display.drawing Module

Classes

Drawing(**kwargs)

Class to hold an individual matplotlib artist.

Class Inheritance Diagram

sofia_redux.visualization.display.blitting Module

Classes

BlitManager(canvas, gallery, signals)

Manage drawing for background and animated artists.

Class Inheritance Diagram

sofia_redux.visualization.display.cursor_location Module

Classes

CursorLocation(parent)

Cursor location display widget.

Class Inheritance Diagram

sofia_redux.visualization.display.figure Module

Classes

Figure(figure_widget, signals)

Oversee the plot.

Class Inheritance Diagram

sofia_redux.visualization.display.fitting_results Module

Classes

FittingResults(parent)

Fitting results display widget.

Class Inheritance Diagram

sofia_redux.visualization.display.pane Module

Classes

Pane(signals[, ax])	Plot window management.
OneDimPane(signals[, ax])	Single axis pane, for one-dimensional plots.
TwoDimPane([ax])	Two-axis pane, for displaying images.

Class Inheritance Diagram

sofia_redux.visualization.display.view Module

Classes

View(signals)

Interactively display data.

Class Inheritance Diagram

sofia_redux.visualization.display.reference_window Module

Classes

ReferenceWindow(parent)

GUI framework for displaying spectral reference lines.

Class Inheritance Diagram

sofia_redux.visualization.display.text_view Module

Text viewer widget for use with the Eye of SOFIA.

Classes

QtWidgets()
TextView([parent])	View, find, and filter text.
tv()

Class Inheritance Diagram

Models Module

sofia_redux.visualization.models.model Module

Functions

parse_general(filename)

Parse a text-based data file.

Classes

Model()

The starting point for Eye of SOFIA models.

Class Inheritance Diagram

sofia_redux.visualization.models.high_model Module

Classes

HighModel(hdul)	Abstract class for high-level models.
Grism(hdul)	High level model describing a Grism data file.
MultiOrder(hdul[, general])	High-level model for FITS files with multiple independent spectra.

Class Inheritance Diagram

sofia_redux.visualization.models.mid_model Module

Classes

MidModel(hdul, filename, number[, aperture])	Describe a mid-level data object.
Book(hdul, filename, number[, aperture])	Multi-image data object.
Order(hdul, filename, number[, aperture, ...])	Multi-spectrum data object.

Class Inheritance Diagram

sofia_redux.visualization.models.low_model Module

Classes

LowModel(hdu, filename, **kwargs)	Describe a low-level data object.
Image(*args, **kwargs)	Low-level data model for an image.
Spectrum(*args, **kwargs)	Class for holding simple 1D spectra.

Class Inheritance Diagram

sofia_redux.visualization.models.reference_model Module

Classes

ReferenceData()

Model and manage reference data.

Class Inheritance Diagram

Utils Module

sofia_redux.visualization.utils.eye_error Module

Classes

EyeError

Base class for error messages specific to the Eye viewer.

Class Inheritance Diagram

sofia_redux.visualization.utils.logger Module

This module defines a logging class based on the astropy logging module.

Classes

EyeLogger(name[, level])	Set up the Eye logging.
StreamLogger([stream])	Log handler for logging messages to stdout or stderr streams.
StatusLogger(status_bar)	Log handler for logging info messages to a status bar.
DialogLogger(parent)	Log handler for logging error messages to a dialog box.

Class Inheritance Diagram

sofia_redux.visualization.utils.model_fit Module

Classes

ModelFit([params])

Hold parameters and descriptions of generic model fits.

Class Inheritance Diagram

sofia_redux.visualization.utils.unit_conversion Module

Functions

parse_unit(unit_string)	Parse a unit string into a unit object.
convert_flux(in_flux, start_unit, end_unit, ...)	Convert flux data to new units.
convert_wave(wavelength, start_unit, end_unit)	Convert wavelength data to new units.

Auxiliary Tools and Interfaces

sofia_redux.visualization.quicklook Module

Functions

make_image(filename[, extension, colormap, ...])	Generate a map image from a FITS file.
make_spectral_plot(axis, wavelength, ...[, ...])	Generate a plot of spectral data.

sofia_redux.visualization.redux_viewer Module

Classes

EyeViewer()

Redux Viewer interface to the Eye of SOFIA.

Class Inheritance Diagram