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

URL: http://cxc.harvard.edu/chips/ahelp/collapse_depths.html
Jump to: Description · Example · Bugs · See Also


AHELP for CIAO 4.9 ChIPS v1

collapse_depths

Context: depth

Synopsis

Merges an array of depths into a single new depth.

Syntax

collapse_depths(depth_list, newdepth)
collapse_depths(id, depth_list, newdepth)

Description

The function arguments.

Argument Description
depth_list A list of one or more depth values.
newdepth The new object depth.
id A ChipsId structure identifying the item, or a string containing the name of the object.

The collapse_depths command merges an array of depths into a single new depth. The order in which the depths are specified dictates the order in which the objects are merged into the new depth.

Use the info_depth command to see which depths are being used. For general information on depth, refer to "ahelp depthcontrol".

Example

chips> add_curve(range(10), range(10), 'line.color=blue
symbol.color=blue depth=50')
chips> add_curve(range(10), range(9,-1,-1), 'depth=200')
chips> add_hline(5, 'depth=70 color=red')
chips> collapse_depths([50,70,100], 200)

Create two curves and a horizontal line at different depths. All objects at depths 50, 70, and 100 are collapsed to a depth of 200.

Bugs

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

See Also

concepts
chipsid, currency, depthcontrol
depth
display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth

Last modified: December 2013
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.