mirfiller.setoptions

return the current filler options

Synopsis
setoptions(scanlim, obslim, tilesize, verbose, wideconv, joinpol, tsyswt, compress, updmodelint, reset)

Description
This function allows one to set a number of options that control the filling. Normally, if an option value is not provided, the option will retain its previously set value (or its default if it has not been set by the user). This allows one to set options independently. This behavior can be overridden with reset=T which will reset all option values to their default before the newly provided values are set.

Arguments

scanlim	the scan time jump limit. If the jump in time between two consecutive Miriad records is greater than this limit the scan number that gets written out for that record will be incremented. A change in source will always increment the scan number unless scanlim is negative; in this case, all records are forced to have the same scan number.
	Default:	5 minutes
obslim	the observation ID time jump limit. The observation ID is meant to delimit two tracks that might appear in the same file. If the jump in time between two consecutive Miriad records is greater than this limit the scan number that gets written out for that record will be incremented. The ID will always be incremented if there is a change in telescope or array configuration unless obslim is negative, in which case, all records will be forced to have the same observation ID.
	Default:	5 minutes
tilesize	the tiling size to use for storing data in the MS using the TiledStorageManager. If the value is <= 0, the standard (non-tiled) storage manager will be used.
	Default:	32
verbose	If true, extra messages will be sent to the logger.
	Default:	F
wideconv	a string representing the convention to use for interpreting the wideband channels. Currently, this option only affects the writing out of window associations in the spectral window subtable.
	Allowed:	'bima' - assume that the first two wideband channels are the lower & upper sideband averages and the remaining channels represent averages of each of the spectral line windows; the output wideband and spectral line windows will be linked accordingly in the spectral window subtable. 'none' - assume no convention for the wideband channels, and therefore, encode no associations.
	Default:	the convention detected when mirfiller was constructed
joinpol	If false (the default), visibilities of different polarization correlation types will be loaded into different records. This is appropriate for uncalibrated BIMA data. If this option is true, the different polarizations observed at the same time will be gathered into a output record. This is appropriate for BIMA polarization measurement data that has been calibrated and time-averaged or data from a telescope with dual-polarization receivers. See section on Polarization in mirfiller module description for further discussion.
	Default:	F
tsyswt	If true (the default), the system temperatures will be used to estimate the theoretical noise for the data which will subsequently be used (automatically) as weights during imaging. If false, system temperature weighting will be disabled. (System temperatures will be loaded regardless.)
	Default:	T
compress	If true, the data will be written in compressed form. Compression reduces the size of the output MS by about a factor of two but also limits the dynamic range to 65000:1 (well above what is achievable with typical BIMA data).
	Default:	F
updmodelint	the time interval after which the model for planet observations should be updated.
	Default:	8 hours
reset	If true, all above options are reset to their default values before modifying them to the new values
	Default:	F

Example
The example shows a Glish session demonstrating getoptions() and setoptions(). Text to the right of the ``- '' (and before the ``#'') represents the user input; the text after ``#'' explain what's happening.

- frommir := mirfiller('3c273')
- frommir.getoptions()                      # see the default options
[tilesize=32, scanlim=[value=5, unit=min], obslim=[value=4, unit=h], 
wideconv=none, joinpol=F, tsyswt=T, planetfit=4, movfield=T, 
updmodelint=[value=8, unit=h], verbose=T]
- frommir.setoptions(verbose=T, scanlim='2min') # set two options
T
- frommir.getoptions();                     # see the results
[tilesize=32, scanlim=[value=2, unit=min], obslim=[value=4, unit=h], 
wideconv=none, joinpol=F, tsyswt=T, planetfit=4, movfield=T, 
updmodelint=[value=8, unit=h], verbose=T]
- frommir.setoptions(obslim='0.5h')            # set an additional option
T
- frommir.getoptions()
[tilesize=32, scanlim=[value=120, unit=min], obslim=[value=0.5, unit=h], 
wideconv=none, joinpol=F, tsyswt=T, planetfit=4, movfield=T, 
updmodelint=[value=8, unit=h], verbose=T]
- frommir.setoptions(updmodelint='120min')	# set model update interval to 120 minutes
T
- frommir.getoptions()
[tilesize=32, scanlim=[value=120, unit=min], obslim=[value=0.5, unit=h], 
wideconv=none, joinpol=F, tsyswt=T, planetfit=4, movfield=T, 
updmodelint=[value=2, unit=h], verbose=T]
- frommir.setoptions(verbose=T, reset=T)    # now reset and set an option
T
- frommir.getoptions();
[tilesize=32, scanlim=[value=5, unit=min], obslim=[value=4, unit=h], 
wideconv=none, joinpol=F, tsyswt=T, planetfit=4, movfield=T, 
updmodelint=[value=8, unit=h], verbose=T]

Next: mirfiller.fill - Function Up: mirfiller - Tool Previous: mirfiller.getoptions - Function Contents Index

	Package	bima
	Module	mirfiller
	Tool	mirfiller

mirfiller.setoptions - Function