4 # -----------------------------------------------------------------------------------------------------
6 # Toolkit for the determination of the fixed parameters in the system, a.k.a. "pre-calibration".
7 # The list of parameters includes (x,y,z) positions of strings and tripods, stretching of strings,
8 # z-positions of the optical modules, orientations of the strings and possibly z-positions of anchors.
10 # The value of a given parameter is optimised by minimising the average chi2/NDF
11 # of a series of global fits applied to a predefined set of acoustic events.
12 # For each parameter, there exists a designated function.
14 # There are also steering functions to consistently determine the optimal values for a set of parameters.
15 # In these, the current accuracy of the parameter values is taken into account.
16 # These are therefore referred to as "stages".
17 # The pre-calibration thus consists of a sequence of stages.
18 # For each detector, a complete pre-calibration procedure is implemented in a designated script.
20 # Mandatory input variables:
22 # DETECTOR # detector file
23 # INPUT_FILES # list of input files (output of JAcousticsEventBuilder[.sh])
25 # Optional input variables:
27 # HYDROPHONE # if defined, use hydrophones in global fit; else do not use hydrophones
31 # STRINGS corresponds to list of strings to be fitted; this can be changed with function fixStrings.
32 # TRIPODS corresponds to list of tripods to be fitted; this can be changed with function fixTripods.
34 # TRANSMITTERS corresponds to list of strings which have an emitter on the anchor (maybe empty).
35 # For these strings, the orientations and the z-positions of the anchors will separately be fitted.
36 # This list will also be changed with function fixStrings.
37 # -----------------------------------------------------------------------------------------------------
39 source $JPP_DIR/setenv.sh $JPP_DIR >& /dev/
null
40 source $JPP_BIN/gradient.sh
44 set_variable: JOBS ACOUSTICS_JOBS 0 # number of parallel threads
47 usage "Toolkit for pre-calibrations of detectors."\
48 "\nThis script should be sourced by the steering script for a specific detector."\
49 "\nConsult the script '$0' for more details."
53 echo "This script should be sourced by the steering script for a specific detector."
57 if [[ `ps -
o stat= -p $$` == *
"+" ]];
then
58 echo "This script cannot interactively be used."
62 source JAcousticsToolkit.sh
65 typeset -
a CHI2 #
chi2 values; index [1] corresponds to best value
67 let
"NUMBER_OF_ITERATIONS = 100" # maximal number of iterations
68 let
"EPSILON = 5.0E-4" # maximal
distance to minimum of
chi2
69 let
"RADIUS_M = 1.0" # maximal horizontal
distance between
T-bar and emitter/hydrophone
70 let
"PRECISION = 10" # number of decimals of
chi2 evaluation
73 # -----------------------------------------------------------------------------------------------------
76 # Install input files in working directory and create temporary directory TMPDIR.
78 # -----------------------------------------------------------------------------------------------------
81 eval `JPrintDetector -
a $DETECTOR -O IDENTIFIER`
85 JAcoustics.sh $DETECTOR_ID
87 get_tripods tripod.txt TRIPODS
89 TRANSMITTERS=(`get_strings_with_transmitter transmitter.txt`)
91 if [[
"${HYDROPHONE+YES}" ==
"YES" ]];
then
92 HYDROPHONES=(`get_strings_with_hydrophone hydrophone.txt`)
104 # -----------------------------------------------------------------------------------------------------
105 # Backup files in given directory.
108 # -----------------------------------------------------------------------------------------------------
113 cp -p {tripod.txt,transmitter.txt,hydrophone.txt} $1
119 # -----------------------------------------------------------------------------------------------------
120 # Remove temporary directory and restore input files in working directory.
122 # -----------------------------------------------------------------------------------------------------
127 rm -rf $TMPDIR >& /dev/
null
129 rm -
f {acoustics_fit_parameters,acoustics_trigger_parameters}.txt
131 JAcoustics.sh $DETECTOR_ID
135 # -----------------------------------------------------------------------------------------------------
138 # \param 1-N identifiers
139 # -----------------------------------------------------------------------------------------------------
140 function fixStrings()
146 if (( ${#BUFFER} > 0 ));
then
148 TRANSMITTERS=(${TRANSMITTERS:|BUFFER})
149 HYDROPHONES=(${HYDROPHONES:|BUFFER})
154 # -----------------------------------------------------------------------------------------------------
157 # \param 1-
N identifiers
158 # -----------------------------------------------------------------------------------------------------
159 function fixTripods()
165 if (( ${#BUFFER} > 0 ));
then
166 for ID in $BUFFER[*];
do
167 unset
"TRIPODS[${ID}]"
173 # -----------------------------------------------------------------------------------------------------
174 # Evaluate current chi2.
176 # \param 1 variable containing chi2 value on return
178 # -----------------------------------------------------------------------------------------------------
181 if (( $JOBS == 0 ));
then
183 rm -
f $TMPDIR/katoomba.root >& /dev/
null
187 -
f "$INPUT_FILES[*]" \
188 -
o $TMPDIR/katoomba.root \
191 -
V sound_velocity.txt \
193 -@ $TMPDIR/acoustics_fit_parameters.txt \
197 -
d 0 >& $TMPDIR/job.log
199 if (( $? != 0 ));
then
200 fatal
"non-zero exit code, see $TMPDIR/job.log"
203 set_variable RESULT $($JPP_DIR/examples/JAcoustics/JPrintChi2 -
f $TMPDIR/katoomba.root -p $PRECISION)
207 if (( $2 == 0 ));
then
209 # step wise improvement of the chi2
213 -
f "$INPUT_FILES[*]" \
216 -
V sound_velocity.txt \
218 -@ $TMPDIR/acoustics_fit_parameters.txt \
223 -
d 0 3>&1 1>&4 } |
read RESULT } 4>&1 >& $TMPDIR/job.log
227 # evaluation of the chi2 before the determination of the gradient of the chi2
229 rm -
f $TMPDIR/katoomba.root >& /dev/
null
233 -
f "$INPUT_FILES[*]" \
234 -
o $TMPDIR/katoomba.root \
237 -
V sound_velocity.txt \
239 -@ $TMPDIR/acoustics_fit_parameters.txt \
244 -
d 0 3>&1 1>&4 } |
read RESULT } 4>&1 >& $TMPDIR/job.log
248 # evaluation of the derivative of the chi2 to each fit parameter
252 -
f $TMPDIR/katoomba.root \
255 -
V sound_velocity.txt \
257 -@ $TMPDIR/acoustics_fit_parameters.txt \
260 -
d 0 3>&1 1>&4 } |
read RESULT } 4>&1 >& $TMPDIR/job.log
264 fatal
"invalid option <$2>"
267 if (( $? != 0 ));
then
268 fatal
"non-zero exit code, see $TMPDIR/job.log"
274 if (( $? != 0 ));
then
275 fatal
"non-zero exit code let, value <${RESULT}>."
282 # -----------------------------------------------------------------------------------------------------
284 # This stage can be used to determine the (x,y,z) positions of tripods using strings that are fixed.
286 # \param 1 fit option
287 # \param 2 M-estimator
288 # \param 3 resolution [s]
289 # \param 4 standard deviations
290 # \param 5 step size [m]
291 # \param 6 maximum number of extra steps
292 # -----------------------------------------------------------------------------------------------------
295 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
296 `egrep Tmax_s acoustics_fit_parameters.txt`
304 if (( ${#STRINGS} > 0 ));
then
305 JEditDetector -
a $DETECTOR -
o $TMPDIR/detector_0.datx -
k "$STRINGS[*]" -q -
d 0 >& /dev/
null
311 for ID in ${(
k)TRIPODS};
do
312 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addx %" -o tripod.txt -q -d 0 >& /dev/null']=$5
313 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addy %" -o tripod.txt -q -d 0 >& /dev/null']=$5
314 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addz %" -o tripod.txt -q -d 0 >& /dev/null']=$5
319 printf
"detector %6d %8.4f\n" $N $Y
321 if (( ${#STRINGS} > 0 ));
then
327 # -----------------------------------------------------------------------------------------------------
329 # This stage can be used to determine the positions of the strings and tripods.
331 # \param 1 fit option
332 # \param 2 M-estimator
333 # \param 3 resolution [s]
334 # \param 4 standard deviations
335 # \param 5 step size strings [m]
336 # \param 6 step size tripods [m]
337 # \param 7 maximum number of extra steps
338 # -----------------------------------------------------------------------------------------------------
341 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
342 `egrep Tmax_s acoustics_fit_parameters.txt`
353 PARAMETERS[
'JEditDetector -a $DETECTOR -S "$STRING addx %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
354 PARAMETERS[
'JEditDetector -a $DETECTOR -S "$STRING addy %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
355 PARAMETERS[
'JEditDetector -a $DETECTOR -s "$STRING addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
358 for ID in ${(
k)TRIPODS};
do
359 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addx %" -o tripod.txt -q -d 0 >& /dev/null']=$6
360 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addy %" -o tripod.txt -q -d 0 >& /dev/null']=$6
361 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addz %" -o tripod.txt -q -d 0 >& /dev/null']=$6
364 for STRING in ${HYDROPHONES:|TRANSMITTERS};
do
365 PARAMETERS[
'JEditHydrophone -f hydrophone.txt -S "$STRING rot %" -o hydrophone.txt -q -d 0 >& /dev/null; JEditTransmitter -f transmitter.txt -S "$STRING rot %" -o transmitter.txt -q -d 0 >& /dev/null']=$(($5 / $RADIUS_M))
372 PARAMETERS[
'JEditDetector -a $DETECTOR -M "$MODULE addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
373 PARAMETERS[
'JEditHydrophone -f hydrophone.txt -S "$STRING rot %" -o hydrophone.txt -q -d 0 >& /dev/null; JEditTransmitter -f transmitter.txt -S "$STRING rot %" -o transmitter.txt -q -d 0 >& /dev/null']=$(($5 / $RADIUS_M))
378 printf
"detector %6d %8.4f\n" $N $Y
382 # -----------------------------------------------------------------------------------------------------
384 # This stage can be used to determine the stretching and z-positions of individual strings.
386 # \param 1 fit option
387 # \param 2 M-estimator
388 # \param 3 resolution [s]
389 # \param 4 standard deviations
390 # \param 5 step size stretching [unit]
391 # \param 6 step size z-position [m]
392 # \param 7 maximum number of extra steps
393 # -----------------------------------------------------------------------------------------------------
396 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
397 `egrep Tmax_s acoustics_fit_parameters.txt`
407 JEditDetector -
a $DETECTOR -
o $TMPDIR/detector_1.datx -
r "$STRING" -q -
d 0 >& /dev/
null
412 PARAMETERS[
'JEditDetector -a $DETECTOR -s "$STRING mul %" -o $DETECTOR -q -d 0 >& /dev/null; JEditDetector -a $DETECTOR -s "$STRING subz \$\(\(% * $CAN_ZMAX_M\)\)" -o $DETECTOR -q -d 0 >& /dev/null']=$5
413 PARAMETERS[
'JEditDetector -a $DETECTOR -s "$STRING addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$6
417 printf
"string %04d %6d %8.4f\n" $STRING $N $Y
424 # -----------------------------------------------------------------------------------------------------
426 # This stage can be used to determine the z-positions of the modules.
428 # \param 1 fit option
429 # \param 2 M-estimator
430 # \param 3 resolution [s]
431 # \param 4 standard deviations
432 # \param 5 step size [m]
433 # \param 6 maximum number of extra steps
434 # -----------------------------------------------------------------------------------------------------
437 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
438 `egrep Tmax_s acoustics_fit_parameters.txt`
450 for (( FLOOR = 1; $FLOOR <= 18; FLOOR += 1 ));
do
454 PARAMETERS[
'JEditDetector -a $DETECTOR -M "$MODULE addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
460 printf
"detector %6d %8.4f\n" $N $Y
464 # -----------------------------------------------------------------------------------------------------
466 # This stage can be used to determine the z-positions of the anchors
468 # \param 1 fit option
469 # \param 2 M-estimator
470 # \param 3 resolution [s]
471 # \param 4 standard deviations
472 # \param 5 step size [m]
473 # \param 6 maximum number of extra steps
474 # -----------------------------------------------------------------------------------------------------
477 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
478 `egrep Tmax_s acoustics_fit_parameters.txt`
492 PARAMETERS[
'JEditDetector -a $DETECTOR -M "$MODULE addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
497 printf
"detector %6d %8.4f\n" $N $Y
501 # -----------------------------------------------------------------------------------------------------
503 # This stage can be used to determine the rotations of the strings and z-positions of the anchors
504 # including the response of hydrophones.
505 # It includes a determination of the positions of the strings and tripods.
507 # \param 1 fit option
508 # \param 2 M-estimator
509 # \param 3 resolution [s]
510 # \param 4 standard deviations
511 # \param 5 step size strings [m]
512 # \param 6 step size tripods [m]
513 # \param 7 maximum number of extra steps
514 # -----------------------------------------------------------------------------------------------------
517 cat>$TMPDIR/acoustics_fit_parameters.txt<<EOF
518 `egrep Tmax_s acoustics_fit_parameters.txt`
534 PARAMETERS[
'JEditDetector -a $DETECTOR -S "$STRING addx %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
535 PARAMETERS[
'JEditDetector -a $DETECTOR -S "$STRING addy %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
536 PARAMETERS[
'JEditDetector -a $DETECTOR -s "$STRING addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
537 PARAMETERS[
'JEditDetector -a $DETECTOR -M "$MODULE addz %" -o $DETECTOR -q -d 0 >& /dev/null']=$5
539 PARAMETERS[
'JEditHydrophone -f hydrophone.txt -S "$STRING rot %" -o hydrophone.txt -q -d 0 >& /dev/null; JEditTransmitter -f transmitter.txt -S "$STRING rot %" -o transmitter.txt -q -d 0 >& /dev/null']=$(($5 / $RADIUS_M))
542 for ID in ${(
k)TRIPODS};
do
543 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addx %" -o tripod.txt -q -d 0 >& /dev/null']=$6
544 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addy %" -o tripod.txt -q -d 0 >& /dev/null']=$6
545 PARAMETERS[
'JEditTripod -f tripod.txt -T "$ID addz %" -o tripod.txt -q -d 0 >& /dev/null']=$6
550 printf
"detector %6d %8.4f\n" $N $Y
then fatal No hydrophone data file $HYDROPHONE_TXT fi sort gr k
std::istream & read(std::istream &in, JTestSummary &summary, const char delimiter= ' ')
Read test summary.
then usage $script[< detector identifier >< run range >]< QA/QCfile > nExample script to produce data quality plots nWhen a detector identifier and run range are data are downloaded from the database nand subsequently stored in the given QA QC file
clean eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY set_variable STRING
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
then JLigier sh continue fi cat
o $QUALITY_ROOT d $DEBUG!CHECK_EXIT_CODE JPlot1D f
usr share Modules init zsh export TMPDIR
static const double H
Planck constant [eV s].
then fatal Wrong number of arguments fi set_variable STRING $argv[1] set_variable DETECTORXY_TXT $WORKDIR $DETECTORXY_TXT tail read X Y CHI2 RMS printf optimum n $X $Y $CHI2 $RMS awk v Y
V(JDAQEvent-JTriggerReprocessor)*1.0/(JDAQEvent+1.0e-10)
then fatal Wrong number of arguments fi JConvertDetectorFormat a o
do JCanberra a $DETECTOR f $INPUT_FILE o $WORKDIR canberra[${EMITTER}\] root T $WORKDIR tripod txt V $WORKDIR sound_velocity txt M $WORKDIR mechanics txt H $WORKDIR hydrophone txt E $EMITTER $DISABLE d $DEBUG!done kill_child_processes_at_exit attach getModule a $DETECTOR typeset Z STRING typeset Z FLOOR for STRING in $STRINGS[*]
then fatal Invalid string $STRING
then echo Variable JPP_DIR undefined exit fi source $JPP_DIR setenv sh $JPP_DIR &dev null set_variable
case $OPTION in clean clean
do set_variable OUTPUT_DIRECTORY $WORKDIR T
skip elif((BINFRAC< 1.0))
set_array INPUT_FILES argv[2,$((START_INDEX_STRING-1))] set_array STRINGS
then $DIR JKatoomba a $DETECTOR o $WORKDIR katoomba root T $TRIPOD n sigma_s
then usage $script< input file >[option[primary[working directory]]] nWhere option can be N
then JMuonMCEvt f $INPUT_FILE o $INTERMEDIATE_FILE d
then set_variable MODULE getModule a $DETECTOR L $STRING $FLOOR JEditDetector a $DETECTOR M $MODULE add $X o $DETECTOR else echo No update of detector $DETECTOR
static const JPBS_t HYDROPHONE(4, 5)
PBS of hydrophone
then if[[!-f $DETECTOR]] then JDetector sh $DETECTOR fi cat $WORKDIR trigger_parameters txt<< EOFtrigger3DMuon.enabled=1;trigger3DMuon.numberOfHits=5;trigger3DMuon.gridAngle_deg=1;ctMin=0.0;TMaxLocal_ns=15.0;EOF set_variable TRIGGEREFFICIENCY_TRIGGERED_EVENTS_ONLY INPUT_FILES=() for((i=1;$i<=$NUMBER_OF_RUNS;++i));do JSirene.sh $DETECTOR $JPP_DATA/genhen.km3net_wpd_V2_0.evt.gz $WORKDIR/sirene_ ${i}.root JTriggerEfficiency.sh $DETECTOR $DETECTOR $WORKDIR/sirene_ ${i}.root $WORKDIR/trigger_efficiency_ ${i}.root $WORKDIR/trigger_parameters.txt $JPP_DATA/PMT_parameters.txt INPUT_FILES+=($WORKDIR/trigger_efficiency_ ${i}.root) done for ANGLE_DEG in $ANGLES_DEG[*];do set_variable SIGMA_NS 3.0 set_variable OUTLIERS 3 set_variable OUTPUT_FILE $WORKDIR/matrix\[${ANGLE_DEG}\deg\].root $JPP_DIR/examples/JReconstruction-f"$INPUT_FILES[*]"-o $OUTPUT_FILE-S ${SIGMA_NS}-A ${ANGLE_DEG}-O ${OUTLIERS}-d ${DEBUG}--!fiif[[$OPTION=="plot"]];then if((0));then for H1 in h0 h1;do JPlot1D-f"$WORKDIR/matrix["${^ANGLES_DEG}" deg].root:${H1}"-y"1 2e3"-Y-L TR-T""-\^"number of events [a.u.]"-> o chi2
then echo Creating output directory
do set_variable DETECTOR_TXT $WORKDIR detector
static JNullStream null
Null I/O stream.
double getChi2(const double P)
Get chi2 corresponding to given probability.
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
source $JPP_DIR setenv csh $JPP_DIR &dev null eval JShellParser o a A
const JModule & getModule(const JDetector &detector, const JModuleLocation &location)
find module with a given string and floor number
#define DEBUG(A)
Message macros.