Synopsis
Specify the default attribute values and settings for ChIPS to use.
Description
The ChIPS preference file contains default values for object attributes, such as line color, label font, and point symbol. It also contains export settings for printing: output file format, margins, orientation, etc. A list of all the preferences is at the end of this document.
The preference file format is "resource : value", with one entry per line:
window.display : true window.smoothing : true window.height : 360 window.width : 360 window.scaleheight : 1.25 window.scalewidth : 1.25 window.units : pixels window.stem : win ...
Comment lines begin with a pound sign (#).
Setting and retrieving preferences
The set_preference and set_preferences commands change the preference settings of the ChIPS server, the get_preference and get_preferences commands return them.
Saving and loading preferences
The save_preferences command writes out the current preference settings and load_preferences reads them in.
Axis Preferences and Attributes
The attributes associated with axes are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_axis() command. To change the axis preference settings prepend "axis." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| automin | Should the axis automatically reset its minimum when a curve, histogram, image, or contour is added? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| automax | Should the axis automatically reset its maximum when a curve, histogram, image, or contour is added? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| color | Color of the axis base line segment | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| coordsys | coordinate system for the axis | PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA | see "ahelp coordsys" | No |
| depth | Integer value indicating axis depth | see the Depth section of "ahelp chipsopt" | default | Yes |
| label.color | Color of the axis label | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| label.font | font for the axis label text | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| label.fontstyle | style of the axis label text | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| label.halign | Horizontal location of the string reference point of the axis label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| label.size | Font size of the axis label | 1 to 100 | 14 | Yes |
| label.valign | Vertical location of the string reference point of the axis label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| majorgrid.color | Color of the axis major grids | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| majorgrid.style | stipple pattern used to draw the axis major grids | see the Line Style section of "ahelp chipsopt" | shortdash | Yes |
| majorgrid.thickness | Thickness of the axis major grids | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| majorgrid.visible | Should major grids be visible | see the Booleans section of "ahelp chipsopt" | false | Yes |
| majortick.color | The color to use for major ticks | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| majortick.count | Default number of ticks to display when major mode is count | Non-negative integer | 4 | Yes |
| majortick.interval | Spacing to use between ticks when major mode is interval | Non-negative value | 10 | Yes |
| majortick.length | length of major ticks | Non-negative integer | 1 | Yes |
| majortick.mode | Mode of the axis tickmark positioning | arbitrary|count|interval|limits|nice; see the Tick Mode section of "ahelp chipsopt" | limits | Yes |
| majortick.style | Style of the axis tickmarks | inside|outside|centered; see the Tick Style section of "ahelp chipsopt" | inside | Yes |
| majortick.thickness | Thickness of major ticks | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| majortick.visible | Are major ticks visible or hidden | see the Booleans section of "ahelp chipsopt" | true | Yes |
| minorgrid.color | Color of the axis minor grids | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| minorgrid.style | stipple pattern used to draw the axis minor grids | see the Line Style section of "ahelp chipsopt" | dot | Yes |
| minorgrid.thickness | Thickness of the axis minor grids | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| minorgrid.visible | Should minor grids be visible | see the Booleans section of "ahelp chipsopt" | false | Yes |
| minortick.color | The color to use for minor ticks | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| minortick.count | Default number of ticks to display when minor mode is count | Non-negative integer | 4 | Yes |
| minortick.interval | Spacing to use between ticks when minor mode is interval | Non-negative value | 10 | Yes |
| minortick.length | length of minor ticks | Non-negative integer | 1 | Yes |
| minortick.mode | Mode of the axis tickmark positioning | arbitrary|count|interval|limits|nice; see the Tick Mode section of "ahelp chipsopt" | nice | Yes |
| minortick.style | Style of the axis tickmarks | inside|outside|centered; see the Tick Style section of "ahelp chipsopt" | inside | Yes |
| minortick.thickness | Thickness of minor ticks | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| minortick.visible | Are minor ticks visible or hidden | see the Booleans section of "ahelp chipsopt" | true | Yes |
| offset.parallel | axis label offset from axis start (-.5) to axis end (.5) | -0.5 to 0.5 inclusive; 0 is the center and -0.5/+0.5 refer to the edges | 0 | Yes |
| offset.perpendicular | axis label offset from axis baseline in pixels | -100 to 100, inclusive | 40 | Yes |
| pad | The percentage of padding to add to an axis in arbitrary limits or interval modes | Non-negative value | 0.05 | Yes |
| thickness | Thickness of the axis | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| tickformat | print format for axis ticklabels | alphanumeric; see the Tick Format section of "ahelp chipsopt" | %g | Yes |
| ticklabel.angle | angle, in degrees, of the axis ticklabel | -360.0 to 360.0 | 0 | Yes |
| ticklabel.color | Color of the axis ticklabels | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| ticklabel.font | font for the axis ticklabel text | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| ticklabel.fontstyle | style of the axis ticklabel text | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| ticklabel.halign | Horizontal location of the string reference point of the axis ticklabel | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| ticklabel.offset | Offset of ticklabels to axis base (in pixels) | Non-negative value | 6 | Yes |
| ticklabel.size | Font size of the axis ticklabel | 1 to 100 | 12 | Yes |
| ticklabel.style | Style of the axis ticklabels | inside, outside | outside | Yes |
| ticklabel.valign | Vertical location of the string reference point of the axis ticklabel | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| ticklabel.visible | Should ticklabels be visible | see the Booleans section of "ahelp chipsopt" | true | No |
| x.label.text | The text used for the X axis label | A text label with limited support for LaTeX commands; see the Text Formatting section of "ahelp chipsopt". | Yes | |
| x.label.angle | The angle used for the X axis label | 0 is horizontal, 90 is vertical with text reading from bottom to top, and 270 is vertical with text reading from top to bottom. | 0 | Yes |
| x.stem | stem used for x axis id | An alpha-numeric character sequence that does not contain a space | ax | No |
| y.label.text | The text used for the Y axis label | A text label with limited support for LaTeX commands; see the Text Formatting section of "ahelp chipsopt". | Yes | |
| y.label.angle | The angle used for the Y axis label | 0 is horizontal, 90 is vertical with text reading from bottom to top, and 270 is vertical with text reading from top to bottom. | 90 | Yes |
| y.stem | stem used for y axis id | An alpha-numeric character sequence that does not contain a space | ay | No |
The label.angle field
The label.angle field was removed in CIAO 4.6; the x.label.angle and y.label angle fields should be used instead.
Colorbar Preferences and Attributes
The attributes associated with colorbars are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_colorbar() command. To change the colorbar preference settings prepend "colorbar." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| border.visible | should the border of the colorbar be visible? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| depth | the depth of the colorbar | see the Depth section of "ahelp chipsopt" | default | Yes |
| halign | horizontal alignment of the colorbar | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| label.angle | angle, in degrees, of the label | -360.0 to 360.0 | 0 | Yes |
| label.color | color of the label | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| label.font | font for the label | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| label.fontstyle | style for the label | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| label.halign | horizontal alignment of the label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | auto | Yes |
| label.location | which side of the colorbar does the label appear on, relative to the plot center? | outside|inside | inside | Yes |
| label.size | size of the label | 1 to 100 | 12 | Yes |
| label.text | text for the colorbar label | Yes | ||
| label.valign | vertical alignment of the label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | auto | Yes |
| label.visible | should the label be visible? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| length | the length of the colorbar, in plot-normalized coordinates | A real number, greater than 0. | 1 | Yes |
| offset.parallel | shift of the label from the center of the colorbar | -0.5 to 0.5 inclusive; 0 is the center and -0.5/+0.5 refer to the edges | 0 | Yes |
| offset.perpendicular | shift of the label from the edge of the colorbar (in pixels) | -100 to 100, inclusive | 5 | Yes |
| orientation | orientation of the colorbar | "horizontal" or "vertical" | horizontal | Yes |
| stem | stem to use for colorbar ids | An alpha-numeric character sequence that does not contain a space | cbar | No |
| tick.color | color of the tickmarks | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| tick.length | length of the tickmarks | Non-negative integer | 4 | Yes |
| tick.location | should the ticks and labels appear on the outside or inside of the colorbar with reference to plot center? | inside|outside | outside | Yes |
| tick.mode | mode for calculating tickmark locations | arbitrary|count|interval|limits|nice; see the Tick Mode section of "ahelp chipsopt" | nice | Yes |
| tick.style | should the tickmarks extend into the colorbar, point out of the colorbar, or both (inside, outside, or centered)? | inside|outside|centered; see the Tick Style section of "ahelp chipsopt" | inside | Yes |
| tick.thickness | thickness of the tickmarks | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| tick.visible | should the tickmarks be visible? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| ticklabel.angle | angle, in degrees, of the tickmark labels | -360.0 to 360.0 | 0 | Yes |
| ticklabel.color | color for the numeric tickmark labels | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| ticklabel.font | font for the tickmark labels | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| ticklabel.fontstyle | style for the tickmark labels | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| ticklabel.halign | horizontal alignment of the tickmark labels | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | auto | Yes |
| ticklabel.offset | separation, in pixels, of the tickmark labels from the colorbar | Non-negative value | 6 | Yes |
| ticklabel.size | font size of the numeric tickmark labels | 1 to 100 | 12 | Yes |
| ticklabel.valign | vertical alignment of the tickmark labels | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | auto | Yes |
| ticklabel.visible | should the tickmark labels be visible? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| valign | vertical alignment of the colorbar | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| width | the width of the colorbar, in plot-normalized coordinates | Non-negative value | 0.05 | Yes |
Contour Preferences and Attributes
The attributes associated with contours are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_contour() command. To change the contour preference settings prepend "contour." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| algorithm | the contouring algorithm to be used | standard, marching | marching | Yes |
| color | contour color | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| depth | Depth used for the contour object | see the Depth section of "ahelp chipsopt" | default | Yes |
| interval | Indicates the delta value from one contour level to the next whem mode=interval | Non-negative value | 10 | Yes |
| levels | When setting, this attribute controls the the contour levels to display when the mode is "arbitrary". When using get_contour() this attribute contains the actual contour levels displayed. | Array or list of numbers | [] | Yes |
| mode | How the contour levels are determined | arbitrary|count|interval|limits|nice; see the Tick Mode section of "ahelp chipsopt" | nice | Yes |
| numlevels | number of contour levels when mode is count | Non-negative integer | 5 | Yes |
| stem | Stem used for contour id | An alpha-numeric character sequence that does not contain a space | ctr | No |
| style | Stipple pattern used to draw the line segment | see the Line Style section of "ahelp chipsopt" | solid | Yes |
| thickness | Thickness of the line | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| wcs | The name of the coordinate system to use | "logical", "physical", "world". You can also use the names of the transforms, such as "sky" and "EQPOS". | "world", if available and supported (WCS-TAN). | No |
Curve Preferences and Attributes
The attributes associated with curves are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_curve() command. To change the curve preference settings prepend "curve." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| baddata | How to handle NaNs and +/-infs in data | omit, ignore: omit means to discard bad data point and leave gap, ignore means discard bad points, connecting the surrounding points | omit | Yes |
| depth | Depth of the curve | see the Depth section of "ahelp chipsopt" | default | Yes |
| err.caplength | Length of the cap drawn on error bars (when err.style is cap). | 1 to 100, inclusive. | 10 | Yes |
| err.color | Color of the curve err bars | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| err.down | Plot y down errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| err.left | Plot x down errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| err.right | Plot x up errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| err.style | Specifies the error bar style | bar|line|cap (bar and line are identical) | line | Yes |
| err.thickness | Specifies the thickness of error bars | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| err.up | Plot y up errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| limitlength | Length of the bars for upper and lower limits | 0 to 1 in plot normalized coordinates | 0.05 | Yes |
| limitoverride | Should both the limit and the error bar be drawn on a point? | true = hide the errors, false = show the errors; see the Booleans section of "ahelp chipsopt" | true | Yes |
| line.color | Color of the curve line | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| line.style | the pattern used for the curve line style | see the Line Style section of "ahelp chipsopt" | solid | Yes |
| line.thickness | Thickness of the curve line | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| stem | Stem used for curve id | An alpha-numeric character sequence that does not contain a space | crv | No |
| symbol.angle | The angle, in degrees, of rotation for the curve symbols | -360.0 to 360.0 | 0.0 | Yes |
| symbol.color | Color of the curve symbols | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| symbol.fill | Should the curve symbols be filled or not | see the Booleans section of "ahelp chipsopt" | true | Yes |
| symbol.size | Size of the curve symbols | 1 to 100 | 2 | Yes |
| symbol.style | The shape of the glyph used as the curve symbols | see the Symbol Styles section of "ahelp chipsopt" | cross | Yes |
Export Preferences
The attributes associated with export are given in the following table. All values can be changed using the print_window() command. To change the export preference settings prepend "export." to the attribute name.
| Attribute | Description | Options | Default |
|---|---|---|---|
| bottommargin | size of the bottom margin | numerical value, with the units taken from the window.units or pageunits setting. | 0.2 |
| clobber | Overwrite an existing file? | see the Booleans section of "ahelp chipsopt" | false |
| colorscheme | indicates the color specification scheme | rgb|cmyk|cmyksep|greyscale|grayscale | rgb |
| dpi | What resolution should be used when displaying images, in dots per inch. | Non-negative integer | 150 |
| fittopage | Fits the image to the page size; aspect ratio is controlled by the "keepaspect" attribute | see the Booleans section of "ahelp chipsopt" | false |
| fonts | should the font be written to the printer, if the image is going to the printer | see the Booleans section of "ahelp chipsopt" | true |
| format (only used if not included as part of the file name) | export file format | ps|eps|pdf|png|jpg|jpeg | ps |
| keepaspect | Maintain aspect ratio of the image while fitting to the page? | see the Booleans section of "ahelp chipsopt" | true |
| leftmargin | size of the left margin | numerical value, with the units taken from the window.units or pageunits setting. | 0.2 |
| orientation | page layout orientation | landscape|portrait | portrait |
| pageheight | height of the saved file image (PS and PDF formats only). This value overrides the window dimensions, and the units are taken from the window.units setting unless overridden by export.pageunits | numerical value | 0.0 |
| pagesize | print size (PS and PDF formats only) | letter|legal|executive|A3|A4|A5 | letter |
| pageunits | Units of measure of the pagesize (PS and PDF formats only) | inches|cm|mm|pixels | inches |
| pagewidth | width of the saved file image (PS and PDF formats only). This value overrides the window dimensions, and the units taken from the window.units setting unless overridden by export.pageunits | numerical value | 0.0 |
| printdialog | if true, ChIPS will open a GUI for selecting the export option when print_window is called | see the Booleans section of "ahelp chipsopt" | false |
| printmethod | This setting is to support users with ATI Gallium display drivers who see displays being flipped by print_window. In this case, change the preference to xoffscreen. | One of framebuffer, xoffscreen, or none. | framebuffer |
| rightmargin | size of the right margin | numerical value, with the units taken from the window.units or pageunits setting. | 0.2 |
| scaleheight | Factor for scaling the height value | Floating point percentage value | 0.0 |
| scalewidth | Factor for scaling the width value | Floating point percentage value | 0.0 |
| topmargin | size of the top margin | numerical value, with the units taken from the window.units or pageunits setting. | 0.2 |
Frame Preferences and Attributes
The attributes associated with frames are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_frame() command. To change the frame preference settings prepend "frame." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| aspect | Maintain the aspect ration of the frame when changing tiling modes? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| bgcolor | Background color of the frame. | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| border.color | Color of the border denoting the location of a frame in the window. | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| border.visible | Boolean flag indicating if the frame border should be visible. | see the Booleans section of "ahelp chipsopt" | false | Yes |
| mode | how the frame is displayed in the window | placed or single | placed | No |
| scale | If set to true, all labels inside a window are rescaled as the window size is altered. | see the Booleans section of "ahelp chipsopt" | true | Yes |
| stem | Default stem for newly created frames | An alpha-numeric character sequence that does not contain a space | frm | No |
| transparency | Boolean flag indicating whether any object behind the frame is visible. | see the Booleans section of "ahelp chipsopt" | false | Yes |
Histogram Preferences and Attributes
The attributes associated with histograms are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_histogram() command. To change the histogram preference settings prepend "histogram." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| depth | Value indicating the depth of the plot title | see the Depth section of "ahelp chipsopt" | default | Yes |
| dropline | Boolean indicating whether bin edges are extended to 0 for connected bins | on|off | on | Yes |
| err.caplength | Length of the cap drawn on error bars (when err.style is cap). | 1 to 100, inclusive. | 10 | Yes |
| err.color | Color of the curve err bars | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| err.down | Histogram y down errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| err.style | Specifies the error bar style | bar or cap | bar | Yes |
| err.thickness | Specifies the thickness of error bars | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| err.up | Histogram y up errors if data provided | see the Booleans section of "ahelp chipsopt" | true | Yes |
| fill.color | Color of the histogram fill | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| fill.opacity | Opacity of the histogram fill | 0.0 to 1.0, inclusive, where 0 is fully transparent and 1 is fully opaque | 1.0 | Yes |
| fill.style | The fill style for the histogram | see the Fill Pattern section of "ahelp chipsopt" | 0 (no fill) | Yes |
| line.color | Color of the curve line | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| line.style | The pattern used for the histogram line style | see the Line Style section of "ahelp chipsopt" | chips_solid | Yes |
| line.thickness | Thickness of the histogram line | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| stem | stem used for histogram id | An alpha-numeric character sequence that does not contain a space | hst | No |
| symbol.angle | The angle, in degrees, of rotation for the histogram symbols | -360.0 to 360.0 | 0.0 | Yes |
| symbol.color | Color of the histogram symbols | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| symbol.fill | Should the histogram symbols be filled or not | see the Booleans section of "ahelp chipsopt" | false | Yes |
| symbol.size | Size of the curve symbols | 1 to 100 | 5 | Yes |
| symbol.style | The shape of the glyph used as the histogram symbols | see the Symbol Styles section of "ahelp chipsopt" | chips_none | Yes |
Image Preferences and Attributes
The attributes associated with images are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_image() command. To change the image preference settings prepend "image." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| alpha | A two-element array of the minimum and maximum values to use for the alpha channel. | The values are normalized to the data range, so should be in the range 0 to 1, inclusive. A setting of [1,1] is fully opaque whereas [0.5,0.5] makes every pixel 50 per cent transparent, and [0,1] makes the minimum value fully transparent and the maximum value fully opaque. | [-1, -1] | Yes |
| colormap | the color map used to display the image | red|green|blue|grayscale| rainbow|hsv|heat|cool| usercmap1|usercmap2|usercmap3; see the colormap section of "ahelp chipsopt" | grayscale | Yes |
| colormap_interpolate | should the colormap be interpolated over the size of the colormap | see the Booleans section of "ahelp chipsopt" | true | Yes |
| colormap_size | number of entries to use from the color map | 256 | Yes | |
| depth | Value indicating the depth of the image | see the Depth section of "ahelp chipsopt" | default | Yes |
| interpolation | the interpolation method used to display the image pixels | neighbor|bilinear|bicubic | neighbor | Yes |
| invert_colormap | should the colormap be inverted? | see the Booleans section of "ahelp chipsopt" | false | Yes |
| scale_channels | when displaying true-color images, should each channel (other than alpha) be normalized to its own range (true) or the range of all the channels (false). | see the Booleans section of "ahelp chipsopt" | true | Yes |
| stem | stem to use for image ids | An alpha-numeric character sequence that does not contain a space | image | No |
| threshold | A two-element array of the minimum and maximum values to use for thresholding the image. | The values are normalized to the data range, so should be in the range 0 to 1, inclusive. A setting of [0,1] means use the whole pixel range whilst [0.05,0.95] would only use the central 90% of the pixel range. | [-1, -1] | Yes |
| wcs | The name of the coordinate system to use | "logical", "physical", "world". You can also use the names of the transforms, such as "sky" and "EQPOS". | "world", if available and supported (WCS-TAN). | No |
Info Preferences
The following preference settings affect the output of the info() command.
| Argument | Description | Options | Default | Related command |
|---|---|---|---|---|
| coord | Appends the coordinate system of all applicable objects as "cs <coordinate system>". If the object is in data coordinates, the data coordinate id is included: "cs DATA:<id>". | see the Booleans section of "ahelp chipsopt" | false | info_cordinate() |
| current | Displays the current objects in reverse video. Several characters are added around the ids, which should be taken into account if parsing the string. | see the Booleans section of "ahelp chipsopt" | false | info_current() |
| depth | Appends the depth of all applicable objects as "d <depth>". | see the Booleans section of "ahelp chipsopt" | false | info_depth() |
Label Preferences and Attributes
The attributes associated with labels are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_label() command. To change the label preference settings prepend "label." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| angle | Angle, in degrees, at which the label is drawn | -360.0 to 360.0 | 0.0 | Yes |
| color | Color of the text | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| coordsys | coordinate system for the label | PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA | see "ahelp coordsys" | No |
| depth | Integer value indicating label depth | see the Depth section of "ahelp chipsopt" | default | Yes |
| font | text font | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| fontstyle | style of the label text | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| halign | Horizontal location of the string reference point of the label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | left | Yes |
| size | Font size of the text | 1 to 100 | 12 | Yes |
| stem | stem used for label id | An alpha-numeric character sequence that does not contain a space | lbl | No |
| valign | Vertical location of the string reference point of the label | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | base | Yes |
Line Preferences and Attributes
The attributes associated with lines are given in the following table, where the "Set?" column refers to whether the attribute can be change using the set_line() command. To change the line preference settings prepend "line." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| color | line color | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| coordsys | coordinate system for the line | PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA | see "ahelp coordsys" | No |
| depth | Integer value indicating line depth | see the Depth section of "ahelp chipsopt" | default | Yes |
| extend | Should the line extend to infinity (segment vs ray) | One of "none", "both", "start", "end", chips_extend_none, chips_extend_both, chips_extend_start, or chips_extend_end. | chips_extend_none | Yes |
| stem | stem used for line id | An alpha-numeric character sequence that does not contain a space | line | No |
| style | stipple pattern used to draw the line segment | see the Line Style section of "ahelp chipsopt" | chips_solid | Yes |
| thickness | line thickness | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
Plot Preferences and Attributes
The attributes associated with plots are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_plot() command. To change the plot preference settings prepend "plot." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| bottommargin | The distance, in Frame Normalized coordinates, between the bottom plot border and the bottom border of the frame containing the plot | Real values ranging from zero through one | 0.15 | Yes |
| corner.style | border corner style | miter|bevel|fill|notch; see "ahelp set_plot" for descriptions | miter | Yes |
| leftmargin | The distance, in Frame Normalized coordinates, between the left plot border and the left border of the frame containing the plot | Zero through one | 0.15 | Yes |
| rightmargin | The distance, in Frame Normalized coordinates, between the right plot border and the right border of the frame containing the plot | Real values ranging from zero through one | 0.10 | Yes |
| stem | stem used for plot id | An alpha-numeric character sequence that does not contain a space | plt | No |
| style | border style | open|box|closed; see "ahelp add_plot" for descriptions | closed | Yes |
| title.angle | Angle, in degrees, at which the plot title is drawn | -360.0 to 360.0 | 0.0 | Yes |
| title.color | Color of the plot title text string | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| title.depth | Integer value indicating the depth of the plot title | see the Depth section of "ahelp chipsopt" | default | Yes |
| title.font | Plot title font | helvetica|courier|times|greek; see the Font section of "ahelp chipsopt" | helvetica | Yes |
| title.fontstyle | Specific attributes of the text string independent of size or font | normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt" | normal | Yes |
| title.halign | Horizontal location of the string reference point of the plot title | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | center | Yes |
| title.size | Font size of the plot title | 1 to 100 | 16 | Yes |
| title.valign | Vertical location of the string reference point of the plot title | auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt" | auto | Yes |
| title.xpos | X position, in Plot Normalized coordinates, of the reference point of the plot title | Real values ranging from zero through one | 0.5 | Yes |
| title.ypos | Y position, in Plot Normalized coordinates, of the reference point of the plot title | Real values. | 1.05 | Yes |
| topmargin | The distance, in Frame Normalized coordinates, between the upper plot border and the upper border of the frame containing the plot | Real values ranging from zero through one | 0.10 | Yes |
| aspect.ratio | The default aspect ratio of the plot, where "" means no aspect ratio is set. | See "ahelp aspectratio" for the meaning and syntax of this value. | Yes |
Point Preferences and Attributes
The attributes associated with points are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_point() command. To change the point preference settings prepend "point." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| angle | Angle, in degrees, at which the point is drawn | -360.0 to 360.0 | 0.0 | Yes |
| color | color of the point | name or hex; see the Color section of "ahelp chipsopt" | default | Yes |
| coordsys | coordinate system for the point | PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA | see "ahelp coordsys" | Yes |
| depth | Integer value indicating point depth | see the Depth section of "ahelp chipsopt" | default | Yes |
| fill | fill the point? | see the Booleans section of "ahelp chipsopt" | true | Yes |
| size | size of the point | 1 to 100 | 12 | Yes |
| stem | stem used for point id | An alpha-numeric character sequence that does not contain a space | pnt | No |
| style | symbol style | see the Symbol Styles section of "ahelp chipsopt" | cross | Yes |
Region Preferences and Attributes
The attributes associated with regions are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_region() command. To change the region preference settings prepend "region." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| angle | Angle, in degrees, at which the region is drawn | -360.0 to 360.0 | 0.0 | Yes |
| coordsys | coordinate system for the region | PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA | see "ahelp coordsys" | No |
| depth | Integer value indicating region depth | see the Depth section of "ahelp chipsopt" | default | Yes |
| edge.color | region edge color | name or hex; see the Color section of "ahelp chipsopt" | green | Yes |
| edge.style | stipple pattern used to draw the region edges | see the Line Style section of "ahelp chipsopt" | chips_solid | Yes |
| edge.thickness | Thickness of the region edge | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | Yes |
| fill.color | region fill color | name or hex; see the Color section of "ahelp chipsopt" | green | Yes |
| fill.style | Fill style for the region | see the Fill Pattern section of "ahelp chipsopt" | 0 (no fill) | Yes |
| opacity | Opacity of the region fill | 0.0 to 1.0, inclusive, where 0 is fully transparent and 1 is fully opaque | 0.5 | Yes |
| stem | stem used for region id | An alpha-numeric character sequence that does not contain a space | reg | No |
Window Preferences and Attributes
The attributes associated with windows are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_window() command. To change the window preference settings prepend "window." to the attribute name.
| Attribute | Description | Options | Default | Set? |
|---|---|---|---|---|
| bgcolor | Background Color of the window | name or hex; see the Color section of "ahelp chipsopt" | default: white in the ChIPS window, black on printout | Yes |
| display | Flag indicating whether the window should be rendered | see the Booleans section of "ahelp chipsopt" | true | Yes |
| geom | A geometry hint to the window manager to say where the ChIPS window should be created (this setting may be ignored, depending on the window manager in use). The format is either a blank string or a string containing two signed integers such as "+100+50", "+0+20", or "+0+0". | No | ||
| grid.color | The color to draw the grid lines. | name or hex; see the Color section of "ahelp chipsopt" | default | No |
| grid.scale | Where should the grid lines be drawn? | One of quarterinch, halfinch, cm, or normalized (spacing of a tenth of the window width/height). These can also be specified as default (for quarterinch) or the enumerations 0, 1, 2, 3, 4 for default, quarterinch, halfinch, cm, normalized respectively. | quarterinch | No |
| grid.style | The style used to draw the grid lines. | see the Line Style section of "ahelp chipsopt" | longdash | No |
| grid.thickness | The thickness used to draw the grid lines. | 0.5 to 10.0; see the Thickness section of "ahelp chipsopt" | 1 | No |
| grid.visible | Should the grid be visible or not. | see the Booleans section of "ahelp chipsopt" | false | No |
| height | window height | Numerical value expressed in either inches, centimeters, millimeters or pixels | 360 pixels | No |
| scaleheight | factor to scale window to display at approximate height | positive floating point value | 1.25 | No |
| scalewidth | factor to scale window to display at approximate width | positive floating point value | 1.25 | No |
| smoothing | use VTK's smoothing to reduce anti-aliasing | see the Booleans section of "ahelp chipsopt" | true | No |
| stem | Stem used for window id | An alpha-numeric character sequence that does not contain a space | win | No |
| prefix | Prefix added to window id to create the text that the window manager may use to label the ChIPS window. | "chips - " | No | |
| units | Units of the window width and height dimensions | inches|cm|mm|pixels | pixels | No |
| width | window width | Numerical value expressed in either inches, centimeters, millimeters or pixels | 360 pixels | No |
Miscellaneous Preferences
The following preference settings affect various parts of ChIPS.
| Argument | Description | Options | Default |
|---|---|---|---|
| background.display | default background color for screen displays | name or hex; see the Color section of "ahelp chipsopt" | black |
| background.file | default background color for output files (created by print_window) | name or hex; see the Color section of "ahelp chipsopt" | white |
| default.depth | depth to use for objects with depth of default | see the Depth section of "ahelp chipsopt" | 100 |
| default.verbosity | verbosity level for error handling | 2 | |
| foreground.display | default foreground color for screen displays | name or hex; see the Color section of "ahelp chipsopt" | white |
| foreground.file | default foreground color for output files (created by print_window) | name or hex; see the Color section of "ahelp chipsopt" | black |
| pick.color | color to draw the rectangle displayed by the pick_limits() command | name or hex; see the Color section of "ahelp chipsopt" | gold |
| pick.mask | event mask to use for pick operation | One or more of KEY_PRESS, KEY_RELEASE, BTNS_DOWN, BTNS_UP, BTN<n>_DOWN, BTN<n>_UP (for <n> = 1, 2, or 3). | BTNS_DOWN|KEY_PRESS |
GUI Preferences
The following preference settings affect the behavior of the ChIPS GUI. They can be changed using the set_preference() call or using the "Edit/Gui Configuration" menu item from the GUI.
| Argument | Description | Options | Default |
|---|---|---|---|
| gui.view.toolbar | Show Toolbar | see the Booleans section of "ahelp chipsopt" | true |
| gui.view.propertyframe | Show Property Frame | see the Booleans section of "ahelp chipsopt" | true |
| gui.view.navframe | Show Coordinate Frame | see the Booleans section of "ahelp chipsopt" | true |
| gui.view.infoframe | Show Information Frame | see the Booleans section of "ahelp chipsopt" | true |
| gui.view.shellframe | Show Shell Frame | see the Booleans section of "ahelp chipsopt" | true |
| gui.toolbar.mode | The default mode to start the GUI up with | pan | pan, range, or select |
| gui.toolbar.style | Display the toolbar buttons as icons, labels, or both | both | both, icons, or label |
| gui.toolbar.zoom | Include the Range/Zoom button in the toolbar? | true | see the Booleans section of "ahelp chipsopt" |
| gui.tooltips | Show Tooltips? | true | see the Booleans section of "ahelp chipsopt" |
Bugs
See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.
See Also
- chips
- chips, chipsgui, chipsrc, show_gui
- concepts
- aspectratio, attributes, chipsid, chipsopt, colors, coordsys, currency, depthcontrol, entitycreation, setget
- preference
- get_preference, get_preferences, load_preferences, save_preferences, set_preference, set_preference_autoload, set_preferences