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/add_point.sl.html
AHELP for ChIPS 4.1

add_point

Context: sl.chips

Synopsis

Creates a point.

Syntax

add_point( [ChipsId,] xpos, ypos, [,attributes]);

Description

  • ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
  • xpos, ypos - the location of the point; the current coordinate system is used if one is not specified.
  • attributes - optional parameters which allow the user to configure properties though a structure, list, or attribute string.

The add_point command creates a point whose attributes are specified by user preferences or in an attribute list. The new point becomes current by default; providing a ChipsId overrides the currency state.

The user specifies the location of the point as a coordinate pair (xpos and ypos). This position can be specified in data, pixel, frame, or plot normalized coordinates. Points specified in data coordinates will only be displayed if the are within the coordinate system range.

Customizing the Point

There are several attributes that control the point characteristics. The attributes can be set to the ChIPS defaults, values provided in the add_point command, or values from the user's preference file.

The attributes may also be modified with the set_point command at any time; see "ahelp set_point" and "ahelp setget" for more information.

The attributes associated with points are:

Attribute Description Options Default
angle Angle at which the point is drawn -360.0:360.0 0.0
color color of the point name or hex; see the Color section of "ahelp chipsopt" default
coordsys coordinate system for the point PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA see "ahelp coordsys"
depth Integer value indicating point depth see the Depth section of "ahelp chipsopt" 100
fill fill the point? false|true; see the Booleans section of "ahelp chipsopt" true
size size of the point 1:100 12
stem stem used for point id alphanumeric pnt
style symbol style see the Symbol Styles section of "ahelp chipsopt" cross

Example 1

chips> add_point(.4,.5);

Add a point at position (.4,.5) in the current coordinate system.

Example 2

chips> settings = ChipsPoint;
chips> settings.color = "blue";
chips> settings.size = 18.0;
chips> settings.stem = "MyPoint";
chips> add_point(100,100,settings);

Populating the "settings" structure with the attribute values, then adding the point.

Example 3

chips> add_point(100,100,{"color", "blue", "style", "uptriangle",
"size", "12" });

Add an upward-pointing triangle point, specifying the attribute values in a list.

CHANGES IN CIAO 4.1

coordsys keyword added to attributes

The attribute "coordsys" sets the coordinate system when the object is created. ChipsIds still can be used to set coordinate systems. If a ChipsId and coordsys attribute are both provided, the coordsys value takes precedence.

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.