Overview¶
another repository: cdmsbats_config.
Starting August 2022, the processing configuration files are found in a separate repository: cdmsbats_config. The filenames start with processing
and may end with Default
(you will also find config files for specific runs, facilities or both here). These files are used by cdmsbats to make analysis decisions. For e.g., these files have parameters that tell cdmsbats what kind of cuts to apply, what detectors and channels to process and what algorithms to apply. In addition, it also performs some administrative functions like determining file names for BatNoise and BatRoot outputs and pointing file locations. Look in the file and follow the examples. It is fairly self explanatory and the format is flexible.
Glossary of Configuration Commands in BatRoot Processing Terms¶
Layout¶
PARAMETER_NAME - Full name, replacing all shorthands - [Type]. Brief description, including units and valid inputs if applicable. Default: Value that all config files were set to, if applicable. Does not indicate that a value will be set automatically.
- Directory within
UserSettings
that files including the parameter can be found: Subdirectory- Where data was taken (middle of filename): Runs that include this parameter (end of filename).
- Alternatively, "Required" will be written if all config files in subdirectory must have the parameter to be run.
Shorthands¶
CHAN - Channel
Const - Constant
DET - Detector
F5 -
Freq - Frequency
MAX - Maximum
P - Phonon
PT - Phonon Temperature
RQ - Reduced Quantity
RTFT - Rise Time/Fall Time
VT - Veto
Required in Alphabetical Order¶
These are a list of necessary parameters that must be used or defined in BatRoot processing files.
D¶
DET_TYPE - [Integer]. 4: ZIPS. 5: Mercedes ZIPS. 6: ENDCAPS. 11: iZIPS. 21: CDMSlite. 700: iZIPS 710: 100mm HV. Why is iZIPS here twice? Check that values are correct.
- BatRoot: Processing
- Required
DETECTOR - [Target]. Specifies a detector or list of detectors, numbered from 1 to 30. Formats: DETECTOR #
, DETECTOR #-#
, or DETECTOR #,#
, or any combination thereof. Spaces between list items are optional. Example: DETECTOR 1-3, 5, 7-9, 12, 17-24
. Most commands will specify a set of detectors.
DO_PROCESSING - [Type]. True (1) or False (0).
F¶
FILEINDEX_PREFIX - [PREFIX]. Specify a prefix for file index. Fxxxx for normal data, Vxxxx for veto pulsar
- BatRoot: Processing
- Required
M¶
MAX_EVENTS - [Integer]. Give a maximum number of events to process.
- BatRoot: Processing
- Required
MAX_TOWERS - [Integer]. Total number of towers.
- BatRoot: Processing
- Required
MAX_VTPANELS - [Integer]. Total number of veto panels.
- BatRoot: Processing
- Required
MAX_ZIPS - [Integer]. This must be set at least to the highest detector number used, not just to the number of detectors. Example: If you select detectors 1,3,5, you will need to set MAX_ZIPS to 5, not to 3.
- BatRoot: Processing
- Required
P¶
PARAMETER_DOUBLE - [Type]
PARAMETER_INTEGER - [Type]
PARAMETER_STRING - [Type]
PATH - [Type]
W¶
WRITE_RQ - Write Reduced Quantity - [Type]. True (1) or False (0).
Not Required in Alphabetical Order¶
These are a list of not necessary parameters you may find in BatRoot Processing files. These are found in specific processing files but not all processing files
A¶
AUX_FILES - Auxilary Files - [Path]. Additional files necessary for processing. Relevant for Soudan, but nothing else thus far.
- BatRoot: Processing
- Midas: Triumf
O¶
OptimalFilterPhonon - [Do Phonon Algorithm]. See also below
- BatRoot: Processing
- Midas: Triumf
OptimalFilterPhonon - [Do Phonon Sides]. See also above
- BatRoot: Processing
- Midas: Triumf
OptimalFilterPhonon1X2 - [Do Phonon Algorithm]
- BatRoot: Processing
- Midas: Triumf
R¶
RQ_DATA_PREFIX - Reduced Quantity Data Prefix - [Prefix]. Specify a prefix for input data. Example: File "myfile_170319_1616_F0002.root" has prefix "myfile".
- Batroot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVeV: Default
- Midas: Default
- MIT: Default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R130, R132, R133, R134, R135
- UCB: Default
- UF: Default
- UMN: Defualt, NoConvert, G42, G101, HV100mm, iZIP100mm
T¶
TRIGGER - [Do Processing]. See next entry as well. Won't be done unless EVENTTIME is on.
- BatRoot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVeV: Default
- Midas: Default
- MIT: Default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R132, R133, R134, R135
- UCB: Default
- UF: Default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
TRIGGER - [Write RQ]. See previous entry as well.
- BatRoot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVev: Default
- Midas: Default
- MIT: default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R132, R133, R134, R135
- UCB: Default
- UF: Default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
V¶
VETO - [Do Processing]. See also next entry. Needs the trigger processing.
- BatRoot: Processing
- HveV: Default
- Midas: Default
- MIT: Default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R132, R133, R134, R135
- UCB: Default
- UF: Default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
VETO - [Write RQ]. See also previous entry.
- BatRoot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVeV: Default
- Midas: Default
- MIT: default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R132, R133, R134, R135
- UCB: Default
- UF: default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
W¶
WRITE_PROCESS_INFO - [Integer]. Store processing settings. True (1) or False (0).
- BatRoot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVeV: Default
- Midas: Default
- MIT: Default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, SuperCDMS, Pulser, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R132, R134,R135
- UCB: Default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
WRITE_FILTER_INFO - [Integer]. Store analysis configuration parameters. True (1) or False (0).
- Batroot: Processing
- CUTE: iZIP
- DMC: Default, iZIPDefault, G101
- HVeV: Default
- Midas: Default
- MIT: Default
- PD2: Default
- Queens: Default, iZIP
- SLAC: iZIP100mm
- Soudan: Default, ITHybrid, STHybrid, DQ, R123, R125, R126, R127, R128, R130, R133, R134 - UCB: Default
- UF: Default
- UMN: Default, NoConvert, G42, G101, HV100mm, iZIP100mm
Not Defined¶
These are a list of parameters that do not have a definition yet but can be found in BatRoot Processing files.
C¶
CALC_CHARGE_TEMPLATE?
CALC_PHONON_TEMPLATE?
ChargeNoiseCovariance- [Algorithm]?
ConstFreqRTFTWalkPhonon- [Algorithm]?
D¶
DATABASE?
DATABASE_HOST?
DATABASE_NAME?
DATABASE_PASSWD?
DATABASE_USER?
DEBUG?
DET_STATUS_FILE?
DMM_FILE?
DO_CHARGE_ALGORITHM?
DO_CHARGESIM?
DO_PCHANSIM?
DO_PHONON_ALGORITHM?
DO_PHONON_SIDES?
DO_PHONON_TOT?
DO_PHONONSIM?
DO_PROCESSING_CHANNELS?
DO_PSIDESSIM?
DO_PTSIM?
DO_SIM_FROM_PULSE?
DO_SIM_FROM_TEMPLATE?
F¶
F5ChargeX - [Algorithm]?
FILTER_FILE?
G¶
GPIB_FILE?
I¶
InflectionTime - [Algorithm]?
INFO_FILE?
ISR_FILE?
N¶
NOISE_FILES?
NOISE_PREFIX?
NOISEMONITOR?
NOISEMONITOR_CHANNELS?
NoiseSelector - [Algorithm]?
O¶
OptimalFilterCharge - [Algorithm]?
OptimalFilterCharge2X2 - [Algorithm]?
OptimalFilterPhononGlitch1 - [Algorithm]?
OptimalFilterPhononLFnoise1 - [Algorithm]?
OptimalFilterPhononNS - [Algorithm]?
P¶
PipeFitPhonon - [Algorithm]?
PulseIntegral - [Algorithm]?
PSDIntegralPhonon - [Algorithm]?
R¶
RAW_DATA?
T¶
TailFitPhonon - [Algorithm]?
V¶
VarFreqRTFTWalkPhonon - [Algorithm]?
W¶
WedgeFitPhonon - [Algorithm]?
WRITE_SETTINGS_INFO?
WRITE_DETCONFIG_INFO?
WRITE_NOISE_PULSES?