XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


elcplot (elcplot-2.6) [xmmsas_20230412_1735-21.0.0]

Parameters

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

ParameterMand Type Default Constraints
setyesdatasetNo default 
Name of the FITS file containing the time series. Case sensitive.
 
gtisetyesdatasetNo default 
Name of the FITS file containing the GTIs. Case sensitive.
 
binsizenoInteger5Constraint : positive value

 
plotdevicenoString“/PS”Constraint : valid device type
Not case sensitive.
 
plotfilenoString“plot.ps“less than 1024 char.
Name of the output file containing the plot. Case sensitive.
 
bkgdyscalenobooleannoyes/no
To scale the y-axis of the plot of the background counts to be the same as the y-axis of the plot of the source counts
 
unitsnostringsecssecs or days
units for the x-axis
 
offsetnobooleannoyes/no
Would the user like to specify an offset for the time-axis
 
offsetstylenostringautoauto/dateobs/user
The type of offset to be used - auto uses the first bin in the timeseries as the, dateobs uses the DATEOBS keyword to provide the zeropoint and user means that the user can supply the offset using the tscaleoffset parameter.
 
tscaleoffsetnoreal0.0Constraint : greater than or equal to zero
The offset value to be applied to the time-axis
 
ounitsnostringdayssecs or days
units in which the offset value `tscaleoffset' is specified
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2023-04-16