Parameters set by user

The parameters set by the user to control the data processing and output of Kvis are contained in the file ini.params. The file must be in the working directory, otherwise a default location will be searched. The location of the default file is set in vis_main.cc. If the file exists, but a given value is not present or an error is encountered during the read, a default value is used. The default values are chosen to be appropriate for the standard data reduction. A description of all the variables in ini.params in given in Table 1 and further discussion of the more detailed parameters is in the following sections.

The file format is taken from the PTI vis.params file and input routines, which were written by Brad Hines. The variables in the file can appear in any order within the header categories of grouping, processing and flags. The variable names are case insensitive and must be separated from the value by an =. Comments are designated with a ; at the start. The format of the file, along with the default values, is:

[grouping]
frameTime = 0.1
minFrameFill = 0.5
blockTime = 5.0
minBlockFill = 0.5

[processing]
specAvgType = 0
doCal = 1
calType = 3
saveCalData = 0
doDewarp = 1

[flags]
doPrintRaw = 0
doPrintSample = 0
doPrintFrame = 0
doPrintBlock = 1
doPrintSpec = 1
doPrintAnc = 1

Table 1: Brief descriptions of all parameters in the ini.params file.

grouping
frameTime	Length of frame in seconds
	Allowed values:	real
minFrameFill	Minimum fraction of frame with good data
	Allowed values:	0 to 1
blockTime	Length of block in seconds
	Allowed values:	real
minBlockFill	Minimum fraction of block with good data
	Allowed values:	0 to 1
processing
specAvgType	Sets weights used in spectrometer channel averaging
	Allowed values:	0	weights = 1
		1	weights $\propto$ 1/$\sigma^{2}_{{V_i^2}}$
doCal	Allowed values:	0	no calibration applied
		1	calibration applied
calType	Controls which calibration data is used
	Allowed values:	0	data read from file calData.input
		1	use DARK,BRIGHT data
		2	use BRIGHT and closest BACKGROUND data
		3	use BRIGHT and median BACKGROUND data
		4	use BRIGHT, BACKGROUND and FOREGROUND data
		5	use BRIGHT, BACKGROUND and FOREGROUND data
saveCalData	Controls writing of calibration data to file
	Allowed values:	0	no file written
		1	write data to file calData.input
doDewarp	Allowed values:	0	no dewarping calibration applied
		1	dewarping calibration applied
flags
doPrintRaw	prints all samples (WB only) regardless of data type
doPrintSample	prints calibrated samples, one line per channel, grouped by frame
doPrintFrame	prints calibrated frames, one line per channel
doPrintBlock	prints WB and averaged spectrometer channels
doPrintSpec	prints individual spec channel blocks
doPrintAnc	prints ancillary telemetry
	Allowed values:	0	do not print
		1	print