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

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


AHELP for CIAO 4.9 ChIPS v1

hide_depth

Context: depth

Synopsis

Hide the objects at the specified depth.

Syntax

hide_depth(depth)
hide_depth(id, depth)

Description

The function arguments.

Argument Description
depth The depth value (an integer greater than 0) to hide.
id A ChipsId structure identifying the item, or a string containing the name of the object.

The hide_depth command hides all objects at a specific depth. The objects remain hidden until display_depth is called or they are moved to a depth which is not hidden. Objects which were hidden using another method, such as "hide_<object>", will remain hidden even if the depth is changed.

The info_depth command can be used to find out the depths of the ChIPS objects.

Example 1

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=100')
chips> add_hline(5, 'depth=50 color=red')
chips> hide_depth(50)

Create two curvess and a horizontal line at different depths. Hide everything at depth 50 (i.e. the line and the blue curve).

Example 2

chips> add_histogram([1,2,3], [3,5,2], 'fill.style=1 fill.color=red
depth=50')
chips> add_curve([1,2,3], [3,5,2], 'depth=100')
chips> add_label(3, 3, 'LABEL', 'depth=50')
chips> hide_label()
chips> set_plot_title ('My Plot')
chips> set_plot(['title.depth', 50])
chips> hide_depth(50)
chips> set_histogram(["depth", 150])
chips> set_label(["depth", 150])

Create a histogram, a curve, and a label. The label is hidden with the hide_label command. Hide everything at depth 50.

Moving the histogram to a different depth makes it visible again. The same does not work with the label, because it was not hidden by the hide_depth command.

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
collapse_depths, display_depth, get_default_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.