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 2007

URL: http://cxc.harvard.edu/chips4.0/set_preferences.sl.html
AHELP for ChIPS 4.0 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
  • ChipsSymbol
  • ChipsCurve
  • ChipsHistogram
  • ChipsContour
  • ChipsLabel
  • ChipsLine
  • ChipsPoint
  • ChipsRegion
  • ChipsExport
  • ChipsPreferences

The following tables give the preferences for each supported object, listed in the same object order.

ChipsWindow

Attribute Description
display display window when created or wait until redraw is enabled; see the Booleans section of "ahelp sl.chips chipsopt"
stem stem to use for window ids
bgcolor window background color; see the Color section of "ahelp sl.chips chipsopt"
height height of window in units
width width of window in units
units units for window height and width
scaleheight scale factor so screen displayed windows appear close to actual size
scalewidth scale factor so screen displayed windows appear close to actual size
smoothing flag to use for anti-aliasing
id window id

ChipsFrame

Attribute Description
stem stem to use for frame ids
bgcolor frame background color; see the Color section of "ahelp sl.chips chipsopt"
aspect should frames preserve aspect ratio during tiling
scale scale labels when frame size changes vs maintaining font size; see the Booleans section of "ahelp sl.chips chipsopt"
transparency Make the frame background transparent rather than opaque; see the Booleans section of "ahelp sl.chips chipsopt"
border.color color of border edge; see the Color section of "ahelp sl.chips chipsopt"
border.visible should frame border edge by visible; see the Booleans section of "ahelp sl.chips chipsopt"
id frame id

ChipsPlot

Attribute Description
stem stem to use for plot ids
style appearance of border edges on plot
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
corner.style appearance of plot border corners
id frame id
title.xpos normalized x reference location for plot title
title.ypos normalized y reference location for plot title
title.angle angle for plot title
title.depth depth of title; see the Depth section of "ahelp sl.chips chipsopt"
title.halign horizontal alignment with regards to title location; see the Text Alignment section of "ahelp sl.chips chipsopt"
title.valign vertical alignment with regards to title location; see the Text Alignment section of "ahelp sl.chips chipsopt"
title.color color of plot title text; see the Color section of "ahelp sl.chips chipsopt"
title.size size of the plot title
title.font font of the plot title
title.fontstyle font style of the plot title

ChipsAxis

Attribute Description
x.stem stem to use for x axis ids
x.label axis x label
y.stem stem to use for x axis ids
y.label axis y label
depth depth of axis; see the Depth section of "ahelp sl.chips chipsopt"
color Color of axis baseline; see the Color section of "ahelp sl.chips chipsopt"
thickness Thickness of axis baseline; see the Thickness section of "ahelp sl.chips chipsopt"
label.color Color of axis label; see the Color section of "ahelp sl.chips chipsopt"
label.size font size of tick labels
label.angle angle of tick labels
label.halign horizontal alignment for ticklabels; see the Text Alignment section of "ahelp sl.chips chipsopt"
label.valign vertical alignment for ticklabels; see the Text Alignment section of "ahelp sl.chips chipsopt"
label.font see the Font section of "ahelp sl.chips chipsopt"
label.fontstyle see the Font Style section of "ahelp sl.chips chipsopt"
majorgrid.visible should major grid be visible
majorgrid.style grid line style; see the Line Style section of "ahelp sl.chips chipsopt"
majorgrid.color grid line color; see the Color section of "ahelp sl.chips chipsopt"
majorgrid.thickness grid line thickness; see the Thickness section of "ahelp sl.chips chipsopt"
minorgrid.visible should minor grid be visible; see the Booleans section of "ahelp sl.chips chipsopt"
minorgrid.style grid line style; see the Line Style section of "ahelp sl.chips chipsopt"
minorgrid.color grid line color; see the Color section of "ahelp sl.chips chipsopt"
minorgrid.thickness grid line thickness; see the Thickness section of "ahelp sl.chips chipsopt"
automin automatically adjust minimum value based of added curve, contour, or histogram; see the Booleans section of "ahelp sl.chips chipsopt"
automax automatically adjust maximum value based of added curve, contour, or histogram; see the Booleans section of "ahelp sl.chips chipsopt"
pad pad factor to add to axes in arbitrary, limits, or interval modes
offset.parallel distance of axis label from axis center. -0.5 is utmost left, 0.5 is utmost right, 0 axis center
offset.perpendicular distance of axis label from axis baseline (in pixels)
tickformat format for tick labels; see the Tick Format section of "ahelp sl.chips chipsopt"
ticklabel.color see the Color section of "ahelp sl.chips chipsopt"
ticklabel.size font size of tick labels
ticklabel.angle angle of tick labels
ticklabel.halign horizontal alignment for ticklabels; see the Text Alignment section of "ahelp sl.chips chipsopt"
ticklabel.valign vertical alignment for ticklabels; see the Text Alignment section of "ahelp sl.chips chipsopt"
ticklabel.font see the Font section of "ahelp sl.chips chipsopt"
ticklabel.fontstyle see the Font Style section of "ahelp sl.chips chipsopt"
ticklabel.offset distance of ticklabel from axis baseline (in pixels)
majortick.visible should major ticks be visible; see the Booleans section of "ahelp sl.chips chipsopt"
majortick.style tick location; see the Tick Style section of "ahelp sl.chips chipsopt"
majortick.color tick line color; see the Color section of "ahelp sl.chips chipsopt"
majortick.thickness tick line thickness; see the Thickness section of "ahelp sl.chips chipsopt"
majortick.mode tick spacing type; see the Tick Mode section of "ahelp sl.chips chipsopt"
majortick.interval tick spacing based on interval
majortick.count tick spacing based on count
majortick.length tick length
minortick.visible should major ticks be visible
minortick.style tick location; see the Tick Style section of "ahelp sl.chips chipsopt"
minortick.color tick line color; see the Color section of "ahelp sl.chips chipsopt"
minortick.thickness tick line thickness; see the Thickness section of "ahelp sl.chips chipsopt"
minortick.mode tick spacing type; see the Tick Mode section of "ahelp sl.chips chipsopt"
minortick.interval tick spacing based on interval
minortick.count tick spacing based on count
minortick.length tick length

ChipsCurve

Attribute Description
stem stem to use for curve ids
baddata ignore or omit bad data points
depth depth of curve; see the Depth section of "ahelp sl.chips chipsopt"
line.color color of trace connecting data points in curve.; see the Color section of "ahelp sl.chips chipsopt"
line.thickness thickness of trace connecting data points in curve; see the Thickness section of "ahelp sl.chips chipsopt"
line.style line style of trace connecting data points in curve; see the Line Style section of "ahelp sl.chips chipsopt"
symbol.color see the Color section of "ahelp sl.chips chipsopt"
symbol.size size of symbol
symbol.angle angle of symbol
symbol.fill should the symbol be filled
symbol.style symbol style; see the Symbol Style section of "ahelp sl.chips chipsopt"
err.color see the Color section of "ahelp sl.chips chipsopt"
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
err.thickness line thickness for error bars; see the Thickness section of "ahelp sl.chips chipsopt"
limit.length
limit.override see the Booleans section of "ahelp sl.chips chipsopt"
id curve id

ChipsHistogram

Attribute Description
stem stem to use for histogram ids
depth depth of histogram; see the Depth section of "ahelp sl.chips chipsopt"
line.color color of trace connecting data points in curve; see the Color section of "ahelp sl.chips chipsopt"
line.thickness thickness of trace connecting data points in curve; see the Thickness section of "ahelp sl.chips chipsopt"
line.style line style of trace connecting data points in curve; see the Line Style section of "ahelp sl.chips chipsopt"
symbol.color see the Color section of "ahelp sl.chips chipsopt"
symbol.size size of symbol
symbol.angle angle of symbol
err.color see the Color section of "ahelp sl.chips chipsopt"
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
err.thickness line thickness for error bars; see the Thickness section of "ahelp sl.chips chipsopt"
dropline extend bin edge to 0 for connected bins
fill.visible; see the Booleans section of "ahelp sl.chips chipsopt" should histogram be filled
fill.color color of histogram fill; see the Color section of "ahelp sl.chips chipsopt"
style display y up errors if present in data
id histogram id

ChipsContour

Attribute Description
stem stem to use for contour ids
color contour line color; see the Color section of "ahelp sl.chips chipsopt"
thickness thickness of contour levels; see the Thickness section of "ahelp sl.chips chipsopt"
style contour line style; see the Line Style section of "ahelp sl.chips chipsopt"
levels number of contour levels when mode is count
algorithm algorithm to use for contours
mode mode for calculating contour levels; see the Contour Mode section of "ahelp sl.chips chipsopt"
interval interval to use between levels when mode is interval
depth depth of the contour; see the Depth section of "ahelp sl.chips chipsopt"
id histogram id

ChipsLabel

Attribute Description
stem stem to use for label ids
font see the Font section of "ahelp sl.chips chipsopt"
color see the Color section of "ahelp sl.chips chipsopt"
size font size of label
fontstyle fontstyle of label; see the Font Style section of "ahelp sl.chips chipsopt"
angle angle of label
halign horizontal alignment of label; see the Text Alignment section of "ahelp sl.chips chipsopt"
valign vertical alignment of label; see the Text Alignment section of "ahelp sl.chips chipsopt"
depth depth of label; see the Depth section of "ahelp sl.chips chipsopt"
id line id

ChipsLine

Attribute Description
stem stem to use for line ids
color see the Color section of "ahelp sl.chips chipsopt"
thickness thickness of line; see the Thickness section of "ahelp sl.chips chipsopt"
depth depth of line; see the Depth section of "ahelp sl.chips chipsopt"
style see the Line Style section of "ahelp sl.chips chipsopt"
extend extend type for line
id label id

ChipsPoint

Attribute Description
stem stem to use for point ids
color see the Color section of "ahelp sl.chips chipsopt"
style see the Symbol Style section of "ahelp sl.chips chipsopt"
size size of point
fill filled or unfilled; see the Booleans section of "ahelp sl.chips chipsopt"
angle angle to rotate point by
depth depth of point; see the Depth section of "ahelp sl.chips chipsopt"
id point id

ChipsRegion

Attribute Description
stem stem to use for region ids
fill.visible; see the Booleans section of "ahelp sl.chips chipsopt" visibility flags
fill.color color to use for region fill; see the Color section of "ahelp sl.chips chipsopt"
edge.thickness line thickness for region edge; see the Thickness section of "ahelp sl.chips chipsopt"
edge.style line style for region edge; see the Line Style section of "ahelp sl.chips chipsopt"
edge.color color to use for region edge; see the Depth section of "ahelp sl.chips chipsopt"
depth depth where the region should be placed; see the Depth section of "ahelp sl.chips chipsopt"
angle rotation angle for region
id region id

ChipsExport

Attribute Description
fonts write ps fonts to output file; see the Booleans section of "ahelp sl.chips chipsopt"
format see the Export section of "ahelp sl.chips chipsopt"
orientation portrait or landscape mode.see the Export section of "ahelp sl.chips chipsopt"
colorscheme see the Export section of "ahelp sl.chips chipsopt"
leftmargin see the Export section of "ahelp sl.chips chipsopt"
rightmargin see the Export section of "ahelp sl.chips chipsopt"
topmargin see the Export section of "ahelp sl.chips chipsopt"
bottommargin see the Export section of "ahelp sl.chips chipsopt"
pagewidth see the Export section of "ahelp sl.chips chipsopt"
pageheight see the Export section of "ahelp sl.chips chipsopt"
scaleheight see the Export section of "ahelp sl.chips chipsopt"
scalewidth see the Export section of "ahelp sl.chips chipsopt"
fittopage see the Export section of "ahelp sl.chips chipsopt"
keepaspect see the Export section of "ahelp sl.chips chipsopt"

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
foregroundfile 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
export ChipsExport preferences
pick.mask event mask to use for pick points operation
info.coord display object coord sys data in info results
info.current reverse video for current objects in info results
info.depth display object depth in info results

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 2007



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.