Jpp  16.0.0-rc.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Functions
JEditDetector.cc File Reference

Auxiliary program to modify detector calibration. More...

#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include <map>
#include <algorithm>
#include "TRandom3.h"
#include "JDetector/JDetector.hh"
#include "JDetector/JDetectorToolkit.hh"
#include "JDetector/JDetectorHeader.hh"
#include "JDetector/JModuleStatus.hh"
#include "JDetector/JModuleRouter.hh"
#include "JDetector/JPMTIdentifier.hh"
#include "JDetector/JPMTPhysicalAddress.hh"
#include "JDetector/JPMTStatus.hh"
#include "JDetector/JModuleAddressMap.hh"
#include "JDetector/JDetectorAddressMap.hh"
#include "JDetector/JDetectorAddressMapToolkit.hh"
#include "JGeometry3D/JVector3D.hh"
#include "JMath/JConstants.hh"
#include "JMath/JMath.hh"
#include "JTools/JRange.hh"
#include "JLang/JException.hh"
#include "JLang/JToken.hh"
#include "JLang/JComparator.hh"
#include "JLang/JComparison.hh"
#include "JSupport/JMeta.hh"
#include "Jeep/JeepToolkit.hh"
#include "Jeep/JPrint.hh"
#include "Jeep/JParser.hh"
#include "Jeep/JMessage.hh"

Go to the source code of this file.

Functions

int main (int argc, char **argv)
 

Detailed Description

Auxiliary program to modify detector calibration.

Syntax: 

    -M     "<module identifier>     (set|add|sub|randset|randadd|randsub) x0 [x1 x2]"
    -(S|s) "<string number>         (set|add|sub|randset|randadd|randsub) x0 [x1 x2]"
    -M     "<module identifier>     (setx|sety|setz) value"
    -(S|s) "<string number>         (setx|sety|setz) value"
    -M     "<module identifier>     (rot|randrot) phi"
    -(S|s) "<string number>         (rot|randrot) phi"
    -M     "<module identifier>     (mul|randmul) factor"
    -(S|s) "<string number>         (mul|randmul) factor"
    -M     "<module identifier>     (div|randdiv) factor"
    -(S|s) "<string number>         (div|randdiv) factor"
    -M     "<module identifier>     (reset)"
    -(S|s) "<string number>         (reset)"
    -M     "<module identifier>     (assign)  identifier"
    -M     "<module identifier>     (locate)  <string> <floor>"
    -M     "<module identifier>     (swap)    <PMT>    <PMT>"
    -M     "<module identifier>     (SET|ADD|SUB|) x0 [x1 x2 x3]"
    -(S|s) "<string number>         (SET|ADD|SUB|) x0 [x1 x2 x3]"
    -M     "<module identifier>     (ROT) phi"
    -(S|s) "<string number>         (ROT) phi"
    -(S|s) "<string number>         (tilt|randtilt) Tx Ty"
    -W     "<module identifier>     (set|reset)  (MODULE_DISABLE|COMPASS_DISABLE|HYDROPHONE_DISABLE|PIEZO_DISABLE|MODULE_OUT_OF_SYNC)"
    -P     "<PMT identifier>        (set|reset)  (PMT_DISABLE|HIGH_RATE_VETO_DISABLE|FIFO_FULL_DISABLE|UDP_COUNTER_DISABLE|UDP_TRAILER_DISABLE|OUT_OF_SYNC)"
    -p     "<PMT physical address>  (set|reset)  (PMT_DISABLE|HIGH_RATE_VETO_DISABLE|FIFO_FULL_DISABLE|UDP_COUNTER_DISABLE|UDP_TRAILER_DISABLE|OUT_OF_SYNC)"
    -k     "<string number>[-<string number>]"
    -r     "<string number>[-<string number>]"
    -m     "<module identifier>"
    -D     "<string number> <floor>"
    -@    "<key>=<value>[;<key>=<value>"

Options -M and -S refer to a module and a string, respectively.
The values provided for a string modification coherently apply to the modules of the specified string number.
The option -s is equivalent to option -S except that the action applies only to the optical modules in the string and not the base module.

The options randxxx correspond to a randomisation of the specified option.

If the module identifier or string number is -1, the action is applied to all modules or strings in the detector, respectively.

For options [rand]set, [rand]add and [rand]sub, the number of values apply to position or time calibration in the following way:

  1. time calibration (t = x0)
  2. invalid
  3. position calibration (x = x0, y = x1, z = x2)

For options [rand]rot, the angle phi refers to an anti-clockwise rotation around the z-axis.
The rotation angle is defined in radians.

For options [rand]mul and [rand]div, the multiplication/division factor (a.k.a. "stretching") applies to the z-coordinates of the modules.
The factor is defined as a fraction; the actual multiplication/division factor is (1 + factor).

For options SET, ADD and SUB, the number of values apply to time or quaternion calibration of the module in the following way:

  1. time calibration of piezo sensor or hydrophone (t = x0)
  2. invalid
  3. invalid
  4. quaternion calibration of compass (qa = x0, qb = x1, qc = x2, qd = x3)

For options ROT, the angle phi refers to an anti-clockwise rotation around the z-axis of the quaternion calibration of the compass.
The rotation angle is defined in radians.

If no values are given at the option SET,

In this, the time calibration is corrected for the delay time of the piezo sensor and hydrophone
which are defined by JDETECTOR::PIEZO_DELAYTIME_US and JDETECTOR::HYDROPHONE_DELAYTIME_US, respectively.
The units of all positions and time values are m and ns, respectively.

Note that for string modifiers with option randxxx, the action is coherently applied to the modules in the specified string.
Only one type of action (defined by xxx and the number of values) is then allowed per string.

Option -@ refers to the header information.
The list of possible keys can be obtained using JPrintDetector.cc with option -O header.

Multiple options -M, -S, -s or -@ will be processed in order of appearance.

Options -k and -r can be used to keep and remove (a range of) string numbers, respectively.

The options -m and -D can be used to maintain a specific module (and remove all others) and to delete a floor from a string, respectively.

Note finally that if the output file name is the same as the input file name, the original file will be overwritten.

Author
mdejong

Definition in file JEditDetector.cc.

Function Documentation

int main ( int  argc,
char **  argv 
)

Definition at line 869 of file JEditDetector.cc.

870 {
871  using namespace std;
872  using namespace JPP;
873 
874  typedef JToken<';'> JToken_t;
875 
876  string inputFile;
877  string outputFile;
878  vector<JToken_t> hdr;
879  vector< pair<int, JModifier> > mod;
880  vector< pair<int, JModifier> > str;
881  vector< pair<int, JModifier> > dos;
882  vector< pair<int,
883  JModuleModifier> > wip;
884  vector< pair<JPMTIdentifier,
885  JPMTModifier> > pmt;
886  vector< pair<JPMTPhysicalAddress,
887  JPMTModifier> > alt;
888  vector<JRange_t> keep;
889  vector<JRange_t> rm;
890  vector<int> id;
891  multimap<int, int> del;
892  int option;
893  int debug;
894 
895  try {
896 
897  JParser<> zap("Auxiliary program to modify detector.");
898 
899  zap['a'] = make_field(inputFile);
900  zap['o'] = make_field(outputFile);
901  zap['@'] = make_field(hdr, "header modification") = JPARSER::initialised();
902  zap['M'] = make_field(mod, "module modification") = JPARSER::initialised();
903  zap['S'] = make_field(str, "string modification (optical modules and base module") = JPARSER::initialised();
904  zap['s'] = make_field(dos, "string modification (optical modules only)") = JPARSER::initialised();
905  zap['W'] = make_field(wip, "module status modification") = JPARSER::initialised();
906  zap['P'] = make_field(pmt, "PMT status modification by PMT logical address") = JPARSER::initialised();
907  zap['p'] = make_field(alt, "PMT status modification by PMT physical address") = JPARSER::initialised();
908  zap['k'] = make_field(keep, "keep string[s]") = JPARSER::initialised();
909  zap['r'] = make_field(rm, "remove string[s]") = JPARSER::initialised();
910  zap['m'] = make_field(id, "remove module by identifier") = JPARSER::initialised();
911  zap['D'] = make_field(del, "remove module by location") = JPARSER::initialised();
912  zap['O'] = make_field(option, "sort modules") = 0, 1, 2;
913  zap['d'] = make_field(debug) = 2;
914 
915  zap(argc, argv);
916  }
917  catch(const exception &error) {
918  FATAL(error.what() << endl);
919  }
920 
921  JDetector detector;
922 
923  try {
924  load(inputFile, detector);
925  }
926  catch(const JException& error) {
927  FATAL(error);
928  }
929 
930 
931  gRandom->SetSeed(0);
932 
933 
934  if ((keep.empty() ? 0 : 1 +
935  rm .empty() ? 0 : 1 +
936  id .empty() ? 0 : 1) > 1) {
937  FATAL("Use either option -k, -r or -m." << endl);
938  }
939 
940 
941  detector.comment.add(JMeta(argc,argv));
942 
943  if (detector.setToLatestVersion()) {
944  NOTICE("Set detector version to " << detector.getVersion() << endl);
945  }
946 
947 
948  if (!hdr.empty()) {
949 
950  int id = -1;
951 
952  JProperties helper = detector.getProperties();
953 
954  helper["id"] = id;
955 
956  for (vector<JToken_t>::const_iterator i = hdr.begin(); i != hdr.end(); ++i) {
957 
958  istringstream is(*i);
959 
960  is >> helper;
961  }
962 
963  if (id != -1) {
964  detector.setID(id);
965  }
966  }
967 
968 
969  for (JDetector::iterator module = detector.begin(); module != detector.end(); ) {
970 
971  bool __rm__ = !keep.empty() && rm.empty();
972 
973  for (vector<JRange_t>::const_iterator i = keep.begin(); i != keep.end(); ++i) {
974  if (module->getString() >= i->first && module->getString() <= i->second) {
975  __rm__ = false;
976  }
977  }
978 
979  for (vector<JRange_t>::const_iterator i = rm.begin(); i != rm.end(); ++i) {
980  if (module->getString() >= i->first && module->getString() <= i->second) {
981  __rm__ = true;
982  }
983  }
984 
985  if (!id.empty()) {
986  __rm__ = find(id.begin(), id.end(), module->getID()) == id.end();
987  }
988 
989  const auto range = del.equal_range(module->getString());
990 
991  for (auto i = range.first; i != range.second; ++i) {
992  if (i->second == module->getFloor()) {
993  __rm__ = true;
994  }
995  }
996 
997  if (__rm__)
998  module = detector.erase(module);
999  else
1000  ++module;
1001  }
1002 
1003 
1004  for (vector< pair<int, JModifier> >::const_iterator i = mod.begin(); i != mod.end(); ++i) {
1005 
1006  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1007 
1008  if (module->getID() == i->first || i->first == WILDCARD ){
1009 
1010  if (debug >= debug_t) {
1011  print(cout, *module, i->second);
1012  }
1013 
1014  if (!i->second.apply(*module)) {
1015  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1016  }
1017  }
1018  }
1019  }
1020 
1021 
1022  for (vector< pair<int, JModifier> >::const_iterator i = str.begin(); i != str.end(); ++i) {
1023 
1024  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1025 
1026  if (module->getString() == i->first || i->first == WILDCARD) {
1027 
1028  const JModifier modifier = getModifier(module->getString(), i->second);
1029 
1030  if (debug >= debug_t) {
1031  print(cout, *module, i->second);
1032  }
1033 
1034  if (!modifier.apply(*module)) {
1035  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1036  }
1037  }
1038  }
1039  }
1040 
1041 
1042  for (vector< pair<int, JModifier> >::const_iterator i = dos.begin(); i != dos.end(); ++i) {
1043 
1044  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1045 
1046  if (module->getFloor() != 0) {
1047 
1048  if (module->getString() == i->first || i->first == WILDCARD) {
1049 
1050  const JModifier modifier = getModifier(module->getString(), i->second);
1051 
1052  if (debug >= debug_t) {
1053  print(cout, *module, i->second);
1054  }
1055 
1056  if (!modifier.apply(*module)) {
1057  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1058  }
1059  }
1060  }
1061  }
1062  }
1063 
1064 
1065  for (vector< pair<int, JModuleModifier> >::const_iterator i = wip.begin(); i != wip.end(); ++i) {
1066 
1067  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1068 
1069  if (module->getID() == i->first || i->first == WILDCARD ){
1070 
1071  if (debug >= debug_t) {
1072  print(cout, *module, i->second);
1073  }
1074 
1075  if (!i->second.apply(*module)) {
1076  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1077  }
1078  }
1079  }
1080  }
1081 
1082 
1083  for (vector< pair<JPMTIdentifier, JPMTModifier> >::const_iterator i = pmt.begin(); i != pmt.end(); ++i) {
1084 
1085  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1086 
1087  if (module->getID() == i->first.getModuleID() || i->first.getModuleID() == WILDCARD) {
1088 
1089  if (debug >= debug_t) {
1090  print(cout, i->first, i->second);
1091  }
1092 
1093  if (i->first.getPMTAddress() == WILDCARD) {
1094 
1095  for (int pmt = 0; pmt != getNumberOfPMTs(*module); ++pmt) {
1096  if (!i->second.apply(module->getPMT(pmt))) {
1097  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1098  }
1099  }
1100 
1101  } else if (i->first.getPMTAddress() < 0 ||
1102  i->first.getPMTAddress() >= getNumberOfPMTs(*module) ||
1103  !i->second.apply(module->getPMT(i->first.getPMTAddress()))) {
1104  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1105  }
1106  }
1107  }
1108  }
1109 
1110 
1111  if (!alt.empty()) {
1112 
1113  if (!hasDetectorAddressMap(detector.getID())) {
1114  FATAL("Invalid detector identifier " << detector.getID() << endl);
1115  }
1116 
1117  const JDetectorAddressMap& demo = getDetectorAddressMap(detector.getID());
1118 
1119  for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
1120 
1121  const JModuleAddressMap memo = demo.get(module->getID());
1122 
1123  for (vector< pair<JPMTPhysicalAddress, JPMTModifier> >::const_iterator i = alt.begin(); i != alt.end(); ++i) {
1124 
1125  const JPMTIdentifier id(module->getID(), memo.getAddressTranslator(i->first).tdc);
1126 
1127  if (debug >= debug_t) {
1128  print(cout, id, i->second);
1129  }
1130 
1131  if (!i->second.apply(module->getPMT(id.getPMTAddress()))) {
1132  ERROR("No valid action: " << i->first << ' ' << i->second << endl);
1133  }
1134  }
1135  }
1136  }
1137 
1138 
1139  switch (option) {
1140  case 1:
1141  sort(detector.begin(), detector.end(), make_comparator(&JModule::getID));
1142  break;
1143 
1144  case 2:
1145  sort(detector.begin(), detector.end(), make_comparator(&JModule::getLocation));
1146  break;
1147 
1148  default:
1149  break;
1150  };
1151 
1152 
1153  try {
1154  store(outputFile, detector);
1155  }
1156  catch(const JException& error) {
1157  FATAL(error);
1158  }
1159 }
JSUPPORT::JMeta
Auxiliary class for ROOT I/O of application specific meta data.
Definition: JMeta.hh:70
JPARSER::JParser
Utility class to parse command line options.
Definition: JParser.hh:1500
JLANG::JException
General exception.
Definition: JException.hh:23
JEEP::debug_t
debug
Definition: JMessage.hh:29
JLANG::make_comparator
JComparator< JResult_t T::*, JComparison::lt > make_comparator(JResult_t T::*member)
Helper method to create comparator between values of data member.
Definition: JComparator.hh:185
JDETECTOR::JDetector
Detector data structure.
Definition: JDetector.hh:89
JDETECTOR::hasDetectorAddressMap
bool hasDetectorAddressMap(const int id)
Check if detector address map is available.
Definition: JDetectorAddressMapToolkit.hh:500
JEEP::JProperties
Utility class to parse parameter values.
Definition: JProperties.hh:496
JDETECTOR::getNumberOfPMTs
int getNumberOfPMTs(const JModule &module)
Get number of PMTs.
Definition: JDetectorToolkit.hh:364
JDETECTOR::JDetectorAddressMap
Lookup table for PMT addresses in detector.
Definition: JDetectorAddressMap.hh:25
JPARSER::initialised
Empty structure for specification of parser element that is initialised (i.e. does not require input)...
Definition: JParser.hh:66
outputFile
string outputFile
Definition: JDAQTimesliceSelector.cc:37
is
is
Definition: JDAQCHSM.chsm:167
JDETECTOR::JDetectorAddressMap::get
const JModuleAddressMap & get(const int id) const
Get module address map.
Definition: JDetectorAddressMap.hh:69
JDETECTOR::JModuleAddressMap
Lookup table for PMT addresses in optical module.
Definition: JModuleAddressMap.hh:82
JAANET::detector
Detector file.
Definition: JHead.hh:224
make_field
#define make_field(A,...)
macro to convert parameter to JParserTemplateElement object
Definition: JParser.hh:1961
JDETECTOR::store
void store(const std::string &file_name, const JDetector &detector)
Store detector to output file.
Definition: JDetectorToolkit.hh:571
NOTICE
#define NOTICE(A)
Definition: JMessage.hh:64
ERROR
#define ERROR(A)
Definition: JMessage.hh:66
debug
int debug
debug level
Definition: JSirene.cc:63
JDETECTOR::getDetectorAddressMap
JDetectorAddressMap & getDetectorAddressMap()
Get detector address map.
Definition: JDetectorAddressMapToolkit.hh:364
print
print
Definition: JConvertDusj.sh:44
FATAL
#define FATAL(A)
Definition: JMessage.hh:67
range
z range($ZMAX-$ZMIN)< $MINIMAL_DZ." fi fi typeset -Z 4 STRING typeset -Z 2 FLOOR JPlot1D -f $
Definition: module-Z:fit.sh:118
JDETECTOR::JModuleAddressMap::getAddressTranslator
const JPMTAddressTranslator & getAddressTranslator(const int tdc) const
Get PMT address translator.
Definition: JModuleAddressMap.hh:208
JDETECTOR::load
void load(const std::string &file_name, JDetector &detector)
Load detector from input file.
Definition: JDetectorToolkit.hh:478
JLANG::JToken
Wrapper class around string.
Definition: JToken.hh:23
JDETECTOR::JPMTPhysicalAddress
Data structure for PMT physical address.
Definition: JPMTPhysicalAddress.hh:26
detector
do set_variable DETECTOR_TXT $WORKDIR detector
Definition: detector-XY:fit1d.sh:38
Generated by   doxygen 1.8.5