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

Skip the navigation links
Search the ChIPS website
Last modified: December 2007

URL: http://cxc.harvard.edu/chips4.0/set_region.sl.html

[ChIPS Logo]

Home page (ChIPS)
Help pages (AHELP)
List by alphabet
List by context
Jump to:
A B C D E G H I L M P R S T U
 
A
add_axis - py sl
add_contour - py sl
add_curve - py sl
add_frame - py sl
add_histogram - py sl
add_hline - py sl
add_label - py sl
add_line - py sl
add_plotarea - py sl
add_plot - py sl
add_point - py sl
add_region - py sl
add_vline - py sl
add_window - py sl
adjust_grid_gaps - py sl
adjust_grid_xrelsizes - py sl
adjust_grid_xrelsize - py sl
adjust_grid_yrelsizes - py sl
adjust_grid_yrelsize - py sl
attributes - py sl
 
B
bind_axes - py sl
 
C
check_server_exists - py sl
chipsid - py sl
chipsopt - py sl
chips
clear_errors - py sl
clear_plot - py sl
clear - py sl
collapse_depths - py sl
colors - py sl
connect - py sl
convert_coordinate - py sl
coordinates - py sl
create_server - py sl
currency - py sl
current_axis - py sl
current_contour - py sl
current_curve - py sl
current_frame - py sl
current_histogram - py sl
current_label - py sl
current_line - py sl
current_plot - py sl
current_point - py sl
current_region - py sl
current_window - py sl
 
D
deiconify_window - py sl
delete_axis - py sl
delete_contour - py sl
delete_curve - py sl
delete_frame - py sl
delete_histogram - py sl
delete_label - py sl
delete_line - py sl
delete_plot - py sl
delete_point - py sl
delete_region - py sl
delete_window - py sl
depthcontrol - py sl
disconnect - py sl
display_axis - py sl
display_contour - py sl
display_curve - py sl
display_depth - py sl
display_frame - py sl
display_histogram - py sl
display_label - py sl
display_line - py sl
display_plot - py sl
display_point - py sl
display_region - py sl
 
E
entitycreation - py sl
erase - py sl
 
G
get_attribute - py sl
get_axis - py sl
get_contour - py sl
get_curve - py sl
get_default_depth - py sl
get_errors - py sl
get_frame - py sl
get_histogram - py sl
get_label - py sl
get_line - py sl
get_pick - py sl
get_plot_range - py sl
get_plot - py sl
get_point - py sl
get_preferences - py sl
get_preference - py sl
get_region - py sl
get_server_id - py sl
get_window - py sl
get_xaxis - py sl
get_yaxis - py sl
grid_objects - py sl
 
H
hide_axis - py sl
hide_contour - py sl
hide_curve - py sl
hide_depth - py sl
hide_frame - py sl
hide_histogram - py sl
hide_label - py sl
hide_line - py sl
hide_major_ticks - py sl
hide_minor_ticks - py sl
hide_plot - py sl
hide_point - py sl
hide_region - py sl
 
I
iconify_window - py sl
info_bound_axes - py sl
info_coordinate - py sl
info_current - py sl
info_depth - py sl
info - py sl
 
L
limits - py sl
linear_scale - py sl
list_servers - py sl
load_font - py sl
load_preferences - py sl
load_state - py sl
lock - py sl
log_scale - py sl
 
M
make_figure - py sl
move_axis - py sl
move_frame - py sl
move_label - py sl
move_line - py sl
move_plot - py sl
move_point - py sl
move_region - py sl
move - py sl
 
P
pick - py sl
preferences - py sl
print_window - py sl
 
R
redo - py sl
reindex_depth - py sl
reposition_frame - py sl
reposition_plot - py sl
reverse_axes - py sl
 
S
save_preferences - py sl
save_state - py sl
setget - py sl
set_attribute - py sl
set_axis - py sl
set_cascading_property - py sl
set_contour - py sl
set_current - py sl
set_curve - py sl
set_default_depth - py sl
set_error_verbosity - py sl
set_frame - py sl
set_histogram - py sl
set_label - py sl
set_line - py sl
set_plot - py sl
set_point - py sl
set_preferences - py sl
set_preference_autoload - py sl
set_preference - py sl
set_region - py sl
set_window - py sl
set_xaxis - py sl
set_yaxis - py sl
show_major_ticks - py sl
show_minor_ticks - py sl
shuffle_axis - py sl
shuffle_backward - py sl
shuffle_back - py sl
shuffle_contour - py sl
shuffle_curve - py sl
shuffle_forward - py sl
shuffle_front - py sl
shuffle_histogram - py sl
shuffle_label - py sl
shuffle_line - py sl
shuffle_point - py sl
shuffle_region - py sl
shuffle - py sl
split - py sl
strip_chart - py sl
swap_object_positions - py sl
 
T
tile - py sl
 
U
unbind_axes - py sl
undo - py sl
unlock - py sl
 
Jump to:
A B C D E G H I L M P R S T U
Home page (ChIPS)
Help pages (AHELP)
List by alphabet
List by context
Jump to: Description Examples Bugs See Also

AHELP for ChIPS 4.0 set_region Context: sl.chips

Synopsis

Modifies the attributes of an existing region.

Syntax

set_region([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 region within the current frame.
  • values - a list containing attribute value pairs or a ChipsRegion object.

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

Customizing the Region

There are several attributes that control the characteristics of regions. The set_region command may be used to modify the attribute values of an existing region 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 region will not be modified.

The attributes associated with regions are:

Attribute Description Options Default
depth Integer value indicating region depth see the Depth section of "ahelp sl.chips chipsopt" 100
edge.color Color of the region edge see the Color section of "ahelp sl.chips chipsopt" green
edge.style stipple pattern used to draw the region edges see the Line Style section of "ahelp sl.chips chipsopt" chips_solid
edge.thickness Thickness of the region edge 0.5:10 1
fill.color Color of the region fill, if visible see the Color section of "ahelp sl.chips chipsopt" green
fill.visible Should the region be filled or not false|true; see the Booleans section of "ahelp sl.chips chipsopt" false
opacity Opacity of the region fill, if visible 0.0:1.0 0.5

These individual commands are also available for setting attribute values: 

set_region_depth
set_region_edgecolor
set_region_edgestyle
set_region_edgethickness
set_region_fill
set_region_fillcolor
set_region_opacity

Example 1

chips> set_region({"edge.color","plum", "edge.style", "dot"});

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

Example 2

chips> settings = ChipsRegion;
chips> settings.edge.color = "blue";
chips> settings.edge.thickness = 2;
chips> set_region("reg1",settings);

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

Example 3

chips> a=struct {edge,fill};
chips> a.edge =struct {color};
chips> a.fill =struct {color};
chips> a.edge.color="red";
chips> a.fill.color="blue";
chips> set_region(a);

Create a user-defined structure with edge.color and fill.color fields. Use the structure to modify the values of the current region.

Example 4

chips> a=struct {depth};
chips> a.depth=50;
chips> set_region(a);

Create a user-defined structure with depth field. Use the structure to modify the values of the current region.

Bugs

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

See Also

sl.chips
add_region, current_region, delete_region, display_region, get_region, hide_region, move_region, set_current, setget, shuffle_region
Last modified: December 2007


Chandra Science | Chandra Home | Astronomy links | iCXC (CXC only) | Search


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.