JACOUSTICS::JSydney Struct Reference

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

Classes
struct	fits_t
	Auxiliary data structure for group of lists of identifiers of to-be-fitted objects. More...
struct	ids_t
	List of identifiers. More...
struct	JAnchorEditor
	Auxiliary class to edit rotation 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...

Public Types
typedef std::vector< JEvent >	ievt_type
typedef std::vector< ievt_type >	idat_type

Public Member Functions
	JSydney (const JFilenames &filenames, const JSoundVelocity &V, const size_t jobs, const int debug)
	Constructor. More...
void	stage_0 (const JParameters_t &parameters)
	Fit procedure to determine the positions of tripods 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...
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...

Public Attributes
JFilenames	filenames
JSoundVelocity	V
size_t	jobs
int	debug
JSetup	setup
fits_t	fits
JTOOLS::JHashMap< int, JLocation >	receivers
std::unique_ptr< JLocationRouter >	router
idat_type	idat

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

Private Types
typedef std::vector< JSuperEvt >	odat_type

Private Attributes
odat_type	odat
JDetector	detector
	PMTs. More...
JFitParameters	parameters

Detailed Description

Main class for pre-calibration using acoustics data.

Definition at line 126 of file JSydney.cc.

Member Typedef Documentation

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

Definition at line 1017 of file JSydney.cc.

typedef std::vector<ievt_type> JACOUSTICS::JSydney::idat_type

Definition at line 1018 of file JSydney.cc.

typedef std::vector<JSuperEvt> JACOUSTICS::JSydney::odat_type

private

Definition at line 1023 of file JSydney.cc.

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

filenames	file names
V	sound velocity
jobs	jobs
debug	debug

Definition at line 561 of file JSydney.cc.

                                         :
      filenames(filenames),
      V(V),
      jobs(jobs),
      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 using strings that are fixed.

Parameters

parameters

parameters

Definition at line 609 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      this->parameters = parameters;

      JDetector buffer[2];

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

        if (fits.strings.count(module->getString()) != 0)
          buffer[0].push_back(*module);                            // new strings
        else
          buffer[1].push_back(*module);                            // old strings
      }

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

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

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

      const double chi2 = fit(*this);

      copy(buffer[0].begin(), buffer[0].end(), back_inserter(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 649 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(12) << "string.x: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3X_t, true),  parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "string.y: " << RIGHT(4) << i), new JStringEditor(setup, i, JVector3Y_t, true),  parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "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(12) << "tripod.x: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3X_t), parameters.steps[1]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "tripod.y: " << RIGHT(4) << i), new JTripodEditor(setup, i, JVector3Y_t), parameters.steps[1]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "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(12) << "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(12) << "anchor.R: " << RIGHT(4) << i), new JAnchorEditor(setup, i), parameters.steps[0] / RADIUS_M));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "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 693 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();
        }
      }

      setup.detector.clear();      

      for (const int i : fits.strings) {

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

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

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

        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "string.M: " << RIGHT(4) << i), new JDyneemaEditor(setup, i, z0),                 parameters.steps[0]));
        fit.push_back(JModifier_t(MAKE_STRING(LEFT(12) << "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);

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

      setup.detector.clear();      
      
      for (const auto& detector : buffer) {
        copy(detector.second.begin(), detector.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 748 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(12) << "module.z: " << right << module->getLocation()), new JModuleEditor(*module), 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 775 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

        JSTDObjectWriter<JSuperEvt>  out(this->odat);                     // storage of data for subsequent use

        this->odat.clear();

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

        {
          JFremantle fremantle(geometry, V, parameters, jobs);

          for (idat_type::const_iterator superevt = idat.begin(); superevt != idat.end(); ++superevt) {

            const JWeight getWeight(superevt->begin(), superevt->end());

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

            for (ievt_type::const_iterator evt = superevt->begin(); evt != superevt->end(); ++evt) {

              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

        {
          JPlatypus platypus(geometry, emitters, V, parameters, jobs);

          for (odat_type::const_iterator superevt = odat.begin(); superevt != odat.end(); ++superevt) {
            platypus.enqueue(*superevt);
          }
        }

        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 869 of file JSydney.cc.

    {
      using namespace std;
      using namespace JPP;

      ifstream in(script.c_str());

      while (in) {

        string key, value;

        if (in >> key) {

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

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

            getline(in, value);

            istringstream is(value);

            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

            getline(in, value);

            istringstream is(value);

            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;

                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 981 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 << ">");
      }
    }

Member Data Documentation

constexpr double JACOUSTICS::JSydney::RADIUS_M = 1.0

static

maximal horizontal distance between T-bar and emitter/hydrophone

Definition at line 128 of file JSydney.cc.

JFilenames JACOUSTICS::JSydney::filenames

Definition at line 1007 of file JSydney.cc.

JSoundVelocity JACOUSTICS::JSydney::V

Definition at line 1008 of file JSydney.cc.

size_t JACOUSTICS::JSydney::jobs

Definition at line 1009 of file JSydney.cc.

int JACOUSTICS::JSydney::debug

Definition at line 1010 of file JSydney.cc.

JSetup JACOUSTICS::JSydney::setup

Definition at line 1011 of file JSydney.cc.

fits_t JACOUSTICS::JSydney::fits

Definition at line 1012 of file JSydney.cc.

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

Definition at line 1014 of file JSydney.cc.

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

Definition at line 1015 of file JSydney.cc.

idat_type JACOUSTICS::JSydney::idat

Definition at line 1020 of file JSydney.cc.

odat_type JACOUSTICS::JSydney::odat

mutableprivate

Definition at line 1024 of file JSydney.cc.

JDetector JACOUSTICS::JSydney::detector

private

PMTs.

Definition at line 1026 of file JSydney.cc.

JFitParameters JACOUSTICS::JSydney::parameters

private

Definition at line 1027 of file JSydney.cc.

---

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

• JSydney.cc