Settings#
Settings come in two scopes:
Your preferences (e.g., the theme or the list of spectral lines) apply to every workspace.
Workspace settings (e.g., the data and catalog paths, or the data viewer configuration) belong to the current workspace (see Workspaces).
Most of them can be changed in Settings. The others are changed by editing the configuration files, which are listed in full in Configuration reference.
The Settings dialog#
Open , or click on the cogwheel in Toolbar:
Settings include the following sections:
Section |
Purpose(s) |
Scope |
|---|---|---|
Appearance |
Change the application theme, configure antialiasing [1], etc. |
You |
Catalog |
Load a new catalog, configure aliases for column names |
Workspace |
Data Source |
Change the data path, add new images, configure unit aliases |
Workspace |
Data Viewer |
Set the redshift steps and the default screenshot location, add spectral lines |
You |
Plugins |
Enable the plugins that adapt the data viewer to a dataset |
Workspace |
Most changes take effect immediately once you click OK. A few cannot, because they are applied once while the application starts, and specvizitor will offer to restart:
Setting |
Why a restart is needed |
|---|---|
Application theme |
Applied as a stylesheet at startup |
Plugins |
Imported at startup |
Adding spectral lines#
Open Settings ‣ Data Viewer. Click Add… and enter the line’s name and its vacuum wavelength (in Å by default):
Click OK. The new line should appear in the data viewer.
Configuration files#
The settings are stored as YAML files. Your preferences are in the application configuration directory [2], and the workspace settings are in the workspace directory. Click the directory indicated at the bottom of Settings (under “Advanced settings”) to open it in your file manager:
File |
Directory |
Contents |
In Settings |
|---|---|---|---|
|
Application |
Your preferences |
Yes |
|
Application |
The spectral lines shown in the data viewer |
Yes |
|
Application |
The list of known workspaces |
Managed by specvizitor |
|
Workspace |
Data and catalog paths, catalog settings, plugins |
Yes |
|
Workspace |
The widgets of the data viewer (see Data Viewer) |
No |
|
Workspace |
The window layout |
Managed by specvizitor |
|
Workspace |
The inspection file you had open, and your position in it |
Managed by specvizitor |
Open one of these files in a text editor and make the desired changes.
Tip
You do not have to restart specvizitor after editing data_widgets.yml. Use
and select the file you just edited: the new
configuration is applied immediately.
How the files are read and written#
Missing files are created with the default values the first time specvizitor needs them.
Files are only written when something changes. Opening specvizitor does not rewrite a file you edited by hand, so your comments and formatting stay until the application itself saves a change to that file.
Missing keys take their default value.
Unknown keys, such as a misspelled one, are ignored. Specvizitor logs a warning that names each of them with its full path (e.g.,
catalog.filname). They are dropped the next time the application saves the file.Invalid files (a YAML syntax error, or a value of the wrong type) are reset to their default values, and the error is logged with the key it concerns. For every file except
layout.ymlandstate.yml, the original is kept next to it as*.yml.bak(e.g.,workspace.yml.bak).Schema versions. Every file starts with
schema_version, the version of the layout it was written in. Do not edit it. A file written by an older version of specvizitor is upgraded once, and the original is kept as*.yml.bak. A file written by a newer version is read as well as possible but never overwritten.
Configuration reference#
In the tables below, a dotted key such as appearance.theme is written in YAML as a nested
mapping:
appearance:
theme: dark
config.yml#
Key |
Default |
Description |
|---|---|---|
|
|
|
|
|
Smooth lines and edges in the data viewer (might decrease the GUI responsiveness) |
|
|
Space between the widgets of the data viewer, in pixels |
|
|
Margins around each widget of the data viewer, in pixels |
|
|
The directory proposed when saving a screenshot |
|
|
How much Q and W change the redshift |
|
|
How much Shift+Q and Shift+W change the redshift |
spectral_lines.yml#
Key |
Default |
Description |
|---|---|---|
|
|
The unit of the wavelengths below, in any form astropy understands (e.g., |
|
(see the file) |
The rest-frame vacuum wavelength of each line, by name (e.g., |
workspaces.yml#
Key |
Default |
Description |
|---|---|---|
|
|
The path of the workspace opened at startup |
|
|
The paths of the known workspaces, most recently used first |
workspace.yml#
Key |
Default |
Description |
|---|---|---|
|
|
The name of the workspace. Without a name, the directory name is shown. |
|
|
The path to the catalog |
|
(see the file) |
Aliases for catalog column names, as |
|
|
The directory with the data files |
|
(see the file) |
A regular expression that matches the object ID in data file names. If several matches are found in a file name, the longest one is used. |
|
|
Images shared by all objects, e.g., large mosaics that widgets cut out from. Each image has a label and the keys below. |
|
|
The path to the image |
|
|
The file to read the WCS from, if not the image itself |
|
|
How to read the image (see |
|
|
Parameters passed to the loader (see |
|
(see the file) |
Non-standard unit names found in data files, as |
|
|
The flags added to every new inspection file |
|
(see the file) |
The enabled plugins. Applied at startup. |
data_widgets.yml#
The widgets are listed by title under images and plots (see Data Viewer for
examples).
Keys of images#
Key |
Default |
Description |
|---|---|---|
|
|
Show the image in sky coordinates, using its WCS |
|
|
Rotate the image by this angle in degrees, or by the catalog’s |
|
The color bar (see Color bars) |
|
|
|
Draw a horizontal ( |
|
|
Draw a crosshair at the center of the image |
|
|
Mark the catalog sources that fall within the image (needs |
Keys of plots#
Key |
Default |
Description |
|---|---|---|
|
|
The lines drawn in the widget, by label |
|
(required) |
The table columns plotted against each other |
|
|
The line color, as a name (e.g., |
|
|
Leave the line out of the legend |
Data#
Key |
Default |
Description |
|---|---|---|
|
|
The data file, relative to |
|
|
The label of a shared image in |
|
|
How to read the file: |
|
|
Parameters passed to the loader. For FITS files: |
Axes#
Key |
Default |
Description |
|---|---|---|
|
|
Show the axis |
|
|
The title of another widget whose axis this one follows when panning and zooming |
|
|
The unit the data is shown in (e.g., |
|
|
|
|
|
The axis label. Without it, plots are labelled with the name of the plotted column. |
|
|
The default axis range. Without them, the range of the data is used. |
Sliders#
Key |
Default |
Description |
|---|---|---|
|
(see above) |
Show the slider |
|
|
The title of another widget whose slider of the same kind this one follows |
|
(see above) |
The slider range and step |
|
|
The value the slider starts at |
|
|
A catalog column to start at instead, e.g., |
|
|
Show a field for typing the value |
|
|
The number of decimal places shown in that field |
|
|
Show a button that saves the value to Inspection Results (redshift slider only) |
Color bars#
Key |
Default |
Description |
|---|---|---|
|
|
Show the color bar |
|
|
The title of another widget whose color bar levels this one follows |
|
|
How the levels are set, as in SAOImage DS9:
|
|
|
The levels for |
Spectral lines#
Key |
Default |
Description |
|---|---|---|
|
|
Show the lines listed in |
|
|
The line color. Without it, the color depends on the theme. |
layout.yml and state.yml#
Key |
File |
Description |
|---|---|---|
|
|
The arrangement of the data viewer’s docks |
|
|
The inspection file opened at startup |
|
|
The object shown at startup |
|
|
The subset being inspected, if any |
Footnotes