O2OverlapCheck.h

Go to the documentation of this file.

// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef ALICEO2_CADSUPPORT_O2OVERLAPCHECK_
#define ALICEO2_CADSUPPORT_O2OVERLAPCHECK_
 
#include <array>
#include <string>
#include <vector>
 
class TGeoShape;
class TGeoMatrix;
class TGeoVolume;
 
namespace o2
{
namespace cad
{
 
enum class OverlapVerdict {
  Disjoint,         
  Touching,         
  Interpenetrating, 
  Contained         
};
 
const char* OverlapVerdictName(OverlapVerdict verdict);
 
struct OverlapOptions {
  int pointsPerSolid = 20000;
  double depthTolerance = 1.e-6;
  double residualTolerance = 1.e-6;
  double padCm = 0.1;
  int volumeSamples = 0;
  bool checkExtrusion = true;
};
 
struct OverlapPair {
  std::string nameA;
  std::string nameB;
  OverlapVerdict verdict = OverlapVerdict::Disjoint;
 
  double depthCm = 0.;
  std::array<double, 3> deepestPoint{{0., 0., 0.}}; 
  std::string deepestPointFrom;                     
 
  int pointsAInsideB = 0; 
  int pointsBInsideA = 0;
  int deepPointsAInsideB = 0; 
  int deepPointsBInsideA = 0;
  int sampledA = 0; 
  int sampledB = 0;
 
  double separationCm = -1.;
 
  double sharedVolumeCm3 = -1.;   
  double sharedVolumeErrCm3 = 0.; 
  int sharedVolumeHits = 0;
};
 
struct OverlapSolidReport {
  std::string name;
  std::string shapeClass;
  int requested = 0;
  int accepted = 0;
  int rejected = 0;
  double worstResidualCm = 0.; 
  bool usedPointsOnSegments = false;
};
 
struct OverlapCensus {
  std::vector<OverlapSolidReport> solids;
  std::vector<OverlapPair> pairs; 
  std::vector<OverlapPair> extrusions;
 
  int nSolids = 0;
  int nPairsTotal = 0;  
  int nPairsTested = 0; 
  int nDisjoint = 0;
  int nTouching = 0;
  int nInterpenetrating = 0;
  int nContained = 0;
  int nExtruding = 0;
  int nPointsRejected = 0;
  double worstResidualCm = 0.;
  double elapsedSeconds = 0.;
 
  int illegalCount() const { return nInterpenetrating + nContained + nExtruding; }
};
 
int SampleBoundaryPoints(const TGeoShape* shape, int npoints, double residualTolerance,
                         std::vector<double>& points, int& rejected, double& worstResidual,
                         bool* usedPointsOnSegments = nullptr);
 
OverlapPair CheckPairOverlap(const TGeoShape* shapeA, const TGeoMatrix* matA, const std::string& nameA,
                             const TGeoShape* shapeB, const TGeoMatrix* matB, const std::string& nameB,
                             const OverlapOptions& options = OverlapOptions());
 
OverlapCensus CheckWorldOverlaps(const TGeoVolume* volume, const OverlapOptions& options = OverlapOptions());
 
} // namespace cad
} // namespace o2
 
#endif