NAME

mk2w1 - Part of the wingscan suite of scripts. Evaluates the 2W1 functions describing the surface brightnesses.

PARAMETERS

mk2w1 uses an IRAF-compatible parameter interface. A template parameter file is in /proj/axaf/simul/lib/uparm/mk2w1.par

input string: Name of the input file. If input equals 'stdin', mkwingsurf reads input from STDIN.
output string: Name of the output file. If output equals 'stdout' or 'stderr', mkwingsurf writes output to STDOUT or STDERR, respectively.
foclen double: Mirror focal length in millimeters.
energy string: Name of the energy column in the input file.
shutters string: Name of the shutters column in the input file.
direction string: Name of the direction column in the input file. This column indicates the direction of the aperture offset relative to the tilt of the optics. It is typically generated by mkwigdir.
radius string: Name of the radius column in the input file.
surfbrt string: Name of the surface brightness column in the input file.
surfbrterr string: Name of the surface brightness error column in the input file.
par0 string: Name of the first fit parameter column in the output file.
par1 string: Name of the second fit parameter column in the output file.
par2 string: Name of the third fit parameter column in the output file.
reduced_chi2 string: Name of the reduced chi squared column from the fit in the output file.
spatfreq string: Name of the spatial frequency column in the output file. Spatial frequency is the indepedant variable in the fits.
w1 string
Name of the 2W1 column in the output file.
w1err string
Name of the 2W1 error column in the output file.
override string

Override fit parameters. This parameter takes a comma or space seperated list of parameters in the form keyword.attribute=value. Valid keywords are par0, par1, par2. Valid attributes are value, min, max, step, fitme.
device string

Name of the PGplot device on which the fits will be displayed. See PGPlot manul for a complete list. 'none' turns off the plotting option.
fitrange string

The range over which the fit is performed. The range is specified by the index of the first and last element in the range, seperated by a colon, ':'. '0:' causes the fit to be performed over all points. The independant variable in the fits is spatial frequency.
help boolean

If set to 'yes', print this help information and exit.
version boolean

If set to 'yes', print version information and exit.
override string: Override fit parameters. This parameter takes a comma or space seperated list of parameters in the form keyword.attribute=value. Valid keywords are par0, par1, par2. Valid attributes are value, min, max, step, fitme.
device string: Name of the PGplot device on which the fits will be displayed. See PGPlot manul for a complete list. 'none' turns off the plotting option.
fitrange string: The range over which the fit is performed. The range is specified by the index of the first and last element in the range, seperated by a colon, ':'. '0:' causes the fit to be performed over all points. The independant variable in the fits is spatial frequency.
help boolean: If set to 'yes', print this help information and exit.
version boolean: If set to 'yes', print version information and exit.

DESCRIPTION

mk2w1 filters the input file passing all existing columns through to the output. It adds columns, whose names are specified by the 2w1 and 2w1err parameters, to the output file. 2w1 specifies the value of the 2W1 function for the surface brightness of the measurement.

2W1 is calculated by grouping measurements by energy, shutter configuration, and direction of the optics tilt. Foreach dataset, the 2w1 is fit by a powerlaw modified by an exponential. The fit function has three parameters. These parameters may be modified via the override parameter. The function is of the form par0 * x ^ ( - par1 ) * exp( - x / par2 ).

For further discussions on the exact formulae and algorithms used please refer to the Wing Scans: Analysis chapter of the XRCF Phase 1 Testing: Analysis Results. http://hea-www.harvard.edu/MST/simul/xrcf/report/chaps/wingscan_1up.ps

If the user wishes to integrate the fit to the 2W1 to determine thesurface roughness, sigma, the program pow_exp_integral will enable them to do so.

AUTHOR

M. Tibbetts ( mtibbetts@head-cfa.harvard.edu )