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_line.sl.html
AHELP for ChIPS 4.0 set_line Context: sl.chips

Synopsis

Modifies the attributes of an existing line.

Syntax

set_line([id,] values);

Description

  • id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to modify a line within the current frame.
  • values - a list containing attribute value pairs or a ChipsLine object.

The set_line command sets the specified attributes to the provided values. The modified line becomes current. Multiple lines may be modified with a single command by setting the currency to "all".

Customizing the Line

There are several attributes that control the characteristics of lines. The set_line command may be used to modify the attribute values of an existing line at any time during a ChIPS session. See "ahelp sl.chips attributes" and "ahelp sl.chips setget" for more general information.

If multiple attributes are being set simultaneously and one of them fails, the entire command will fail and the line will not be modified.

The attributes associated with lines are:

Attribute Description Options Default
color Color of the line see the Color section of "ahelp sl.chips chipsopt" default
depth Integer value indicating line depth see the Depth section of "ahelp sl.chips chipsopt" 100
extend Should the line extend to infinity (segment vs ray) see the Line Extend section of "ahelp sl.chips chipsopt" none
style Stipple pattern used to draw the line segment see the Line Style section of "ahelp sl.chips chipsopt" chips_solid
thickness Thickness of the line see the Thickness section of "ahelp sl.chips chipsopt" 1

These individual commands are also available for setting attribute values:

set_line_color
set_line_depth
set_line_extend

set_line_style
set_line_thickness

Example 1

chips> set_line({"color","plum", "style", "dot"});

Using attribute/value pairs, set the line color to plum and the stipple pattern to dot.

Example 2

chips> settings = ChipsLine;
chips> settings.color = "blue";
chips> settings.thickness = 2;
chips> set_line("line1",settings);

Populate the "settings" structure with attribute values, then use it to set line1 to be blue with a thickness of 2.

Example 3

chips>a =struct {color, depth};
chips>a.color="lime",a.depth=50;
chips>set_line(a);

Create a user-defined structure with color and depth fields. Use the structure to modify the values of the current line.

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.