next up previous contents
Next: Bibliography Up: Data Analysis in Details Previous: Timing Analysis without the


List of ibis_science_analysis parameters

Table 61: ibis_science_analysis parameters description. Query parameters are marked with bold font.
Name Type Description
General parameters
ogDOL string DOL of the Observational Group to be analyzed.

default: ``og_ibis.fits''

startLevel string Analysis level at which the analysis begins. The names of the possible analysis levels are given in section 5.

Possible values: ``COR'' - ``COMP''. Also ``CLEAN'' value is possible.

default: ``COR''

endLevel string Analysis level at which analysis finishes. The names of the possible analysis levels are given in the section 5.

possible values: COR - CLEAN. We recommend you to proceed by steps, as described in the cookbook.

default: ``IMA2''

staring boolean Enter yes if it was a staring observation. It has an influence on PICsIT analysis - for staring observation all shadowgrams are summed before the deconvolution.

default: no

tolerance real tolerance for staring. In case of staring=yes the check is performed that during the Science Windows within the Observation Group the spacecraft was stable within the given tolerance.

default: 0.1

sum_spectra boolean Do the summing of spectra?

default: ``no''

CAT_refCat string DOL of Reference Catalog

default: ``$ISDC_REF_CAT[ISGRI_FLAG>0]''

CAT_usrCat string DOL of User Catalog (CURRENTLY IGNORED!!!)
chatter integer Verbosity level

possible values: 0 - 5, 0 = errors only, 1 = warnings, 2 = normal, ...

default: 2

IC_Group string DOL of Instrument Characteristics master group

default:

``$REP_BASE_PROD/idx/ic/ic_master_file.fits''

IC_Alias string Selection alias for Instrument Characteristics

default: ``OSA''

corrDol string DOL of the isgri off-axis corrections

default: `` ''

rebinned_corrDol_ima string DOL of the rebinned isgri off-axis corrections for imaging

default: `` ''

rebinned_corrDol_spe string DOL of the rebinned isgri off-axis corrections for spectrum

default: `` ''

rebinned_corrDol_lc string DOL of the rebinned isgri off-axis corrections for lc

default: `` ''

rebinned_backDol_ima string DOL of the rebinned isgri back corrections for imaging

default: `` ''

rebinned_backDol_spe string DOL of the rebinned isgri back corrections for spectrum

default: `` ''

rebinned_backDol_lc string DOL of the rebinned isgri back corrections for lc

default: `` ''

GENERAL_clobber boolean Clobber existing output data?

default: YES

GENERAL_levelList boolean List of all levels

default:

COR,GTI,DEAD,BIN_I,BKG_I,CAT_I,IMA,IMA2,BIN_S,SPE,LCR,COMP,CLEAN

Parameters to define which part of data should be analyzed
SWITCH_disableIsgri boolean Disable ISGRI analysis?

possible values: YES, NO

default: NO

SWITCH_disablePICsIT boolean Disable PICsIT analysis?

possible values: YES, NO

default: YES

SWITCH_disableCompton boolean Disable Compton analysis?

possible values: YES, NO

default: YES

SWITCH_osimData boolean Data are from simulator?

possible values: YES, NO

default: NO

Parameters for ibis binning and ibis image reconstruction
IBIS_II_ChanNum integer Number of output energy bands for ISGRI

possible values: -1 - 10

value -1 is for more than 10 energy bands, in this case IBIS_II_inEnergyValues should be set.

default: 4

IBIS_II_E_band_min string List of lower limits of output energy bands (keV) for ISGRI

default: ``20 40 60 100''

IBIS_II_E_band_max string List of upper limits of output energy bands (keV) for ISGRI

default: ``40 60 100 200''

IBIS_II_inEnergyValues string DOL of the energy values when required.

default: `` ''

IBIS_IPS_corrPDH integer (for PICsIT only) Packets threshold for partially downloaded histograms.

default:0

IBIS_IPS_ChanNum integer Number of Energy bands for PICsIT in standard mode.

possible values: 0 - 256

You should set it to -1 to build automatically the only binning for which background maps are present. It corresponds to the following energy ranges (keV): 203 -252, 252 - 329, 329 - 455, 455 - 655, 655 - 1057, 1057 - 1841, 1841 - 3570, 3570 - 6510.

default: -1

IBIS_IPS_E_band_min_s string List of lower energy boundary for PICsIT in standard mode for SINGLE.

Do not touch this parameter!

default: ''''

IBIS_IPS_E_band_max_s string List of higher energy boundary for PICsIT in standard mode for SINGLE.

Do not touch this parameter!

default: ``''

IBIS_IPS_E_band_min_m string List of lower energy boundary for PICsIT in standard mode for MULTIPLE.

Do not touch this parameter!

default: ``''

IBIS_IPS_E_band_max_m string List of higher energy boundary for PICsIT in standard mode for MULTIPLE.

Do not touch this parameter!

default: ``''

IBIS_IP_ChanNum integer Number of Energy bands for PICsIT in photon-by-photon mode.

possible values: 1 - 300

Do not touch this parameter!

default: 3

IBIS_IP_E_band_min_s string List of lower energy boundary (single) for PICsIT

Do not touch this parameter!

default (keV):

``175 600 1000''

IBIS_IP_E_band_max_s string List of higher energy boundary (single) for PICsIT

Do not touch this parameter!

default (keV):

``600 1000 10000''

IBIS_IP_E_band_min_m string List of lower energy boundary (multiple) for PICsIT

Do not touch this parameter!

default (keV):

``350 600 1000''

IBIS_IP_E_band_max_m string List of higher energy boundary (multiple) for PICsIT

Do not touch this parameter!

default (keV):

``600 1000 13500''

IBIS_NoisyDetMethod integer Noisy Pixel detection method

possible values: 0 (only normal noisy detection), 1 (add also spectral noisy detection)

default: 1

These parameters are recommended by the IBIS team, better not to change them.
IBIS_min_rise integer Minimum rise time.

default: 16

IBIS_max_rise integer Maximum rise time.

default:116

IBIS_P_convFact real Conversion factor channel-to-energy.

default: 7.1

ModPixShad integer Minimum number of non-illuminated pixels per module

possible values: 100 - 500

default:400

Parameters specific to SCW1 pipeline.
SCW1_ISGRI_event_select string CFITSIO event selection string

default: `` ''

SCW1_GTI_LimitTable string DOL of the limit table for GTIs

default: `` ''

SCW1_GTI_attTolerance_X real Accepted attitude stability tolerance of X (optical) axis to generate a GTI [arc min]

possible values: 0 - 10800

default: 0.5

SCW1_GTI_attTolerance_Z real Accepted attitude stability tolerance of Z axis to generate a GTI [arc min]"

possible values: 0 - 10800

default: 3.0

SCW1_GTI_gtiUserP string DOL of the user GTI table for PICsIT

default: `` ''

SCW1_GTI_gtiUserI string DOL of the user GTI table for ISGRI

default: `` ''

SCW1_GTI_TimeFormat string Time format to be used

possible values: ``IJD'', ``UTC'', ``OBT''

default: ``IJD''

SCW1_GTI_Accuracy string Used accuracy for OBT to IJD conversion and vice versa

possible values: ``any'', ``inaccurate'', ``accurate''

default: ``any''

SCW1_GTI_SCP string Names of spacecraft GTIs to be merged for PICsIT

default: `` ''

SCW1_GTI_SCI string Names of spacecraft GTIs to be merged for ISGRI

default: `` ''

SCW1_GTI_PICsIT string GTIs to be merged for PICsIT

default:

``VETO ATTITUDE P_SGLE_DATA_GAPS P_MULE_DATA_GAPS''

SCW1_GTI_ISGRI string GTIs to be merged for ISGRI

default: ``VETO ATTITUDE ISGRI_DATA_GAPS''

SCW1_GTI_BTI_Dol string DOL of a bad time interval table (GNRL-INTL-BTI)

default: ``IBIS_CONFIGURATION IBIS_BOOT ISGRI_RISE_TIME VETO_PROBLEM SOLAR_FLARE BELT_CROSSING''

SCW1_GTI_BTI_Names string Input BTI names to be considered

default: `` ''

SCW1_ICOR_idxSwitch string DOL of the index of pixels switches list.

default: `` ''

SCW1_ICOR_GODOL string DOL of the gain-offset table

default: `` ''

SCW1_ICOR_supGDOL string DOL of gain coefficients for 2nd method

default: `` ''

SCW1_ICOR_supODOL string DOL of offset coefficients for 2nd method"

default: `` ''

SCW1_ICOR_riseDOL string DOL of the rise time correction table

default: `` ''

switDOL string switch on time

default: `` ''

SCW1_ICOR_rtcDOL string rise time correction

default: `` ''

SCW1_RTdriftCor integer RT correction level increasing from 0 to 2.If 0, no RT correction, 2 RT drift included into corrections, 1 default value

default: 1

SCW1_ICOR_probShot real Probability of shot time decay.

default: 0.0001

SCW1_PCOR_enerDOL string DOL of the energy correction table (PICsIT)

default: `` ''

SCW1_BIN_cleanTrk integer Cleaning of cosmic-ray induced events.

possible values:

0 = No

1 = Yes

default: 1

SCW1_veto_mod string DOL of the IC file for VETO model and width of Compton window

default: `` ''

SCW1_BIN_I_idxNoisy string DOL of the index of noisy maps.

default: `` ''

SCW1_BIN_I_idxLowThre string index of Low Threshold

default: `` ''

SCW1_BIN_P_inDead string DOL of the dead time data structure.

default: `` ''

SCW1_BIN_P_inGTI string DOL of the good time interval data structure.

default: `` ''

SCW1_BIN_P_PicsCxt string DOL of the PICsIT Context Tables.

default: `` ''

SCW1_BIN_P_HepiLut string DOL of the hepi lut

default: `` ''

SCW1_BKG_divide boolean Divide by efficiency? Do not touch it!

default: no

SCW1_BKG_badpix boolean Remove bad pixels? Do not touch it!

default: yes

SCW1_BKG_flatmodule boolean flatten modules? Do not touch it!

default: no

SCW1_BKG_I_isgrUnifDol string DOL of the ISGRI detector uniformity

possible values:

DOL for a specific model

``-'' - no uniformity correction

`` '' - DOL is taken from the IC tree

default: ``-''

SCW1_BKG_I_isgrBkgDol string DOL of the ISGRI background model

possible values:

DOL for a specific model

``-'' - no background subtraction

`` '' - DOL is taken from the IC tree

default: `` ''

SCW1_BKG_I_method_cor integer Method to be applied for background removal

possible values:

0 - no background correction

1 - background from IC tree is applied to the whole detector

2 - background is threaded for each module separately

When using 1 or 2, brPif and brPifThreshold parameters are taken into account.

default: ``1''

brSrcDOL string DOL of the bright sources catalogue, which will be removed from background mean calculation

default: ``$ISDC_REF_CAT[ISGRI_FLAG>0&&ISGR_FLUX_1>100]''

SCW1_BKG_I_brPifThreshold real pixels with PIF value higher will be removed from background calculation.

When = 1, bright PIF removal will not be performed

possible values: ``0 - 1 ''

default: ``0.0001''

SCW1_BKG_I_pif string filename of the pif in every ScW

default: `` ''

SCW1_BKG_I_method_int integer Method to be applied for the pixel value interpolation

possible values:

0 - pixels in dead zones are filled with zeros

1 - pixels are filled with mean detector value

default: ``1''

tungAtt string DOL of the Tungsten attenuation length fits file

default: `` ''

aluAtt string DOL of the Aluminium attenuation length fits file

default: `` ''

leadAtt string DOL of the Lead attenuation length fits file

default: `` ''

SCW1_BKG_P_method integer Method applied in filling gaps

possible values:

0 - model (in cts) is normalized by the time of observation

1 - model (in cts) is normalized by the mean count value

default: 0

SCW1_BKG_picsSUnifDOL string DOL of the PICsIT Detector Uniformity model (single).

default: ``-''

SCW1_BKG_picsSBkgDOL string DOL of the PICsIT Detector Background model (single).

default: `` ''

SCW1_BKG_picsMUnifDOL string DOL of the PICsIT Detector Uniformity model (multiple).

default: ``-''

SCW1_BKG_picsMBkgDOL string DOL of the PICsIT Detector Background model (multiple).

default: `` ''

Parameters specific to OBS1 pipeline.
ii_skyimage parameters
OBS1_DataMode integer Data Simulation mode

possible values:

0 - shadowgrams are treated

1 - shadowgrams are simulated

default: 0

rebin_slope real Spectral slope to be used

default: -2

rebin_arfDol string DOL of the ISGRI arf for rebinning.

default: `` ''

OBS1_SearchMode integer Source search mode

possible values for the Science Window analysis:

1 - search for all catalog sources

2 - search for K sources,where K= ToSearch

3 - search for all catalog sources plus for K significant excesses,where K = ToSearch

For all the above, when the mosaic is created, the software looks for K = ToSearch sources.

default: 3

OBS1_ToSearch integer Number of sources to be looked for

default: 50

OBS1_CleanMode integer Ghost cleaning

possible values:

1 - source model lobes are subtracted from the deconvolved image

-1 - no subtraction

default: 1

OBS1_ExtenType integer Save exposure/residual maps

possible values: absent, 0 - 3,

0 or absent - no action

1 - true exposure maps are saved in 4*n extension of isgri_sky_ima.fits instead of residual images

2 - true exposure maps are saved in the 5*n extension of isgri_sky_ima.fits after the residual images

3 - one true exposure map is created for the last energy band and saved in the last extension of isgri_sky_ima.fits

default: 2

OBS1_NegModels integer 0 or absent for no negative models ; 1 - negative models

default: 0

OBS1_FastOpen integer if 1 then no CommonPreparePars

default: 1

ISGRI_mask string DOL of the MASK pattern fits file

default: `` ''

OBS1_deco string DOL of the projected decoding pattern fits file

default: `` ''

OBS1_covrMod string DOL of the covariance fits file

default: ``''

OBS1_ScwType string Type of Science Window to be treated

possible values: ``POINTING'', ``SLEW'', ``OTHER'', ``ANY''

default: ``POINTING''

OBS1_DoPart2 integer if 1 or absent do mosaic part.

Set it to 0 if don't want to produce a mosaic image.

Set it to 2 if you want to produce a mosaic image from different existing runs.

default: 1

OBS1_MapAlpha real Mosaic map center [deg]

default: ""

OBS1_MapDelta real Mosaic map center [deg]

default: ""

OBS1_MapSize real Mosaic map radius [deg]

default: 40.0

OBS1_PixSpread integer 0 - no flux spread in mosaic

default: 1

OBS1_MinCatSouSnr real The software detects a catalog source only if its signal-to-noise ratio is higher than this value.

default: 6

OBS1_MinNewSouSnr real The software detects a catalog source only if its signal-to-noise ratio is higher than this value.

default: 7

OBS1_SouFit integer defines whether to fit or not the source position

0 - for fitting source position in ScW fit

1 - for fixed source position in ScW fit

default: 0

PICSIT_detThr real Detection Threshold

default: 3.0

PICSIT_inCorVar integer Corrected variance to be used [0=NO; 1=YES]

default: 1

PICSIT_outVarian integer Variance maps in output [0=NO; 1=YES]

default: 0

cat_extract parameters, see Section 12.7 for more details.
OBS1_CAT_radiusMin string Low limit for the position selection.

default: ``0''

OBS1_CAT_radiusMax string High limit for the position selection.

default: ``20''

OBS1_CAT_fluxDef string Column used for flux selection.

default: `` ''

OBS1_CAT_fluxMin string Low limit for flux selection.

default: `` ''

OBS1_CAT_fluxMax string High limit for flux selection.

default: `` ''

OBS1_CAT_class string Select the object by class.

default: `` ''

OBS1_CAT_date real IJD for the public data.

default: 1

Parameters specific to SCW2 pipeline.
PICSIT_deco string DOL of the MASK decoding fits file

default: `` ''

SCW2_cat_for_extract string Catalog for spectral and lightcurve extraction

(if empty then it is taken from the imaging result of the Science Window)

default: `` ''

SCW2_racolumn string Name of the column where to get Ra

default: ``RA_FIN''

SCW2_deccolumn string Name of the column where to get Dec

default: ``DEC_FIN''

SCW2_catalog string Catalog for PICsIT imaging

default: `` ''

SCW2_PIF_filter string filter to apply on the source

default: `` ''

SCW2_ISGRI_event_select string CFITSIO event selection string

default: `` ''

parameter for building light curves from PICsIT spectral timing data
Parameters for spectra extraction.
IBIS_SI_ChanNum integer Number of Channels

possible values: -1 - 10,

-1 = take from ISGR-EBDS-MOD structure. In this case parameter IBIS_SI_inEnergyValues must contain the DOL of the rebinned matrix.

default: -1

IBIS_SI_E_band_min string List of lower limits of output energy bands

default: `` ''

IBIS_SI_E_band_max string List of upper limits of output energy bands

default: `` ''

IBIS_SI_inEnergyValues string DOL of the energy values when required.

default: `` ''

PICSIT_source_name string Name of the source for extracting PICsIT spectrum

default: `` ''

PICSIT_source_RA real RA of the source for extracting PICsIT spectrum

default: `` ''

PICSIT_source_DEC real DEC of the source for extracting PICsIT spectrum

default: `` ''

IBIS_SS_inEnergyValues string DOL of the energy values for single PICsIT events

default: `` ''

IBIS_SM_inEnergyValues string DOL of the energy values for multiple PICsIT events

default: `` ''

IBIS_SP_ChanNum integer Number of Channels for PICsIT

possible values: 0 - 300

default: 51

IBIS_SP_E_band_min_s string List of lower limits of output energy bands (PICsIT single events)

default: `` ''

IBIS_SP_E_band_max_s string List of upper limits of output energy bands (PICsIT single events)

default: `` ''

IBIS_SP_E_band_min_m string List of lower limits of output energy bands (PICsIT multiple events)

default: `` ''

IBIS_SP_E_band_max_m string List of upper limits of output energy bands (PICsIT multiple events)

default: `` ''

IBIS_SPS_ChanNum integer Number of Channels for PICsIT

possible values: -1 - 256

default: -1

IBIS_SPS_E_band_min_s string List of lower limits of output energy bands for SINGLE PICsIT events

default: `` ''

IBIS_SPS_E_band_max_s string List of upper limits of output energy bands for SINGLE PICsIT events

default: `` ''

IBIS_SPS_E_band_min_m string List of lower limits of output energy bands for multiple PICsIT events

default: `` ''

IBIS_SPS_E_band_max_m string List of upper limits of output energy bands for multiple PICsIT events

default: `` ''

SCW2_ISPE_idx_isgrResp string DOL of the index of ISGRI response matrices

default: ``''

SCW2_ISPE_isgrarf string DOL of the ARFs for XSPEC

default: ``''

SCW2_ISPE_DataMode integer Data Simulation mode

default: 0

SCW2_ISPE_MethodInt integer Method to be applied for the pixel value interpolation

default: 1

SCW2_ISPE_MethodFit integer Method to be applied for background and source intensity fitting

default: 6

SCW2_ISPE_isgrUnifDol string DOL of the ISGRI detector uniformity

default: ``''

SCW2_BIN_cleanTrk integer Cleaning of cosmic-ray induced events.

possible values:

0 = No

1 = Yes

default: 0

SCW2_BIN_I_idxNoisy string DOL of the index of noisy maps.

default: ``''

SCW2_BIN_I_idxLowThre string index of Low Threshold

default: ``''

SCW2_BIN_P_inDead string DOL of the dead time data structure.

default: ``''

SCW2_BIN_P_inGTI string DOL of the good time interval data structure.

default: ``''

SCW2_BIN_P_PicsCxt string DOL of the PICsIT Context Tables.

default: `` ''

SCW2_BIN_P_HepiLut string DOL of the hepi lut

default: ``''

SCW2_BKG_I_isgrBkgDol string DOL of the isgri bckg model or - if you want none or empty if you want DOL automatic from the IC tree

default: ``''

SCW2_BKG_divide boolean Divide by efficiency

default: no

SCW2_BKG_badpix boolean Remove bad pixels

default: yes

SCW2_BKG_flatmodule boolean flatten modules

default: no

SCW2_BKG_I_method_cor string Method to be applied for background removal

possible values:

0 - background from IC tree is applied to the whole detector

1 - parameter switches to this value automatically when background map is specified (not an IC one)

2 - background is threaded for each module separately

When using 1 or 2, brPif and brPifThreshold parameters are taken into account.

default: ``2''

SCW2_BKG_I_method_int string Method to be applied for the pixel value interpolation

possible values:

0 - pixels in dead zones are filled with zeros

1 - pixels are filled with mean detector value

default: ``1''

SCW2_BKG_P_method integer Method applied in filling gaps

possible values: 0 - 2

default: 1

SCW2_BKG_picsSUnifDOL string DOL of the PICsIT Detector Uniformity model (single).

default: ``''

SCW2_BKG_picsSBkgDOL string DOL of the PICsIT Detector Background model (single).

default: ``-''

SCW2_BKG_picsMUnifDOL string DOL of the PICsIT Detector Uniformity model (multiple).

default: ``''

SCW2_BKG_picsMBkgDOL string DOL of the PICsIT Detector Background model (multiple).

default: ``-''

Parameters for lightcurve extraction.
ILCR_select string Event selection condition

default: ``''

ILCR_delta_t real Time bin in seconds.

possible values: 0.1 - 10000

default: 100

ILCR_num_e integer Number of energy channels

possible values: 1 - 10

default: 4

ILCR_e_min string List of low energy boundaries

default: ``20 40 60 100''

ILCR_e_max string List of high energy boundaries

default: ``40 60 100 200''

Parameters for PICsIT mosaic extraction.
OBS2_detThr real Detection Threshold (in sigmas).

default: 3.0

OBS2_projSel string Selection of projection

default: STG

OBS2_imgSel string Selection criteria of images.

default: "EVT_TYPE=='SINGLE' && E_MIN==252 && E_MAX==336"


next up previous contents
Next: Bibliography Up: Data Analysis in Details Previous: Timing Analysis without the

2018-11-20