CXC Home Page

Chandra Science Links

Skip the navigation links

[CIAO Logo]

Home page (CIAO)
Help pages (AHELP)
List by alphabet
List by context
Jump to:: A C D E F G H I K L M O P R S T V W

A: acisreadcorr
acisspec
acis_bkgrnd_lookup
acis_build_badpix
acis_classify_hotpix
acis_detect_afterglow
acis_fef_lookup
acis_find_hotpix
acis_process_events
acis_run_hotpix
acis_set_ardlib
acis_streak_map
aconvolve
acrosscorr
add_col - py sl
add_grating_orders
add_grating_spectra
add_image - py sl
add_key - py sl
ahelp
analysis-menu
apowerspectrum
apply_transform - py sl
aprates
ardlib
arestore
asphist
autoname
axbary
C: caldb
calindex
calquiz
celldetect
check_ciao_caldb
ciaorc
ciao_contrib - py sl
ciao_utils - py sl
ciao
colden
col_exists - py sl
coords
copy_colvals - py sl
copy_transform - py sl
cratedata - py sl
crates_contrib - py sl
crates_utils - py sl
crates - py sl
csmooth
D: dates
dax
deflare
delete_col - py sl
delete_image - py sl
delete_key - py sl
destreak
dither_region
dmappend
dmarfadd
dmascii
dmbinning
dmcontour
dmcoords
dmcopy
dmdiff
dmellipse
dmextract
dmfiltering
dmfilth
dmgroupreg
dmgroup
dmgti
dmhedit
dmhistory
dmimg2jpg
dmimgadapt
dmimgblob
dmimgcalc
dmimgfilt
dmimghist
dmimglasso
dmimgpick
dmimgproject
dmimgreproject
dmimgthresh
dmjoin
dmkeypar
dmlist
dmmakepar
dmmakereg
dmmaskbin
dmmaskfill
dmmath
dmmerge
dmnautilus
dmopt
dmpaste
dmreadpar
dmregions
dmregrid2
dmregrid
dmsort
dmstat
dmtcalc
dmtype2split
dm
E: eff2evt
evalpos
eventdef
F: fullgarf
G: get_axis_transform - py sl
get_chart_spectrum - py sl
get_colvals - py sl
get_col_names - py sl
get_col - py sl
get_crate_item_type - py sl
get_crate_type - py sl
get_data_prof_prefs - py sl
get_data_prof - py sl
get_delchi_prof_prefs - py sl
get_delchi_prof - py sl
get_fit_prof - py sl
get_imagevals - py sl
get_image_shape - py sl
get_image - py sl
get_instmap_weights - py sl
get_keyval - py sl
get_key_names - py sl
get_key - py sl
get_model_prof_prefs - py sl
get_model_prof - py sl
get_number_cols - py sl
get_number_rows - py sl
get_resid_prof_prefs - py sl
get_resid_prof - py sl
get_sky_limits
get_source_prof_prefs - py sl
get_source_prof - py sl
get_src_region
get_transform_matrix - py sl
get_transform_type - py sl
get_transform - py sl
glvary
group_slang
grpAdaptiveSnr
grpAdaptive
grpBinFile
grpBinWidth
grpBin
grpGetChansPerGroup
grpGetGroupSum
grpGetGrpNum
grpMaxSlope
grpMinSlope
grpNumBins
grpNumCounts
grpSnr
gui
H: hrc_build_badpix
hrc_dtfstats
hrc_process_events
I: is_arf - py sl
is_pha - py sl
is_rmf - py sl
is_virtual - py sl
K: key_exists - py sl
L: lc_clean - py sl
lc_sigma_clip - py sl
level
lightcurves - py sl
lim_sens
M: make_table_crate - py sl
merge_all
merging_rules
mkacisrmf
mkarf
mkbgreg
mkexpmap
mkgarf
mkgrmf
mkinstmap
mkpsfmap
mkpsf
mkrmf
mksubbgreg
mkwarf
modelflux
mtl_build_gti
mtl
O: obsvis
P: paccess (paramio)
paccess (tools)
paramclose
parameter
paramio
paramopen
pdump
peg
pgets
pget (paramio)
pget (tools)
pileup_map
pileup
pimms
pixlib
pix_apply_aspect
pix_chip_to_fpc
pix_chip_to_gdp
pix_chip_to_tdet
pix_close_pixlib
pix_deapply_aspect
pix_disp_config
pix_dmTanPixToWorld
pix_dmTanWorldToPix
pix_fpc_to_chip
pix_fpc_to_gdp
pix_fpc_to_msc
pix_gac_to_gdp
pix_gdp_to_gac
pix_get_energy
pix_get_flength
pix_get_fp_scale_in_asec
pix_get_grating_angle
pix_get_grating_period
pix_get_grating_wavelength
pix_get_rowland
pix_init_pixlib
pix_set_aimpoint
pix_set_detector
pix_set_fpsys
pix_set_gdpsys
pix_set_grating
pix_set_gzo
pix_set_simoffset
pix_set_tdetsys
pix_tdet_to_chip
pline
plist_names
plist
plot_chart_spectrum - py sl
plot_energy_flux - py sl
plot_instmap_weights - py sl
plot_photon_flux - py sl
pquery (paramio)
pquery (tools)
precess
print_axis_names - py sl
print_col_names - py sl
print_key_names - py sl
prism
prof_data - py sl
prof_delchi - py sl
prof_fit_delchi - py sl
prof_fit_resid - py sl
prof_fit - py sl
prof_model - py sl
prof_resid - py sl
prof_source - py sl
prop-coords
prop-time
prop-tools
pset (paramio)
pset (tools)
psextract
psf_project_ray
punlearn (paramio)
punlearn (tools)
python
R: read_arf - py sl
read_file - py sl
read_pha - py sl
read_rmf - py sl
regArea
regExtent
regInsideRegion
region
regParse
regPrintRegion
regRegionString
reproject_aspect
reproject_events
reproject_image_grid
reproject_image
rmfimg
S: sample_energy_flux - py sl
sample_photon_flux - py sl
save_chart_spectrum - py sl
save_instmap_weights - py sl
set_colvals - py sl
set_imagevals - py sl
set_keyval - py sl
set_param_limits_from_image - py sl
sherpa_chart - py sl
sherpa_contrib - py sl
sherpa_flux_dist - py sl
sherpa_profiles - py sl
sherpa_utils - py sl
simple_hist - py sl
simple_stats - py sl
skyfov
slang
slsh
specextract
srcextent
sso_freeze
stackio
stack
stk_append
stk_build (stackio)
stk_build (tools)
stk_change_current
stk_change_num
stk_close
stk_count (stackio)
stk_count (tools)
stk_current
stk_delete_current
stk_delete_num
stk_disp
stk_expand_n
stk_read_next
stk_read_num (stackio)
stk_read_num (tools)
stk_rewind
stk_set_current
stk_where
subspace
T: taskmonitor
tgdetect
tgextract2
tgextract
tgidselectsrc
tgmatchsrc
tg_bkg
tg_create_mask
tg_resolve_events
times
transform - py sl
V: vtpdetect
W: wavdetect
wcs_match
wcs_update
wrecon
write_arf - py sl
write_arrays - py sl
write_columns - py sl
write_file - py sl
write_pha - py sl
write_rmf - py sl
wtransform

Jump to:: A C D E F G H I K L M O P R S T V W
Home page (CIAO)
Help pages (AHELP)
List by alphabet
List by context

Jump to: Description Examples Parameters Bugs See Also

AHELP for CIAO 4.1

pset

Context: tools

Synopsis

Set parameter values on the command line

Syntax

pset toolname [ [ param1[=vaue1] param2 ...] | [value1] ... ]

Description

pset is used to set parameters. The parameters can be specified on the command line in the order they appear in the parameter file or by using the parameter=value pair. If no parameters or values are specified, the tool will prompt for all the parameter (hidden and queried) in the specified parameter file.

In addition to setting parameter values, one can also change the behavior of the tool by setting the parameter attributes. The available attributes are listed below, and they are set using the name parameter.attribute (as shown in example 4 below).

Parameter Attributes

p_mode	Changes whether a parameter is prompted for or not.
p_value	Changes the parameter value. Same as if no ".attribute" is specified
p_min	Reset the parameter minimum allowed value
p_max	Reset the parameter maximum allowed value
p_prompt	Change the parameter prompt

Resetting the min and max values of a parameter file should be done with EXTREME caution. Changing the mode of the parameter may cause unexpected results -- specifically, changing hidden parameters to automatic/querried will change the command line behavior if the parameter=value syntax is not used. The parameter prompt is safe to change to suit the user's tastes.

Example 1

(1) pset dmlist

This will prompt the user for all the parameter in the dmlist.par file.

Example 2

(2) pset dmlist my_file

This will set the first non-hidden parameter in the dmlist.par file, which happens to be "infile", to be set to "my_file".

Example 3

(3) pset /tmp/dmlist.par infile=my_file outfile=""

This sets the infile parameter in /tmp/dmlist.par to be "my_file" and sets the outfile parameter to be blank.

Example 4

(4) pset dmlist infile.p_prompt="Your most excellent Chandra
observation file"

This replaces the prompt of the infile parameter of dmlist with the specified string. Whenever this parameter is prompted for again, it will display the message above.

Parameters

name	type	ftype	reqd
parameter_file	string	input	yes

Detailed Parameter Descriptions

Parameter=parameter_file `(string required filetype=input)`

Name of the parameter

Name of the parameter (optionally with path) to the parameter file.

Bugs

See the bugs page for this tool on the CIAO website for an up-to-date listing of known bugs.

See Also

concept: parameter
modules: paramio
paramio: paccess, paramclose, paramopen, pget, pgets, plist_names, pquery, pset, punlearn
tools: dmhistory, dmkeypar, dmmakepar, dmreadpar, paccess, pdump, pget, pline, plist, pquery, punlearn

Last modified: December 2008

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.