About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2008

URL: http://cxc.harvard.edu/chips4.1/set_preferences.sl.html
AHELP for ChIPS 4.1

set_preferences

Context: sl.chips

Synopsis

Sets the specified preferences.

Syntax

set_preferences(list);
set_preferences(string);
set_preferences(object);

Description

The set_preferences command sets the specified preference to the supplied value. The new setting does not affect the attributes of existing objects and data, only new ones created after the call to set_preferences. The argument may be:

  • list - pairs consisting of a string specifying the attribute followed by a value, e.g. {"point.color", "red", "point.size", 3}.
  • string - string containing a single attribute/value entry, e.g. "point.fill=false".
  • object - an attribute object containing the appropriate attributes with desired settings.

When using an object, only members not set to "NULL" are used to update preferences.

The save_preferences and load_preferences commands may be used to save and reload ChIPS preferences, respectively.

The following attribute objects are supported:

  • ChipsWindow
  • ChipsFrame
  • ChipsPlot
  • ChipsAxis
  • ChipsCurve
  • ChipsHistogram
  • ChipsContour
  • ChipsLabel
  • ChipsLine
  • ChipsPoint
  • ChipsRegion
  • ChipsExport
  • ChipsPreferences

The following tables list the preferences for each supported object. For more information on each preference, refer to the help file for the "set_<object>" command, e.g. "ahelp set_window". The ChIPS Dictionary ("ahelp chipsopt") lists the allowed values for colors, fonts, line styles, etc.

ChipsWindow

Attribute Description
display display window when created (true) or wait until redraw is enabled (false)
smoothing flag to use for anti-aliasing
height height of window in units
width width of window in units
scaleheight scale factor so that window on screen appears actual size
scalewidth scale factor so that window on screen appears actual size
units units for window height and width
stem stem to use for window ids
bgcolor window background color
id window id

ChipsFrame

Attribute Description
stem stem to use for frame ids
bgcolor frame background color
border.color color of border edge
border.visible should frame border edge be visible
aspect should frames preserve aspect ratio during tiling
scale scale labels when frame size changes (true) or use set font size (false)
mode the frame mode, either "single" or "placed"
transparency Make the frame background transparent rather than opaque
id frame id

ChipsPlot

Attribute Description
stem stem to use for plot ids
style appearance of border edges on plot
corner.style appearance of plot border corners
leftmargin distance from left edge of frame to plot left border
rightmargin distance from right edge of frame to plot right border
topmargin distance from top edge of frame to plot top border
bottommargin distance from bottom edge of frame to plot bottom border
title.xpos normalized x reference location for plot title
title.ypos normalized y reference location for plot title
title.depth depth of title
title.angle angle for plot title
title.halign horizontal alignment with regards to title location
title.valign vertical alignment with regards to title location
title.color color of plot title text
title.size font size of the plot title
title.font font of the plot title
title.fontstyle font style of the plot title
id plot id

ChipsAxis

Attribute Description
x.stem stem to use for x-axis ids
y.stem stem to use for y-axis ids
color color of axis baseline
thickness Thickness of axis baseline
depth depth of axis
automin automatically adjust minimum value based on added curve, contour, or histogram
automax automatically adjust maximum value based on added curve, contour, or histogram
pad pad factor to add to axes in arbitrary, limits, or interval modes
offset.parallel distance of axis label from axis center
offset.perpendicular distance of axis label from axis baseline
tickformat format for tick labels
ticklabel.style where the tickmarks should be drawn
ticklabel.color color of the tick labels
ticklabel.size font size of tick labels
ticklabel.angle angle of tick labels
ticklabel.halign horizontal alignment for tick labels
ticklabel.valign vertical alignment for tick labels
ticklabel.font font for the tick labels
ticklabel.fontstyle font style for the tick labels
ticklabel.offset distance of ticklabel from axis baseline
label.color color of axis label
label.size font size for the axis label
label.font font for the axis label
label.fontstyle font style for the axis label
label.halign horizontal alignment of the axis label
label.valign vertical alignment of the axis label
majorgrid.visible should major grid be visible
majorgrid.color major grid line color
majorgrid.style major grid line style
majorgrid.thickness major grid line thickness
minorgrid.visible should minor grid be visible
minorgrid.color minor grid line color
minorgrid.style minor grid line style
minorgrid.thickness minor grid line thickness
majortick.mode tick spacing type
majortick.interval tick spacing based on interval
majortick.count tick spacing based on count
majortick.thickness tick line thickness
majortick.length tick length
majortick.color tick line color
majortick.style tick location
majortick.visible should major ticks be visible
minortick.mode tick spacing type
minortick.interval tick spacing based on interval
minortick.count tick spacing based on count
minortick.thickness tick line thickness
minortick.length tick length
minortick.color tick line color
minortick.style tick location
minortick.visible should minor ticks be visible

ChipsCurve

Attribute Description
stem stem to use for curve ids
baddata ignore or omit bad data points
depth depth of curve
line.color color of trace connecting data points in curve.
line.thickness thickness of trace connecting data points in curve
line.style line style of trace connecting data points in curve
symbol.color color of the symbol
symbol.style symbol style
symbol.size size of symbol
symbol.angle angle of symbol
symbol.fill should the symbol be filled
err.color color of the error bars
err.thickness line thickness for error bars
err.style style of error bars (line or capped)
err.up should up error bars be displayed
err.down should down error bars be displayed
err.left should left error bars be displayed
err.right should right error bars be displayed
limit.length length of the bars for upper and lower limits
limit.override should a limit and the error bar be drawn on each point
id curve id

ChipsHistogram

Attribute Description
stem stem to use for histogram ids
depth depth of histogram
line.color color of trace connecting data points in histogram
line.thickness thickness of trace connecting data points in histogram
line.style line style of trace connecting data points in histogram
symbol.color symbol color
symbol.style shape used for the symbols
symbol.size size of symbols
symbol.angle angle of symbols
symbol.fill should the symbols be filled
err.color color of the error bars
err.thickness line thickness for error bars
err.style style of error bars (line or capped)
err.up should up error bars be displayed
err.down should down error bars be displayed
dropline extend bin edge down to the axis for connected bins
fill.color color of histogram fill
fill.opacity Opacity of histogram fill
fill.style histogram fill pattern
id histogram id

ChipsContour

Attribute Description
stem stem to use for contour ids
color contour line color
thickness thickness of contour levels
numlevels number of contour levels when mode is count
style contour line style
algorithm algorithm to use for contours
mode mode for calculating contour levels
interval interval to use between levels when mode is interval
depth depth of the contour
id contour id

ChipsLabel

Attribute Description
stem stem to use for label ids
font font for the label
color color of the label text
size font size of label
fontstyle fontstyle of label
angle angle of label
halign horizontal alignment of label
valign vertical alignment of label
depth depth of label
id label id

ChipsLine

Attribute Description
stem stem to use for line ids
color line color
thickness thickness of line
depth depth of line
style line style
extend should the line extend to infinity
id label id

ChipsPoint

Attribute Description
stem stem to use for point ids
color color of the point
style style of the point
size size of point
fill filled or unfilled
angle angle to rotate point by
depth depth of point
id point id

ChipsRegion

Attribute Description
stem stem to use for region ids
fill.color color of region fill
fill.style region fill pattern
edge.thickness line thickness for region edge
edge.style line style for region edge
edge.color color to use for region edge
angle rotation angle for region
opacity Opacity of region
depth depth where the region should be placed
id region id

ChipsExport

Attribute Description
fonts embed the fonts in the output PS file?
clobber overwrite the output file if it exists?
format output file format
orientation portrait or landscape mode
colorscheme how to handle colors in output, e.g. RGB, CMYK
leftmargin left page margin in pageunits
rightmargin right page margin in pageunits
topmargin top page margin in pageunits
bottommargin bottom page margin in pageunits
pagewidth width of the page in pageunits
pageheight height of the page in pageunits
pagesize size of the page in standard, predefined dimensions (e.g. letter, A4)
pageunits units of page attributes
scaleheight scaling factor for the height of the window
scalewidth scaling factor for the width of the window
keepaspect keep the aspect ratio of the original window?
fittopage adjust contents to fit to page?

ChipsPreferences

Attribute Description
window ChipsWindow preferences
frame ChipsFrame preferences
plot ChipsPlot preferences
axis ChipsAxis preferences
curve ChipsCurve preferences
histogram ChipsHistogram preferences
contour ChipsContour preferences
label ChipsLabel preferences
line ChipsLine preferences
point ChipsPoint preferences
region ChipsRegion preferences
export ChipsExport preferences
foreground.file default foreground color for output files/hardcopies
foreground.display default foreground color for screen displays
background.file default background color for output files/hardcopies
background.display default background color for screen displays
pick.mask event mask to use for pick points operation; see "ahelp pick"
pick.color color of the bounding box for the pick_limits command; see "ahelp pick_limits"
info.coord display object coord system data in info results
info.current use reverse video for current objects in info results
info.depth display object depth in info results
default.depth default depth value; see "ahelp set_default_depth"
default.verbosity output verbosity
chips.shell whether slang or python should be used; see "ahelp chips" for how this value falls in the hierarchy of environment variables and the command-line language switch.

Example 1

chips> set_preferences({"point.color", "red", "point.size", 3});

Set the default point color to red and the size to 3.

Example 2

chips> set_preferences("point.fill=false");

By default, points will not be filled.

Example 3

chips> variable prefs_axis = ChipsAxis();
chips> prefs_axis.label.color = "red";
chips> prefs_axis.offset.perpendicular = 10;
chips> set_preferences(prefs_axis);

Using the prefs_axis object, set the default axis label color to red and the perpendicular offset to 10.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.

Last modified: December 2008



The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory.
60 Garden Street, Cambridge, MA 02138 USA.    Email: cxcweb@head.cfa.harvard.edu
Smithsonian Institution, Copyright © 1998-2004. All rights reserved.