JACOUSTICS::JSydney Struct Reference

Main class for pre-calibration using acoustics data. More...

Classes
struct	detector_type
	Auxiliary data structure for detector with decomposed strings. More...
struct	fits_t
	Auxiliary data structure for group of lists of identifiers of to-be-fitted objects. More...
struct	ids_t
	List of object identifiers. More...
struct	JAnchorEditor
	Auxiliary class to edit orientation of anchor. More...
struct	JDyneemaEditor
	Auxiliary class to edit length of Dyneema ropes. More...
struct	JModuleEditor
	Auxiliary class to edit (z) position of module. More...
struct	JParameters_t
	Extended data structure for parameters of stage. More...
struct	JStringEditor
	Auxiliary class to edit (x,y,z) position of string. More...
struct	JTripodEditor
	Auxiliary class to edit (x,y,z) position of tripod. More...
struct	string_type
	Auxiliary data structure for decomposed string. More...

Public Types
typedef std::vector< JEvent >	input_type

Public Member Functions
	JSydney (const JFilenames &filenames, const JSoundVelocity &V, const size_t threads, const int debug)
	Constructor. More...
void	stage_0 (const JParameters_t &parameters)
	Fit procedure to determine the positions of tripods and transmitters using strings that are fixed. More...
void	stage_a (const JParameters_t &parameters)
	Fit procedure to determine the positions of the strings and tripods. More...
void	stage_b (const JParameters_t &parameters)
	Fit procedure to determine the stretching and z-positions of individual strings. More...
void	stage_c (const JParameters_t &parameters)
	Fit procedure to determine the z-positions of the modules. More...
void	stage_d (const JParameters_t &parameters)
	Fit procedure to determine the z-positions of anchors. More...
void	stage_x (const JParameters_t &parameters)
	Fit procedure to determine the (x,y,z) positions of the modules. More...
double	operator() (const int option) const
	Get chi2. More...
void	run (const std::string &script)
	Run. More...
void	store (const std::string &dir=".")
	Store data in given directory. More...
ids_t	getReceivers () const
	Get list of identifiers of receivers. More...
ids_t	getEmitters () const
	Get list of identifiers of emitters. More...

Public Attributes
JFilenames	filenames
JSoundVelocity	V
size_t	threads
int	debug
JSetup	setup
fits_t	fits
JTOOLS::JHashMap< int, JLocation >	receivers
std::unique_ptr< JLocationRouter >	router
std::vector< input_type >	input

Static Public Attributes
static constexpr double	RADIUS_M = 1.0
	maximal horizontal distance between T-bar and emitter/hydrophone More...

Private Attributes
std::vector< JSuperEvt >	output
JDetector	detector
	PMTs. More...
JFitParameters	parameters

Detailed Description

Main class for pre-calibration using acoustics data.

Definition at line 133 of file JSydney.cc.

Member Typedef Documentation

typedef std::vector<JEvent> JACOUSTICS::JSydney::input_type

Definition at line 1241 of file JSydney.cc.

Constructor & Destructor Documentation

JACOUSTICS::JSydney::JSydney ( const JFilenames &  filenames, const JSoundVelocity &  V, const size_t  threads, const int  debug  )

inline

Constructor.

Parameters

filenames	file names
V	sound velocity
threads	threads
debug	debug

Definition at line 582 of file JSydney.cc.

                                         :
      filenames(filenames),
      V(V),
      threads(threads),
      debug(debug)
    {
      load(filenames.detector, setup.detector);

      setup.tripods.load(filenames.tripod.c_str());

      if (filenames.hydrophone  != "") { setup.hydrophones .load(filenames.hydrophone .c_str()); }
      if (filenames.transmitter != "") { setup.transmitters.load(filenames.transmitter.c_str()); }

      for (JDetector::const_iterator i = setup.detector.begin(); i != setup.detector.end(); ++i) {
        receivers[i->getID()] = i->getLocation();
      }

      // detach PMTs

      detector = setup.detector;

      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {
        module->clear();
      }

      router.reset(new JLocationRouter(setup.detector));

      fits.initialise(setup);

      this->V.set(setup.detector.getUTMZ());                              // sound velocity at detector depth

      JKatoomba<JGandalf>::debug              = debug;
      JKatoomba<JGandalf>::MAXIMUM_ITERATIONS = 10000;

      JKatoomba<JEstimator>::MATRIX_INVERSION = LDU_t;

      ROOT::EnableThreadSafety();
    }

Member Function Documentation

void JACOUSTICS::JSydney::stage_0 ( const JParameters_t &  parameters )

inline

Fit procedure to determine the positions of tripods and transmitters using strings that are fixed.

Parameters

parameters

parameters

Definition at line 671 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JDetector      A;                                                   // old strings
      detector_type  B;                                                   // new strings with transmitter -> fit only base module
      JDetector      C;                                                   // new strings w/o  transmitter -> discard completely from fit

      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {

        if      (fits.strings     .count(module->getString()) == 0)
          A.push_back(*module);
        else if (fits.transmitters.count(module->getString()) != 0)
          B.push_back(*module);
        else
          C.push_back(*module);
      }
      
      setup.detector.swap(A);

      for (const auto& element : B) {
        setup.detector.push_back(element.second.base);
      }

      router.reset(new JLocationRouter(setup.detector));

      JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

      for (const int i : fits.tripods) {
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.x: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3X_t), parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.y: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3Y_t), parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.z: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3Z_t), parameters.steps[0]));
      }

      for (const int i : fits.transmitters) {
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "transmitter.x: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3X_t, true), parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "transmitter.y: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3Y_t, true), parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "transmitter.z: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3Z_t, true), parameters.steps[0]));
      }

      const double chi2 = fit(*this);

      for (auto& element : B) {

        const JModule&  base = setup.detector.getModule(router->getAddress(JLocation(element.second.base.getString(),0)));
        const JVector3D pos  = base.getPosition() - element.second.base.getPosition();

        for (string_type::iterator module = element.second.begin(); module != element.second.end(); ++module) {

          module->add(pos);

          setup.detector.push_back(*module);
        }
      }

      copy(C.begin(), C.end(), back_inserter(setup.detector));

      sort(setup.detector.begin(), setup.detector.end(), make_comparator(&JModule::getLocation));

      router.reset(new JLocationRouter(setup.detector));

      STATUS("detector: " << FIXED(9,4) << chi2 << endl);
    }

void JACOUSTICS::JSydney::stage_a ( const JParameters_t &  parameters )

inline

Fit procedure to determine the positions of the strings and tripods.

Parameters

parameters

parameters

Definition at line 744 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

      for (const int i : fits.strings) {
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "string.x: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3X_t, true),  parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "string.y: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3Y_t, true),  parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "string.z: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3Z_t, false), parameters.steps[0]));
      }

      for (const int i : fits.tripods) {
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.x: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3X_t), parameters.steps[1]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.y: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3Y_t), parameters.steps[1]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "tripod.z: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3Z_t), parameters.steps[1]));
      }

      for (const int i : ids_t(fits.hydrophones, fits.transmitters)) {
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "anchor.R: " << RIGHT(4) << i), new JAnchorEditor(setup, i), parameters.steps[0] / RADIUS_M));
      }

      for (const int i : fits.transmitters) {

        JModule& module = setup.detector.getModule(router->getAddress(JLocation(i,0)));

        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "anchor.R: " << RIGHT(4) << i), new JAnchorEditor(setup, i), parameters.steps[0] / RADIUS_M));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "anchor.z: " << RIGHT(4) << i), new JModuleEditor(module),   parameters.steps[0]));
      }

      const double chi2 = fit(*this);

      STATUS("detector: " << FIXED(9,4) << chi2 << endl);
    }

void JACOUSTICS::JSydney::stage_b ( const JParameters_t &  parameters )

inline

Fit procedure to determine the stretching and z-positions of individual strings.

Parameters

parameters

parameters

Definition at line 788 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      map<int, JDetector> buffer;
      
      double z0 = 0.0;
      
      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {

        buffer[module->getString()].push_back(*module);
        
        if (module->getZ() > z0) {
          z0 = module->getZ();
        }
      }

      JDetector tx;

      for (transmitters_container::iterator i = setup.transmitters.begin(); i != setup.transmitters.end(); ++i) {
        try {
          tx.push_back(router->getModule(i->getLocation()));
        }
        catch(const exception&) {}
      }

      for (const int i : fits.strings) {

        setup.detector.swap(buffer[i]);

        copy(tx.begin(), tx.end(), back_inserter(setup.detector));

        router.reset(new JLocationRouter(setup.detector));

        JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "string.M: " << RIGHT(4) << i), new JDyneemaEditor(setup, i, z0),                 parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "string.z: " << RIGHT(4) << i), new JStringEditor (setup, i, JVector3Z_t, false), parameters.steps[1]));

        const double chi2 = fit(*this);

        STATUS("string: " << setw(4) << i << ' ' << FIXED(9,4) << chi2 << endl);

        buffer[i].clear();

        copy_if(setup.detector.begin(), setup.detector.end(), back_inserter(buffer[i]), make_predicate(&JModule::getString, i));
      }

      setup.detector.clear();      
      
      for (const auto& element : buffer) {
        copy(element.second.begin(), element.second.end(), back_inserter(setup.detector));
      }

      router.reset(new JLocationRouter(setup.detector));
    }

void JACOUSTICS::JSydney::stage_c ( const JParameters_t &  parameters )

inline

Fit procedure to determine the z-positions of the modules.

Parameters

parameters

parameters

Definition at line 854 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {
        if (fits.strings.count(module->getString()) != 0 && module->getFloor() != 0) {
          fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "module.z: " << right << module->getLocation()), new JModuleEditor(*module), parameters.steps[0]));
        }
      }

      const double chi2 = fit(*this);

      STATUS("detector: " << FIXED(9,4) << chi2 << endl);
    }

void JACOUSTICS::JSydney::stage_d ( const JParameters_t &  parameters )

inline

Fit procedure to determine the z-positions of anchors.

Parameters

parameters

parameters

Definition at line 880 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {
        if (fits.strings.count(module->getString()) != 0 && module->getFloor() == 0) {
          fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "module.z: " << right << module->getLocation()), new JModuleEditor(*module), parameters.steps[0]));
        }
      }

      const double chi2 = fit(*this);

      STATUS("detector: " << FIXED(9,4) << chi2 << endl);
    }

void JACOUSTICS::JSydney::stage_x ( const JParameters_t &  parameters )

inline

Fit procedure to determine the (x,y,z) positions of the modules.

This procedure should be considered unorthodox - it can be used to modify the detector file in such a way to accommodate anomalies in the shapes of a string (e.g. entanglement of string in D0ORCA018).

Parameters

parameters

parameters

Definition at line 908 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JGradient fit(parameters.Nmax, parameters.Nextra, parameters.epsilon, parameters.debug);

      for (JDetector::iterator module = setup.detector.begin(); module != setup.detector.end(); ++module) {
        if (fits.strings.count(module->getString()) != 0 && module->getFloor() != 0) {
          fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "module.x: " << right << module->getLocation()), new JModuleEditor(*module, JVector3X_t), parameters.steps[0]));
          fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "module.y: " << right << module->getLocation()), new JModuleEditor(*module, JVector3Y_t), parameters.steps[0]));
          fit.push_back(JModifier_t(MAKE_STRING(LEFT(16) << "module.z: " << right << module->getLocation()), new JModuleEditor(*module, JVector3Z_t), parameters.steps[0]));
        }
      }

      const double chi2 = fit(*this);

      STATUS("detector: " << FIXED(9,4) << chi2 << endl);
    }

double JACOUSTICS::JSydney::operator() ( const int  option ) const

inline

Get chi2.

Parameters

option

option

Returns

chi2/NDF

Definition at line 937 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      const JGeometry geometry(setup.detector, setup.hydrophones);

      JHashMap<int, JEmitter>    emitters;

      for (tripods_container::const_iterator i = setup.tripods.begin(); i != setup.tripods.end(); ++i) {
        {
          emitters[i->getID()]  = JEmitter(i->getID(), i->getUTMPosition() - setup.detector.getUTMPosition());
        }
      }

      for (transmitters_container::const_iterator i = setup.transmitters.begin(); i != setup.transmitters.end(); ++i) {
        try {
          emitters[i->getID()]  = JEmitter(i->getID(), i->getPosition()    + router->getModule(i->getLocation()).getPosition());
        }
        catch(const exception&) {}                                        // if no module available, discard transmitter
      }

      if        (option == 0 ||                                           // step wise improvement of the chi2
                 option == 1) {                                           // evaluation of the chi2 before the determination of the gradient of the chi2

        this->output.clear();

        JSTDObjectWriter<JSuperEvt>  out(this->output);                   // write data for subsequent use

        JFremantle::output = (option == 1 ? &out : NULL);

        {
          JFremantle fremantle(geometry, V, parameters, threads, 2 * threads);

          for (const input_type& superevt : input) {

            const JWeight getWeight(superevt.begin(), superevt.end());

            set<int>      counter;
            vector<JHit>  data;

            for (input_type::const_iterator evt = superevt.begin(); evt != superevt.end(); ++evt) {

              if (emitters.has(evt->getID())) {

                const JEmitter& emitter = emitters [evt->getID()];
                const double    weight  = getWeight(evt->getID());

                for (JEvent::const_iterator i = evt->begin(); i != evt->end(); ++i) {

                  if (geometry.hasLocation(receivers[i->getID()])) {

                    data.push_back(JHit(emitter,
                                        distance(superevt.begin(), evt),
                                        receivers[i->getID()],
                                        i->getToA(),
                                        parameters.sigma_s,
                                        weight));

                    counter.insert(evt->getID());
                  }
                }
              }
            }

            if (counter.size() >= parameters.Nmin) {
              fremantle.enqueue(data);
            }
          }
        }

        return JFremantle::Q.getMean(numeric_limits<float>::max());

      } else if (option == 2) {                                           // evaluation of the derivative of the chi2 to each fit parameter

        {
          JSTDObjectReader<JSuperEvt>  in(this->output);

          JPlatypus platypus(geometry, emitters, V, parameters, in, threads);
        }

        return JPlatypus::Q.getMean(numeric_limits<float>::max());

      } else {

        return numeric_limits<float>::max();
      }
    }

void JACOUSTICS::JSydney::run ( const std::string &  script )

inline

Run.

Parameters

script

steering script

Definition at line 1032 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      ifstream in(script.c_str());

      while (in) {

        string buffer, key;

        if (getline(in, buffer)) {

          if (buffer.empty() || buffer[0] == skip_t) {
            continue;
          }

          istringstream is(buffer);

          is >> key;

          if (key == initialise_t) {                   // set object identifiers

            fits.initialise(setup);
            
          } else if (key == fix_t) {                   // fix object identifiers

            string type;                               // type of object
            ids_t  id;                                 // identifiers
        
            if (is >> type >> id) {
              if        (type == string_t) {
                fits.strings     .fix(id);
                fits.hydrophones .fix(id);
                fits.transmitters.fix(id);
              } else if (type == tripod_t) {
                fits.tripods     .fix(id);
              } else {
                THROW(JValueOutOfRange, "Invalid type <" << type << ">");
              }
            }

          } else if (key == stage_t) {                 // stage

            string        stage;
            JParameters_t input;

            if (is >> stage >> input) {

              STATUS("stage " << setw(3) << stage << " {" << input << "}" << endl);

              JTimer timer;

              timer.start();

              ofstream out(MAKE_CSTRING("stage-" << stage << ".log"));

              {
                JRedirectStream redirect(cout, out);
              
                switch (stage[stage.size() - 1]) {

                case '0':
                  stage_0(input);
                  break;

                case 'a':
                case 'A':
                  stage_a(input);
                  break;

                case 'b':
                case 'B':
                  stage_b(input);
                  break;

                case 'c':
                case 'C':
                  stage_c(input);
                  break;

                case 'd':
                case 'D':
                  stage_d(input);
                  break;

                case 'x':
                case 'X':
                  stage_x(input);
                  break;

                default:
                  THROW(JValueOutOfRange, "Invalid stage <" << stage << ">");
                  break;
                }
              }
            
              out.close();

              store(stage);
              store();

              timer.stop();

              STATUS("Elapsed time " << FIXED(12,3) << timer.usec_wall * 1.0e-6 << " s." << endl);
            }

          } else {
            THROW(JValueOutOfRange, "Invalid key <" << key << ">");
          }
        }
      }

      in.close();
    }

void JACOUSTICS::JSydney::store ( const std::string &  dir = "." )

inline

Store data in given directory.

Parameters

dir

directory

Definition at line 1154 of file JSydney.cc.

    {
      using namespace JPP;

      if (getFileStatus(dir.c_str()) || (mkdir(dir.c_str(), S_IRWXU | S_IRWXG) != -1)) {

        // attach PMTs

        for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
          module->set(router->getModule(module->getLocation()).getPosition());
        }

        JDETECTOR::store(getFilename(dir, filenames.detector), detector);

        setup.tripods.store(getFilename(dir, filenames.tripod).c_str());

        if (filenames.hydrophone  != "") { setup.hydrophones .store(getFilename(dir, filenames.hydrophone) .c_str()); }
        if (filenames.transmitter != "") { setup.transmitters.store(getFilename(dir, filenames.transmitter).c_str()); }

      } else {

        THROW(JValueOutOfRange, "Invalid directory <" << dir << ">");
      }
    }

ids_t JACOUSTICS::JSydney::getReceivers ( ) const

inline

Get list of identifiers of receivers.

Returns

list of identifiers

Definition at line 1185 of file JSydney.cc.

    {
      ids_t buffer;

      for (JDetector::const_iterator i = setup.detector.begin(); i != setup.detector.end(); ++i) {
        if ((i->getFloor() != 0 && !i->has(PIEZO_DISABLE)) || (setup.hydrophones.hasString(i->getString()) && !i->has(HYDROPHONE_DISABLE))) {
          buffer.insert(i->getID());
        }
      }

      return buffer;
    }

ids_t JACOUSTICS::JSydney::getEmitters ( ) const

inline

Get list of identifiers of emitters.

Returns

list of identifiers

Definition at line 1204 of file JSydney.cc.

    {
      using namespace std;

      ids_t buffer;

      for (tripods_container::const_iterator i = setup.tripods.begin(); i != setup.tripods.end(); ++i) {
        buffer.insert(i->getID());
      }

      for (transmitters_container::const_iterator i = setup.transmitters.begin(); i != setup.transmitters.end(); ++i) {

        try {

          const JModule& module = router->getModule(i->getLocation());

          if (!module.has(TRANSMITTER_DISABLE)) {
            buffer.insert(i->getID());
          }
        }
        catch(const exception&) {}
      }

      return buffer;
    }

Member Data Documentation

constexpr double JACOUSTICS::JSydney::RADIUS_M = 1.0

static

maximal horizontal distance between T-bar and emitter/hydrophone

Definition at line 135 of file JSydney.cc.

JFilenames JACOUSTICS::JSydney::filenames

Definition at line 1231 of file JSydney.cc.

JSoundVelocity JACOUSTICS::JSydney::V

Definition at line 1232 of file JSydney.cc.

size_t JACOUSTICS::JSydney::threads

Definition at line 1233 of file JSydney.cc.

int JACOUSTICS::JSydney::debug

Definition at line 1234 of file JSydney.cc.

JSetup JACOUSTICS::JSydney::setup

Definition at line 1235 of file JSydney.cc.

fits_t JACOUSTICS::JSydney::fits

Definition at line 1236 of file JSydney.cc.

JTOOLS::JHashMap<int, JLocation> JACOUSTICS::JSydney::receivers

Definition at line 1238 of file JSydney.cc.

std::unique_ptr<JLocationRouter> JACOUSTICS::JSydney::router

Definition at line 1239 of file JSydney.cc.

std::vector<input_type> JACOUSTICS::JSydney::input

Definition at line 1242 of file JSydney.cc.

std::vector<JSuperEvt> JACOUSTICS::JSydney::output

mutableprivate

Definition at line 1245 of file JSydney.cc.

JDetector JACOUSTICS::JSydney::detector

private

PMTs.

Definition at line 1247 of file JSydney.cc.

JFitParameters JACOUSTICS::JSydney::parameters

private

Definition at line 1248 of file JSydney.cc.

---

The documentation for this struct was generated from the following file:

• JSydney.cc