XMM-Newton Science Analysis System


binadapt (binadapt-0.16.1) [xmmsas_20230412_1735-21.0.0]

Parameters

This section documents the parameters recognized by this task (if any).

The program defaults to deriving a filename of the form comb-elow-ehigh.fits. If using singular expids, enter that as the prefix. If left blank (AND withmask=T), binadapt will derive a mask filename based on other parameters. The mask images must be the same size and projection as the other images. Since masks can come from many sources, it is recommended the user enter withmask=T maskfile=yourmaskfile together. In the default mode the average exposure is calculated and then any pixel with exposure less than fraction*average value is excluded.

Parameter	Mand	Type	Default	Constraints
prefix	no	string	comb
Input inst+exposure ID (1S001, S003) OR “comb” to use combimage inputs.
elow	no	int	350	$0<=elow<=11999$
Lower energy limit for the energy band in eV.
ehigh	no	int	1100	$1<=ehigh<=12000$
Upper energy limit for the energy band in eV.
withpartbkg	no	bool	no	T/F
Particle background control, "yes" to subtract the model (QPB) particle background image.
withspbkg	no	bool	no	T/F
Soft proton background control, "yes" to subtract the soft proton background image.
withswcxbkg	no	bool	no	T/F
Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
withmask	no	bool	no	T/F
Apply additional masking using input image?
maskfile	no	dataset	default
The filename for an image to provide additional masking if desired.
withbinning	no	bool	yes	T/F
Perform binning?
binfactor	no	int	2	$1<=binfactor$
Binning factor.
withsmoothing	no	bool	yes	T/F
Perform smoothing?
smoothcounts	no	int	50	$1<=smoothcounts<=100$
Smoothing factor.
maskthresh	no	real	0.02	$0.001<=maskthresh$
The scale factor for excluding regions from the smoothing based on a mask image.
Parameter	Mand	Type	Default	Constraints