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

set_contour

Context: sl.chips

Synopsis

Modifies the attributes of an existing contour.

Syntax

set_contour([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 contour within the current plot.
  • values - a list containing attribute value pairs or a ChipsContour object.

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

Customizing the Contour

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

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

The attributes associated with contours are:

Attribute Description Options Default
algorithm algorithm used to calculate contours chips_standard|chips_marching chips_marching
color Color of the contours name or hex; see the Color section of "ahelp chipsopt" default
depth Integer value indicating line depth see the Depth section of "ahelp chipsopt" 100
interval distance between contours when mode is interval positive floating point value 10.0
levels the exact contours to display positive integer (none)
mode Mode used to determine the contour levels arbitrary|count|interval|limits|nice; see the Contour Mode section of "ahelp chipsopt" nice
numlevels number of contour levels when mode is count positive integer value 5
style the pattern used for the contour style see the Line Style section of "ahelp chipsopt" chips_solid
thickness Thickness of the contour 0.5:9 1

Advanced Functions

The module of advanced ChIPS functions contains other commands for setting attribute values (refer to "ahelp chips" for information on loading the module):

set_contour_algorithm
set_contour_color
set_contour_depth
set_contour_interval
set_contour_levels
set_contour_mode
set_contour_numlevels
set_contour_style
set_contour_thickness
set_contour_transform

Setting the Contour Transform

The transform used to create contours is not controlled by an attribute of the set_contour command. It is specified with set_contour_transform, which is in the module of advanced ChIPS functions.

The command sets the transform to contour for future use and applys the transform to the contour. Contours currently only support a single transform. Multiple calls to this function will cause the transform already associated with the contour to be dropped and the the new transform to be set and applied. Passing "NULL" will cause the transform associated with the contour to be dropped.

Example 1

chips> set_contour({"thickness", 2, "color", "peach"});

Using attribute/value pairs, set the contour to display using a line thickness of 2 and with the color peach.

Example 2

chips> set_contour({"levels", [10,15,20]});
chips> get_contour.mode;
arbitrary

Change the levels being displayed by the contour (setting the levels attribute in this manner automatically changes the mode of the contour to "arbitrary").

Example 3

chips> s = ChipsContour;
chips> s.color = "red";
chips> s.style = "shortdash";
chips> set_contour("ctr1", s);

Populate the "s" structure with attribute values, then use it to set the contour with an id of "ctr1" to use red, short-dashed lines.

Example 4

chips> a = struct { thickness = 2, color = "salmon" };
chips> set_contour(a);

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

CHANGES IN CIAO 4.1

Default algorithm is marching

The default contouring algorithm has been changed to be marching squares since it is a faster algorithm than the standard.

levels and numlevels attributes

The attribute "levels" which refers to the requested number of levels for a given contour in count mode has been changed to "numlevels." When setting the attribute, "levels" now refers to a list of exact levels the user wants the contour to display.

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.