Appendix D: preferences schema

The full preferences options are shown below. If you use an IDE to edit the “preferences.json”, tooltips may be available while you edit it. The following example is with Visual Studio Code.

Preferences

carta_preferences_1
Schema for CARTA Preferences (Version 1)
properties
  • version
Version number of the preference schema.
type integer
minimum 1
  • username
type string
minLength 1
  • theme
Set the color theme of the graphical user interface of CARTA. Default refers to the color theme of the operating system if applicable, otherwise ‘light’ theme is applied.
type string
enum auto, light, dark
default auto
  • autoLaunch
Launch a file browser when CARTA is initialized.
type boolean
enum True, False
default True
  • fileSortingString
Set the default sorting policy of the file list in the file browser. The string should contain two parts with a plus ‘+’ sign (ascending) or a minor ‘-’ sign (descending) followed by one of the following strings: ‘date’, ‘filename’, ‘type’, or ‘size’. For example, with ‘-date’ (as default), the file list will be sorted by date in descending order.
type string
enum -date, +date, -filename, +filename, -type, +type, -size, +size
pattern ^([+-])(date|filename|type|size)$
default -date
  • fileFilteringType
Set the input syntax mode of the file filter in the file browser. ‘fuzzy’, as default, enables case-insentitive fuzzy string match. ‘unix’ accepts glob patterns in Unix or Unix-like operating systems. ‘regex’ allows defining a filter with regular expression.
type string
enum fuzzy, unix, regex
default fuzzy
  • layout
Set a default layout when CARTA is initialized. A custom layout can be set as the default layout too.
type string
examples Default
Cube View
Cube Analysis
Continuum Analysis
default Default
  • cursorPosition
Define the initial state of the cursor in the image viewer. ‘fixed’ will fix the cursor position at the image center with a cross marker to prevent updating of cursor information or spatial/spectral cursor profile. ‘tracking’ (default) means cursor information or spatial/spectral cursor profile will be updated along with the movement of the cursor in the image viewer.
type string
enum fixed, tracking
default tracking
  • zoomMode
Set the initial image zoom state when an image is loaded in the image viewer. ‘full’ (as default) will set the zoom level so that entire image is rendered to fit the size of the image viewer. ‘fit’ will set the zoom level so that one image pixel will be rendered with just one screen pixel only.
type string
enum fit, full
default full
  • zoomPoint
Set the policy of image zoom with scrolling wheel. ‘cursor’ (as default) enables ‘focused-zoom’ at the location of the cursor when scrolling. ‘center’ forces ‘focused-zoom’ to be always with respect to the center of the image viewer.
type string
enum cursor, center
default cursor
  • dragPanning
Set the default mode of image pan. With true (boolean), an image can be panned by cursor drag-and-drop event. With false, an image is effectively panned via mouse click where the clicked position will be centered in the image viewer.
type boolean
enum True, False
default True
  • spectralMatchingType
Set the coordinate reference for spectral matching. Options are ‘VRAD’ (radio velocity), ‘VOPT’ (optical velocity), ‘FREQ’ (frequency), ‘WAVE’ (vacuum wavelegth), ‘AWAV’ (air wavelength), and ‘CHANNEL’.
type string
enum VRAD, VOPT, FREQ, WAVE, AWAV, CHANNEL
default VRAD
  • wcsMatchingType
Set the image matching state and type when a new image is loaded in the append mode. The meaning of the allowed integers follows: {0: ‘None’, 1: ‘Spatial only’, 2: ‘Spectral only’, 3: ‘Spatial and spectral’}.
type integer
maximum 3
minimum 0
default 0
  • scaling
Set a default scaling function for raster image rendering. The meaning of the allowed integers follows: {0: ‘Linear’, 1: ‘Log’, 2: ‘Square root’, 3: ‘Squared’, 4: ‘Gamma’, 5: ‘Power’}.
type integer
maximum 7
minimum 0
default 0
  • colormap
Set a default colormap for raster image rendering.
type string
enum afmhot, Blues, coolwarm, cubehelix, gist_heat, gist_stern, gnuplot, gnuplot2, gray, greens, greys, hot, inferno, jet, magma, nipy_spectral, plasma, rainbow, RdBu, RdGy, reds, seismic, spectral, tab10, viridis
default inferno
  • percentile
Set a color clip level for raster image rendering.
type number
examples 100
99.99
99.95
99.9
99.5
99
95
90
maximum 100
exclusiveMinimum 0
default 99.9
  • scalingAlpha
Set a default control parameter for ‘Log’ or ‘Power’ scaling function.
type number
maximum 1000000
minimum 1
default 1000
  • scalingGamma
Set a default control parameter for ‘Gamma’ scaling function.
type number
multipleOf 0.1
maximum 2
minimum 0
default 1
  • nanColorHex
Set a default color hex code to render NaN pixels in a raster image. To adjust the transparency, please use ‘nanAlpha’.
type string
examples #137CBD
#000000
#8A9BA8
#FFFFFF
pattern ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
default #137CBD
  • nanAlpha
Set the transparency (alpha value) of NaN pixels in a raster image. To set the color for NaN pixels, please use ‘nanColorHex’ with a color hex code.
type number
maximum 1
minimum 0
default 1
  • contourGeneratorType
Set a default generator of contour levels. Use ‘contourNumLevels’ to define how many levels to be generared.
type string
enum start-step-multiplier, min-max-scaling, percentages-ref.value, mean-sigma-list
default start-step-multiplier
  • contourSmoothingMode
Set the image smoothing mode before computing contour vertices. Options are: {0: ‘None’, 1: ‘Block’, 2: ‘Gaussian’ (as default)}. Use ‘contourSmoothingFactor’ to define a kernel size for smoothing.
type integer
maximum 2
minimum 0
default 2
  • contourSmoothingFactor
Set a kernel size (n x n pixel) for the chosen contour smoothing mode (‘contourSmoothingMode’).
type integer
maximum 33
minimum 1
default 4
  • contourNumLevels
Define the number of levels to be generated by the contour level generator (‘contourGeneratorType’).
type integer
maximum 20
minimum 1
default 5
  • contourThickness
Set a default line width for contour rendering.
type number
multipleOf 0.5
maximum 10
exclusiveMinimum 0
default 1
  • contourColormapEnabled
A boolean flag to enable/disable contour rendering with variable colors for different levels.
type boolean
enum True, False
default False
  • contourColor
Define a default color hex code for contour rendering.
type string
examples #0F9960
#000000
#FFFFFF
#FF0000
#00FF00
#0000FF
#FFFF00
#00FFFF
#FF00FF
pattern ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
default #0F9960
  • contourColormap
Set a colormap for contour rendering with variable colors for different levels.
type string
enum afmhot, Blues, coolwarm, cubehelix, gist_heat, gist_stern, gnuplot, gnuplot2, gray, greens, greys, hot, inferno, jet, magma, nipy_spectral, plasma, rainbow, RdBu, RdGy, reds, seismic, spectral, tab10, viridis
default viridis
  • astColor

TODO: revisit once unified color selector is in place.

Set a default color theme to render the coordinate layer in the image viewer.
type integer
minimum 0
  • astGridVisible
A boolean flag to enable/disable coordinate grid lines in the image viewer.
type boolean
enum False, True
default False
  • astLabelsVisible
A boolean flag to enable/disable x and y labels in the image viewer.
type boolean
enum True, False
default True
  • wcsType
Set the default format to display world coordinates in the image viewer.
type string
enum automatic, degrees, sexagesimal
default automatic
  • beamVisible
A boolean flag to enable/disable the display of a beam element in the image viewer.
type boolean
enum True, False
default True
  • beamColor
Define a default color hex code for beam element rendering in the image viewer.
type string
examples #8A9BA8
#000000
#FFFFFF
#FF0000
#00FF00
#0000FF
#FFFF00
#00FFFF
#FF00FF
pattern ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
default #8A9BA8
  • beamType
Set a style for beam element rendering in the image viewer.
type string
enum open, solid
default open
  • beamWidth
Set a default line width to render the beam element in the image viewer.
type number
multipleOf 0.5
maximum 10
exclusiveMinimum 0
default 1
  • regionColor
Set a default color hex code for region rendering in the image viewer.
type string
examples #2EE6D6
#000000
#FFFFFF
#FF0000
#00FF00
#0000FF
#FFFF00
#00FFFF
#FF00FF
pattern ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
default #2EE6D6
  • regionLineWidth
Set a default line width to render a region in the image viewer.
type number
multipleOf 0.5
maximum 10
exclusiveMinimum 0
default 2
  • regionDashLength
Set the default style of region rendering with dashed line in the image viewer.
type integer
maximum 50
minimum 0
default 0
  • regionType
Set the default region type of the region creation button in the image viewer. Options are: {0: ‘Point’, 1: ‘Line’ (NOT IMPLEMENTED YET), 2: ‘Polyline’ (NOT IMPLEMENTED YET), 3: ‘Rectangle’ (as default), 4: ‘Ellipse’, 5: ‘Annulus’ (NOT IMPLEMENTED YET), 6: ‘Polygon’}.
type integer
maximum 6
minimum 0
default 3
  • regionCreationMode
Specify the default cursor creation mode for regions with rotational symmetry such as ‘Rectangle’ or ‘Ellipse’.
type string
enum center, corner
default center
  • regionSize
Set the default size of ‘Rectangle’ or ‘Ellipse’ region when created with a single click. The size is defined in number of screen pixel.
type integer
minimum 1
default 30
  • imageCompressionQuality
ADJUST WITH CAUTION. Set the compression quality factor for image tile data compression with zfp.
type integer
maximum 32
minimum 1
default 11
  • animationCompressionQuality
ADJUST WITH CAUTION. Set the compression quality factor for image tile data compression with zfp during animation playback.
type integer
maximum 32
minimum 1
default 9
  • GPUTileCache
ADJUST WITH CAUTION. Set the cache size in number of image tiles in GPU memory.
type integer
multipleOf 128
minimum 512
default 512
  • systemTileCache
ADJUST WITH CAUTION. Set the cache size in number of image tiles in system memory.
type integer
multipleOf 128
minimum 1024
default 4096
  • contourDecimation
ADJUST WITH CAUTION. Set the decimation factor for contour vertices generation. Default is 4, meaning the distance between adjacent contour vertices is rounded to 1/4 image pixel size. Contours are more smooth if a larger decimation factor is applied.
type integer
maximum 32
minimum 1
default 4
  • contourCompressionLevel
ADJUST WITH CAUTION. Set the compression quality factor for contour data compression with zstd.
type integer
maximum 19
minimum 0
default 8
  • contourChunkSize
ADJUST WITH CAUTION. Set the chuck size for contour data streaming.
type integer
multipleOf 25000
maximum 1000000
minimum 25000
default 100000
  • contourControlMapWidth
ADJUST WITH CAUTION. Set the width of the contour control map for image matching. An integer between 128 and 1024 should be provided. The value needs to be multiple of 128. Default is 256.
type integer
multipleOf 128
maximum 1024
minimum 128
default 256
  • streamContoursWhileZooming
ADJUST WITH CAUTION. A boolean flag to enable/disable image tile stream for intermediate zoom levels when image zooming is in action.
type boolean
enum False, True
default False
  • lowBandwidthMode
A boolean flag to enable/disable the low bandwidth mode. With the low bandwidth mode, required image resolution is reduced by a factor of two and cursor responding time is reduced from 200 ms to 400 ms.
type boolean
enum False, True
default False
  • stopAnimationPlayback
Set a timer (in minutes) to stop animation playback automatically to save computing resources.
type integer
maximum 30
minimum 5
default 5