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

Skip the navigation links
Last modified: April 2009

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

chipsrc

Context: chips

Synopsis

The .chips.rc file provides user-configuration options for ChIPS

Description

When ChIPS is started - either directly by the "chips" command or from another CIAO application such as Sherpa - it processes the $HOME/.chips.rc resource file. The resource file defines default behavior for the ChIPS commands and can be customized to the user's preferences.

Setting Preferences

The set_preferences command ("ahelp set_preferences") is used to set the specified preferences to the supplied values by means of attribute-value pairs.

Saving and Loading Preferences

The save_preferences command ("ahelp save_preferences") saves ChIPS preferences to the "$HOME/.chips.rc" file by default.

To load a preferences file into an existing ChIPS session - e.g. if the file was changed in a different session and needs to be reloaded - use the load_preferences command ("ahelp load_preferences").

Contents of default .chips.rc file

The default .chips.rc file contains the following entries:

#   Newchips Defaults Resource File

window.display         : true
window.smoothing       : false
window.height          : 360
window.width           : 360
window.scaleheight     : 1.25
window.scalewidth      : 1.25
window.units           : pixels
window.stem            : win
window.bgcolor         : default

frame.stem             : frm
frame.bgcolor          : default
frame.border.color     : default
frame.border.visible   : false
frame.aspect           : true
frame.scale            : true
frame.mode             : placed
frame.transparency     : false

plot.stem              : plot
plot.style             : closed 
plot.corner.style      : miter 
plot.leftmargin        : 0.15
plot.rightmargin       : 0.1
plot.topmargin         : 0.1
plot.bottommargin      : 0.15
plot.title.xpos        : 0.5
plot.title.ypos        : 15
plot.title.depth       : default
plot.title.angle       : 0
plot.title.halign      : auto
plot.title.valign      : auto
plot.title.color       : default
plot.title.size        : 16
plot.title.font        : helvetica
plot.title.fontstyle   : normal 

axis.x.stem            : ax
axis.y.stem            : ay
axis.color             : default
axis.thickness         : 1
axis.depth             : default
axis.automin           : true
axis.automax           : true
axis.pad               : 0.05
axis.offset.parallel   : 0
axis.offset.perpendicular : 40
axis.tickformat        : %g
axis.ticklabel.style   : outside 
axis.ticklabel.color   : default
axis.ticklabel.size    : 12
axis.ticklabel.angle   : 0
axis.ticklabel.halign  : auto
axis.ticklabel.valign  : auto
axis.ticklabel.font    : helvetica
axis.ticklabel.fontstyle : normal 
axis.ticklabel.offset  : 6
axis.label.color       : default
axis.label.size        : 14
axis.label.font        : helvetica
axis.label.fontstyle   : normal 
axis.label.halign      : center
axis.label.valign      : center
axis.majorgrid.visible : false
axis.majorgrid.color   : default
axis.majorgrid.style   : shortdash 
axis.majorgrid.thickness : 1
axis.minorgrid.visible : false
axis.minorgrid.color   : default
axis.minorgrid.style   : dot 
axis.minorgrid.thickness : 1
axis.majortick.mode    : limits
axis.majortick.interval: 10
axis.majortick.count   : 6
axis.majortick.thickness : 1
axis.majortick.length  : 4
axis.majortick.color   : default
axis.majortick.style   : inside 
axis.majortick.visible : true
axis.minortick.mode    : count
axis.minortick.interval: 5
axis.minortick.count   : 4
axis.minortick.thickness : 1
axis.minortick.length  : 2
axis.minortick.color   : default
axis.minortick.style   : inside 
axis.minortick.visible : true

curve.stem             : crv
curve.baddata          : omit 
curve.depth            : default
curve.line.color       : default
curve.line.thickness   : 1
curve.line.style       : solid 
curve.symbol.color     : default
curve.symbol.style     : cross
curve.symbol.size      : 5
curve.symbol.angle     : 0
curve.symbol.fill      : true
curve.err.color        : default
curve.err.thickness    : 1
curve.err.style        : line 
curve.err.up           : on
curve.err.down         : on
curve.err.left         : on
curve.err.right        : on
curve.limit.length     : 0.05
curve.limit.override   : true

histogram.stem         : hist
histogram.depth        : default
histogram.line.color   : default
histogram.line.thickness: 1
histogram.line.style   : solid 
histogram.symbol.color : default
histogram.symbol.style : none
histogram.symbol.size  : 5
histogram.symbol.angle : 0
histogram.symbol.fill  : false
histogram.err.color    : default
histogram.err.thickness: 1
histogram.err.style    : line 
histogram.err.up       : on
histogram.err.down     : on
histogram.dropline     : off
histogram.fill.color    : default
histogram.fill.opacity: 1
histogram.fill.style   : none

contour.stem           : ctr
contour.color          : default
contour.thickness      : 1
contour.numlevels      : 5
contour.style          : solid 
contour.algorithm      : marching
contour.mode           : nice 
contour.interval       : 10
contour.depth          : default

label.stem             : lbl
label.font             : helvetica
label.color            : default
label.size             : 12
label.fontstyle        : normal 
label.angle            : 0
label.halign           : left
label.valign           : base
label.depth            : default

line.stem              : line
line.color             : default
line.thickness         : 1
line.depth             : default
line.style             : solid
line.extend            : none

point.stem             : pnt
point.color            : default
point.style            : cross
point.size             : 5
point.fill             : true
point.angle            : 0
point.depth            : default

region.stem            : reg
region.fill.color      : green
region.fill.style      : solidfill
region.edge.thickness  : 1
region.edge.style      : solid 
region.edge.color      : green
region.angle           : 0
region.opacity         : 0.5
region.depth           : default

foreground.file        : black
background.file        : white
foreground.display     : white
background.display     : black

export.fonts           : true
export.clobber         : false
export.format          : ps
export.orientation     : portrait
export.colorscheme     : rgb 
export.leftmargin      : .2
export.rightmargin     : .2
export.topmargin       : .2
export.bottommargin    : .2
export.pagewidth       : 8.5
export.pageheight      : 11
export.pagesize        : letter
export.pageunits       : inch
export.scaleheight     : 0
export.scalewidth      : 0
export.keepaspect      : true
export.fittopage       : false

pick.mask              : BTNS_DOWN|KEY_PRESS
pick.color             : gold

info.coord             : false
info.current           : false
info.depth             : false

default.depth          : 100
default.verbosity      : 2

chips.shell            : python

Window Preferences

For more information on a preference, refer to "ahelp set_window".

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

Frame Preferences

For more information on a preference, refer to "ahelp set_frame".

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

Plot Preferences

For more information on a preference, refer to "ahelp set_plot".

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

Axis Preferences

For more information on a preference, refer to "ahelp set_axis".

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

Curve Preferences

For more information on a preference, refer to "ahelp set_curve".

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

Histogram Preferences

For more information on a preference, refer to "ahelp set_histogram".

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

Contour Preferences

For more information on a preference, refer to "ahelp set_contour".

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

Label Preferences

For more information on a preference, refer to "ahelp set_label".

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

Line Preferences

For more information on a preference, refer to "ahelp set_line".

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

Point Preferences

For more information on a preference, refer to "ahelp set_point".

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

Region Preferences

For more information on a preference, refer to "ahelp set_region".

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

Export Preferences

For more information on a preference, refer to the Export section of "ahelp chipsopt".

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?

ChIPS Preferences

Attribute Description
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.

Bugs

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

See Also

chips
chips
Last modified: April 2009



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.