GeoVolume.h

Go to the documentation of this file.

/* Copyright (C) 2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */

 
#ifndef ALGO_GeoVolume_h
#define ALGO_GeoVolume_h 1
 
#include <boost/serialization/access.hpp>
 
#include <cmath>
#include <limits>
#include <string>
 
namespace cbm::algo
{
  // TODO: maybe add translation and rotation of volumes to handle local reconstruction parameters as well
  //       (to be discussed)
  class GeoVolume {
    struct Dimension {
      double lo{+std::numeric_limits<double>::max()};  
      double up{-std::numeric_limits<double>::max()};  

      Dimension() = default;

      Dimension(double lo_, double up_) : lo(lo_), up(up_) {}

      Dimension& operator+=(const Dimension& other)
      {
        lo = std::min(lo, other.lo);
        up = std::max(up, other.up);
        return *this;
      }

      double Center() const { return (up + lo) * 0.5; }

      bool IsValid() const { return Size() > 0 && std::isfinite(Size()); }

      bool HasOverlapWith(const Dimension& other) const { return (lo - other.up) * (up - other.lo) <= 0; }

      double Size() const { return up - lo; }
    };
 
   public:
    GeoVolume() = default;

    GeoVolume(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);

    GeoVolume(std::pair<double, double> x, std::pair<double, double> y, std::pair<double, double> z);

    GeoVolume& operator+=(const GeoVolume& other);

    bool IsValid() const { return fX.IsValid() && fY.IsValid() && fZ.IsValid(); }

    double GetCenterX() const { return fX.Center(); }

    double GetCenterY() const { return fY.Center(); }

    double GetCenterZ() const { return fZ.Center(); }

    double GetMaxX() const { return fX.up; }

    double GetMaxY() const { return fY.up; }

    double GetMaxZ() const { return fZ.up; }

    double GetMinX() const { return fX.lo; }

    double GetMinY() const { return fY.lo; }

    double GetMinZ() const { return fZ.lo; }

    double GetSizeX() const { return fX.Size(); }

    double GetSizeY() const { return fY.Size(); }

    double GetSizeZ() const { return fZ.Size(); }

    bool HasOverlapWith(const GeoVolume& other) const;

    std::string ToString() const;
 
   private:
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int /*version*/)
    {
      ar& fX.lo;
      ar& fX.up;
      ar& fY.lo;
      ar& fY.up;
      ar& fZ.lo;
      ar& fZ.up;
    }
 
    Dimension fX{};  
    Dimension fY{};  
    Dimension fZ{};  
  };
 
}  // namespace cbm::algo
 
#endif