Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: 15 December 2016

Alphabetical List of Ahelp Files


    Topic Context Summary
A add_axis axes Creates an axis or axes.
add_colorbar images Create a colorbar for an image
add_contour contours Creates a contour plot from an image or (x,y,z) values.
add_curve curves Creates a curve (a set of two-dimensional points optionally marked by points or connected by lines)
add_fov_region contrib Display a Chandra FOV (field-of-view) file as a region.
add_frame frames Creates a frame.
add_histogram histograms Creates a histogram-style figure.
add_hline lines Creates a horizontal line.
add_image images Adds an image to the current window.
add_label labels Creates a label.
add_line lines Creates a line connecting two or more points.
add_plot plots Creates a plot.
add_point points Creates a point.
add_region regions Creates a region.
add_vline lines Creates a vertical line.
add_window windows Creates a window.
adjust_grid_gaps plots Modifies the spacing between plots created by split or grid_objects.
adjust_grid_xrelsizes plots Modifies the widths of all columns of plots created by split or grid_objects.
adjust_grid_xrelsize plots Modifies the widths of one column of plots created by split or grid_objects.
adjust_grid_yrelsizes plots Specify the height of all rows of plots created by split or grid_objects.
adjust_grid_yrelsize plots Modifies the height of one row of plots created by split or grid_objects.
arrange_frames frames Reorder the frames in a window.
aspectratio concepts A discussion of the aspect ratio support in ChIPS.
attributes concepts Attributes are used to configure object properties such as color, font, and line style.

B bind_axes axes Link two axes so that changes in the range, scale or other attributes in one will be automatically copied to the other.
blink_frames frames Blink between two frames; stop blink mode.

C check_server_exists server Determines if the specified server is currently running.
chipsgui chips The ChIPS GUI
chipsid concepts The ChipsId structure is used to specify the currency state and coordinate system.
chipsopt concepts The ChIPS Dictionary is a glossary of frequently-used terms and attribute value listings.
chipsrc chips The .chips.rc file provides user-configuration options for ChIPS
chips_contrib contrib Contributed CIAO routines for ChIPS.
chips_decorators contrib Python decorators for ChIPS
chips_helix contrib Load the Cube Helix colormap into ChIPS
chips_images contrib Image routines for ChIPS (CIAO contributed package)
chips_pyplot contrib A basic matplotlib/pyplot-like interface to ChIPS
chips_regions contrib Region routines for ChIPS (CIAO contributed package)
chips_scatter contrib Create multiple scatter plots (CIAO contributed package)
chips_utils contrib Utility routines for ChIPS (CIAO contributed package)
chips chips Introduction to ChIPS, the CIAO plotting package
clear_errors errors Clears the ChIPS server error list.
clear_plot plots Delete the contents of the plotting area.
clear utilities Deletes all windows (and their contents).
collapse_depths depth Merges an array of depths into a single new depth.
colors concepts Use of colors in ChIPS.
connect server Attaches a ChIPS client to the specified server.
convert_coordinate coordinates Converts a point from one ChIPS coordinate system to another.
coordsys concepts ChIPS coordinate systems: pixel, window normalized, frame normalized, plot normalized, and data.
create_server server Launches a new ChIPS server and connects the client to it.
currency concepts Currency is the notion of which objects in a ChIPS visualization are currently being used (e.g. having their attributes changed).
current_axis axes Set the specified axis as current.
current_colorbar images Set the specified colorbar as current.
current_contour contours Set the specified contour as current.
current_curve curves Set the specified curve as current.
current_frame frames Set the specified frame as current.
current_histogram histograms Set the specified histogram as current.
current_image images Set the specified image as current.
current_label labels Set the specified label as current.
current_line lines Set the specified line as current.
current_plot plots Set the specified plot as current.
current_point points Set the specified point as current.
current_region regions Set the specified region as current.
current_window windows Set the specified window as current.

D deiconify_window windows Deiconifies the ChIPS window.
delete_axis axes Delete the specified axis.
delete_colorbar images Delete the specified colorbar.
delete_contour contours Delete the specified contour.
delete_curve curves Delete the specified curve.
delete_frame frames Delete the specified frame.
delete_histogram histograms Delete the specified histogram.
delete_image images Delete the specified image.
delete_label labels Delete the specified label.
delete_line lines Delete the specified line.
delete_plot plots Delete the specified plot.
delete_point points Delete the specified point.
delete_region regions Delete the specified region.
delete_window windows Delete the specified window.
depthcontrol concepts Depth contols the rendering order and appearance when objects overlap.
disconnect server Disconnects a client from a ChIPS server.
display_axis axes Display the specified axis.
display_colorbar images Display the specified colorbar.
display_contour contours Display the specified contour.
display_curve curves Display the specified curve.
display_depth depth Display the objects at the specified depth
display_frame frames Display the specified frame.
display_histogram histograms Display the specified histogram.
display_image images Display the specified image.
display_label labels Display the specified label.
display_line lines Display the specified line.
display_major_ticks axes Displays the major tickmarks for the specified axis or axes.
display_minor_ticks axes Displays the minor tickmarks for the specified axis or axes.
display_plot plots Display the specified plot.
display_point points Display the specified point.
display_region regions Display the specified region.

E entitycreation concepts Managing the creation of all levels of the object hierarchy.
erase utilities Remove all frames (and their contents) from the window.

G get_attribute utilities Retrieves attribute value(s) for an object.
get_axis axes Retrieves the attribute value(s) of the axis.
get_colorbar images Retrieves the attribute value(s) of the colorbar.
get_contour contours Retrieves the attribute value(s) of the contour.
get_curve curves Retrieves the attribute value(s) of the curve.
get_default_depth depth Retrieves the default depth of the frame.
get_errors errors Retrieves errors from the ChIPS server error list.
get_error_count errors Retrieves the number of instances of the specified ChIPS error type.
get_error_types errors Retrieves the types of ChIPS errors collected.
get_error_verbosity errors Returns the ChIPS error report "verbosity" setting presently in effect.
get_frame frames Retrieves the attribute value(s) of the frame.
get_histogram histograms Retrieves the attribute value(s) of the histogram.
get_image images Retrieves the attribute value(s) of the image.
get_label labels Retrieves the attribute value(s) of the label.
get_line lines Retrieves the attribute value(s) of the line.
get_object_count utilities Get the number of instances of the specified object type
get_pick coordinates Return the coordinates of one or more mouse or key presses.
get_plot_range limits Retrieves the range of the current axes or axis of the current plot.
get_plot plots Retrieves the attribute value(s) of the plot.
get_point points Retrieves the attribute value(s) of the point.
get_preferences preference Retrieves the preference value(s) for the specified object.
get_preference preference Retrieves the preference value(s) for the specified object.
get_region regions Retrieves the attribute value(s) of the region.
get_server_cwd server Retrieve the working directory of the ChIPS server/GUI print dialog
get_server_id server Retrieves the id of the ChIPS server to which the client is connected.
get_window windows Retrieves the attribute value(s) of the window.
get_xaxis axes Retrieves the attribute value(s) of the X axis.
get_yaxis axes Retrieves the attribute value(s) of the y-axis.
grid_objects plots Rearrange plots into a grid.

H hide_axis axes Hide the specified axis.
hide_colorbar images Hide the specified colorbar.
hide_contour contours Hide the specified contour.
hide_curve curves Hide the specified curve.
hide_depth depth Hide the objects at the specified depth.
hide_frame frames Hide the specified frame.
hide_histogram histograms Hide the specified histogram.
hide_image images Hide the specified image.
hide_label labels Hide the specified label.
hide_line lines Hide the specified line.
hide_major_ticks axes Hides the major tickmarks of the axis or axes.
hide_minor_ticks axes Hides the minor tickmarks of the axis or axes.
hide_plot plots Hide the specified plot.
hide_point points Hide the specified point.
hide_region regions Hide the specified region.
highlight_object utilities Blink the specified object in order to identify it in the plot.

I iconify_window windows Iconifies the ChIPS window.
info_bound_axes axes Returns a string containing a listing of bound axes.
info_coordinate coordinates Returns a string containing a listing of available data coordinate systems.
info_current utilities Returns a string containing a listing of the current objects.
info_depth depth Returns a string containing a listing of objects at the specified depth.
info utilities Returns a string containing a listing of ChIPS objects.

L limits limits Changes the limits of one or more axes of the current plot.
lin_scale axes Changes the plot axis to use a linear scale.
list_servers server Displays a list of ChIPS servers.
load_colormap images Create a colormap for images from arrays or a file.
load_fill utilities Loads a pattern file to use in filling regions or histograms.
load_font utilities Loads a font file from disk for use with any ChIPS text element.
load_preferences preference Loads ChIPS preferences from a file.
load_state saving Restores a ChIPS session from a state file.
lock server Locks a chips server so that only commands from the locking client will be processed.
log_scale axes Changes the plot axis to use a logarithmic scale.

M make_figure chips Create a basic plot of a curve, contour, image, or histogram (includes axis labels and a plot title).
make_script saving Create a Python script that will re-create the current ChIPS session.
move_axis axes Moves the axis to a new location.
move_colorbar images Moves the colorbar to a new location.
move_frame frames Moves the frame to a new location.
move_label labels Moves the label to a new location.
move_line lines Moves the line to a new location.
move_plot plots Moves the plot to a new location.
move_point points Moves the point to a new location.
move_region regions Moves the region to a new location.
move utilities Moves the specified object to a new location.

N next_frame frames Cycles forward and backward through the frames in a window.

P panto limits Change the location of the center of the plot.
pick_limits limits Interactively change the limits of a plot using the mouse.
pick coordinates Display the coordinates of one or more mouse or key presses.
preferences concepts Specify the default attribute values and settings for ChIPS to use.
print_image images Prints the image to a file or the printer.
print_window windows Prints the window to a file or the printer.

R redo undo Re-executes the last undone command or series of commands.
reindex_depth depth Moves all items from one depth to a new depth.
remove_image_channel images Add or delete a channel from the image.
reposition_frame frames Repositions the frame within the window.
reposition_plot plots Repositions the plot within the frame.
reverse_axes axes Reverses the direction of one or more axes.

S save_preferences preference Saves ChIPS preferences to a file.
save_state saving Saves the ChIPS session into a state file.
scatterlimits contrib Change the limits of one variable in a scatter plot.
scatterplots contrib Create, or add to, a set of scatter plots.
scatterscale contrib Change the scaling of one or more variables in a scatter plot.
setget concepts Methods of obtaining and modifying the attributes of object.
set_arbitrary_tick_positions axes Change the position and labels for the major tickmarks on an axis
set_attribute utilities Sets the attribute value(s) for the specified object.
set_axis axes Modifies the attributes of an existing axis.
set_cascading_property utilities Sets all occurrences of the attribute within a specified hierarchy.
set_colorbar images Modifies the attributes of an existing colorbar.
set_contour contours Modifies the attributes of an existing contour.
set_current utilities Set the specified object as current.
set_curve curves Modifies the attributes of an existing curve.
set_data_aspect_ratio plots Set or retrieve the aspect ratio information of the data.
set_default_depth depth Sets the default depth of the frame.
set_error_verbosity errors Controls the amount of error information returned by ChIPS.
set_frame frames Modifies the attributes of an existing frame.
set_histogram histograms Modifies the attributes of an existing histogram.
set_image images Modifies the attributes of an existing image.
set_label labels Modifies the attributes of an existing label.
set_line lines Modifies the attributes of an existing line.
set_plot_aspect_ratio plots Set or retrieve the aspect ratio information of the plot.
set_plot plots Modifies the attributes of an existing plot.
set_point points Modifies the attributes of an existing point.
set_preferences preference Sets the specified preferences.
set_preference_autoload preference Automatically loads the chips.rc file into preferences when the ChIPS server starts up.
set_preference preference Sets the specified preference.
set_region regions Modifies the attributes of an existing region.
set_window windows Modifies the attributes of an existing window.
set_xaxis axes Modifies the attributes of an existing x axis.
set_yaxis axes Modifies the attributes of an existing y axis.
show_gui chips Launch the ChIPS graphic user interface (GUI)
shuffle_axis axes Shuffles the rendering order of the axis within the depth.
shuffle_backward shuffle Shuffles the object one step backward in the depth.
shuffle_back shuffle Shuffles the object to the back of the depth.
shuffle_colorbar images Shuffles the rendering order of the colorbar within the depth.
shuffle_contour contours Shuffles the rendering order of the contour within the depth.
shuffle_curve curves Shuffles the rendering order of the curve within the depth.
shuffle_forward shuffle Shuffles the object one step forward in the depth.
shuffle_front shuffle Shuffles the object to the front of the depth.
shuffle_histogram histograms Shuffles the rendering order of the histogram within the depth.
shuffle_image images Shuffles the rendering order of the image within the depth.
shuffle_label labels Shuffles the rendering order of the label within the depth.
shuffle_line lines Shuffles the rendering order of the line within the depth.
shuffle_point points Shuffles the rendering order of the point within the depth.
shuffle_region regions Shuffles the rendering order of the region within the depth.
shuffle shuffle Shuffles the rendering order of the object within the depth.
split plots Creates a grid of plot areas
strip_chart plots Creates a strip chart containing multiple plots.
swap_object_positions plots Swaps the locations of the specified plots within a grid or split.

T tile frames Arranges frames into a grid.

U unbind_axes axes Removes the binding between a pair of axes.
undo undo Undoes the last command or series of commands.
unlock server Removes the lock on a server so that other clients may access it.

V valid_type utilities Check that a value is a valid input for a ChIPS attribute (e.g. color or line style).
view_placed_frame frames Sets the window display to placed frame mode.
view_single_frame frames Sets the window display to single frame mode.

Z zoom limits Zoom into or out of a plot by a fixed amount.

Last modified: 15 December 2016
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.