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

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


AHELP for CIAO 4.9 ChIPS v1

get_default_depth

Context: depth

Synopsis

Retrieves the default depth of the frame.

Syntax

get_default_depth()
get_default_depth(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item, or a string containing the name of the object.

Each object has a default depth preference value which may be set in the ChIPS resource file or by calling the set_preference function. The value of the preference may be set to "default" or a positive integer value. If the value is "default", then the default frame depth is used.

The get_default_depth command retrieves the default depth value of the specified frame.

The command can only operate on a single object. An error is returned if currency is set to "all".

For general information on depth, refer to "ahelp depthcontrol".

Example 1

chips> get_default_depth()

Retrieve the default depth from the current frame.

Example 2

chips> get_default_depth("frm2")

Retrieve the default depth value from "frm2".

Bugs

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

See Also

concepts
depthcontrol, setget
depth
collapse_depths, display_depth, hide_depth, reindex_depth, set_default_depth
utilities
set_current

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.