Skip to content

Overview

In the directory $CDMSBATSDIR/UserSettings/BatCalibSettings/processing, there are various files that begin with the prefix options and end with .Default. These are text files that tell BatCalib what processing configuration to run in. Most of the setting are fairly self explanatory. Examples of things you can control include which pulse analyzing algorithms are run (for example Optimal Filter and PulseIntegral). You can also turn the processing on and off for specific detectors or components of the experiment. For example, you can turn off calibration of all zips except zip17. Look in the file and follow the examples. It is fairly self explanatory and the format is flexible.

Glossary of Configuration Commands in BatCalib 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

CALIB - Calibration

Const - Constant

DET - Detector

F5 -

Freq - Frequency

MAX - Maximum

MIN - Minimum

OF - Optimal Filter

RQ - Reduced Quantity

RRQ - Refined Reduced Quantity

RTFT - Rise Time/Fall Time

SAT - Saturated

VT – Veto

Back to Top

Required in Alphabetical Order

These are a list of necessary parameters that must be used or defined in BatRoot processing files.

B

BATCALIB_RQDATA - Bats Calibration Reduced Quantity Data - [Path]. Specify a path to input data.

  • BatCalib: Processing
    • Required

BATCALIB_RRQDATA - Bats Calibration Refined Reduced Quantity Data - [Path]. Specify a path to output data.

  • BatCalib: Processing
    • Required

Back to Top

D

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_ALGORITHM - [Type]. True (1) or False (0).

DO_PROCESSING - [Type]. True (1) or False (0).

Back to Top

E

EVENTTIME - [Do Processing]. Process using event time.

  • Batcalib: Processing
    • Required

Back to Top

F

FILEINDEX_PREFIX - [PREFIX]. Specify a prefix for file index. Fxxxx for normal data, Vxxxx for veto pulsar

  • BatCalib: Processing
    • Required

Back to Top

M

MAX_EVENTS - [Integer]. Give a maximum number of events to process.

  • BatCalib: Processing
    • Required

MAX_TOWERS - [Integer]. Total number of towers.

  • BatCalib: Processing
    • Required

MAX_VTPANELS - [Integer]. Total number of veto panels.

  • BatCalib: 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.

  • BatCalib: Processing
    • Required

Back to Top

P

PARAMETER_INTEGER - [Type]

PATH - [Type]

PREFIX - [Type]

Back to Top

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

C

CalcConstFreqRTFTWalkRRQ - Calculate Constant Frequency RTFT Walk Refined Reduced Quantity - [Do Algorithm]

  • BatCalib: Processing
    • Soudan: ITHybrid, DQ, R132
    • UMN: Default

CalcF5SatEnergy - Calculate F5 Saturation Energy - [Do Algorithm]. If this is off, then saturated charge pulses have -999999 for ionization energy.

  • BatCalib: Processing
    • Soudan: CDMSIIDefault c58, , R125, R126, R127, R128
    • UMN: Default

CalcVarFreqRTFTWalkRRQ - Calculate Variable Frequency RTFT Walk Refined Reduced Quantity - [Do Algorithm]

  • BatCalib: Processing
    • Soudan: ITHybrid, DQ, R132
    • UMN: Default

CalibrateOFRes - Calibrate Optimal Filter Resolution - [Do Algorithm]

  • BatCalib: Processing
    • Soudan: CDMSIIDefault ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128 R132
    • UMN: Default

Back to Top

D

DefaultToConstFreqRTFTWalk - Default to Constant Frequency RTFT Walk - [Do Algorithm]. Use CFRTFTWalk values for xdel/ydel values and in choosing primary channels.

  • BatCalib: Processing
    • UMN: Default

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.

  • BatCalib: Processing
    • Soudan: SuperCDMS, CDMSIIDefault, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132
    • UMN: Default

Back to Top

O

OVERRIDE_BIAS_WCONFIG - Override Bias W Configuration - [Integer]. Override the bias values in the Reduced Quantity files with those in the config file - largely for TF and MC use and hopefully temporary! True (1) or False(0). - BatCalib: Processing - Midas: Default - Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132 - UMN: Default

Back to Top

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".

  • BatCalib: Processing
    • Midas: Default
    • Soudan: SuperCDMS, ITHybrid, STHybrid, c58, DQ, R132, R133, R134, R135
    • UMN: Default

Back to Top

RRQ_DATA_PREFIX - Refined Reduced Quantity Data Prefix - [Prefix]. Specify a prefix for output data. Example: File "myfile_170319_1616_F0002.root" has prefix "myfile".

  • BatCalib: Processing
    • Midas: Default
    • Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

Back to Top

T

TRIGGER - [Do Processing]. See next entry as well. Won't be done unless EVENTTIME is on.

  • BatCalib: Processing
    • Midas: Default
    • Soudan: SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

Back to Top

U

USE_MERGED_RQ - Use Merged Reduced Quantity - [Integer]. Tell BatCalib whether to look for merged files. True (1) or False (0). If 1, substitute "merge" in place of the dump number when running.

  • BatCalib: Processing
    • Midas: Default
    • Soudan: c58
    • Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

Back to Top

W

WRITE_FILTER_INFO - [Integer]. Store analysis configuration parameters. True (1) or False (0).

  • BatCalib: Processing
    • Midas: Default
    • Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

WRITE_PROCESS_INFO - [Integer]. Store processing settings. True (1) or False (0).

  • BatCalib: Processing
    • MidaS: Default
    • Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

Back to Top

Z

ZipCalibration - [Do Algorithm]. Turn off if RQ's are absent.

  • BatCalib: Processing
    • Midas: Default
    • Soudan: CDMSIIDefault, SuperCDMS, ITHybrid, STHybrid, c58, DQ, R125, R126, R127, R128, R132, R133, R134, R135
    • UMN: Default

Back to Top

Not Defined

These are a list of parameters that do not have a definition yet but can be found in BatRoot Processing files.

T

CalcCFRTFTWalkRRQ?

CalcPipeFitRRQ?

CalcRTFTWalkRRQ?

CalcWedgeFitRRQ?

Back to Top

T

TotalPhonon?

Back to Top