Addons required by XMM Wolter optics integration inside axionlib

examples/masks.rml

@@ -1,50 +1,69 @@
 <?xml version="1.0"?>
 <masks>
-  <TRestGridMask name="strongback" verboseLevel="warning">
-    <parameter name="maskRadius" value="20"/>
-    <parameter name="offset" value="(5,5)mm"/>
-    <parameter name="rotationAngle" value="0.5"/>
-    <parameter name="gridGap" value="1cm"/>
-    <parameter name="gridThickness" value="2mm"/>
-  </TRestGridMask>
-  <TRestStrippedMask name="stripped" verboseLevel="warning">
-    <parameter name="maskRadius" value="2cm"/>
-    <parameter name="offset" value="(3,3)mm"/>
-    <parameter name="rotationAngle" value="0.5"/>
-    <parameter name="stripsGap" value="12mm"/>
-    <parameter name="stripsThickness" value="1.2mm"/>
-  </TRestStrippedMask>
-  <TRestRingsMask name="rings" verboseLevel="warning">
-    <parameter name="maskRadius" value="9cm"/>
-    <parameter name="offset" value="(3,3)mm"/>
-    <parameter name="rotationAngle" value="0.5"/>
-    <parameter name="ringsGap" value="12mm"/>
-    <parameter name="ringsThickness" value="9mm"/>
-    <parameter name="initialRadius" value="3cm"/>
-    <parameter name="nRings" value="5"/>
-  </TRestRingsMask>
-  <TRestSpiderMask name="spider1" verboseLevel="info">
-    <parameter name="maskRadius" value="20cm"/>
-    <parameter name="offset" value="(0,0)cm"/>
-    <parameter name="rotationAngle" value="10"/>
-    <parameter name="armsWidth" value="5deg"/>
-    <parameter name="armsSeparationAngle" value="80degrees"/>
-    <parameter name="initialRadius" value="12cm"/>
-  </TRestSpiderMask>
-  <TRestSpiderMask name="spider2" verboseLevel="info">
-    <parameter name="maskRadius" value="20cm"/>
-    <parameter name="offset" value="(0,0)cm"/>
-    <parameter name="rotationAngle" value="0"/>
-    <parameter name="armsWidth" value="5deg"/>
-    <parameter name="armsSeparationAngle" value="30degrees"/>
-    <parameter name="initialRadius" value="3cm"/>
-  </TRestSpiderMask>
-  <TRestSpiderMask name="spider3" verboseLevel="info">
-    <parameter name="maskRadius" value="20cm"/>
-    <parameter name="offset" value="(0,0)cm"/>
-    <parameter name="rotationAngle" value="30deg"/>
-    <parameter name="armsWidth" value="5deg"/>
-    <parameter name="armsSeparationAngle" value="60degrees"/>
-    <parameter name="initialRadius" value="6cm"/>
-  </TRestSpiderMask>
+    <TRestGridMask name="strongback" verboseLevel="warning">
+        <parameter name="maskRadius" value="20"/>
+        <parameter name="offset" value="(5,5)mm"/>
+        <parameter name="rotationAngle" value="0.5"/>
+        <parameter name="gridGap" value="1cm"/>
+        <parameter name="gridThickness" value="2mm"/>
+    </TRestGridMask>
+    <TRestStrippedMask name="stripped" verboseLevel="warning">
+        <parameter name="maskRadius" value="2cm"/>
+        <parameter name="offset" value="(3,3)mm"/>
+        <parameter name="rotationAngle" value="0.5"/>
+        <parameter name="stripsGap" value="12mm"/>
+        <parameter name="stripsThickness" value="1.2mm"/>
+    </TRestStrippedMask>
+    <TRestRingsMask name="rings" verboseLevel="warning">
+        <parameter name="maskRadius" value="9cm"/>
+        <parameter name="offset" value="(3,3)mm"/>
+        <parameter name="rotationAngle" value="0.5"/>
+        <parameter name="ringsGap" value="12mm"/>
+        <parameter name="ringsThickness" value="9mm"/>
+        <parameter name="initialRadius" value="3cm"/>
+        <parameter name="nRings" value="5"/>
+    </TRestRingsMask>
+    <TRestSpiderMask name="spider1" verboseLevel="info">
+        <parameter name="maskRadius" value="20cm"/>
+        <parameter name="offset" value="(0,0)cm"/>
+        <parameter name="rotationAngle" value="10"/>
+        <parameter name="armsWidth" value="5deg"/>
+        <parameter name="armsSeparationAngle" value="80degrees"/>
+        <parameter name="initialRadius" value="12cm"/>
+    </TRestSpiderMask>
+    <TRestSpiderMask name="spider2" verboseLevel="info">
+        <parameter name="maskRadius" value="20cm"/>
+        <parameter name="offset" value="(0,0)cm"/>
+        <parameter name="rotationAngle" value="0"/>
+        <parameter name="armsWidth" value="5deg"/>
+        <parameter name="armsSeparationAngle" value="30degrees"/>
+        <parameter name="initialRadius" value="3cm"/>
+    </TRestSpiderMask>
+    <TRestSpiderMask name="spider3" verboseLevel="info">
+        <parameter name="maskRadius" value="20cm"/>
+        <parameter name="offset" value="(0,0)cm"/>
+        <parameter name="rotationAngle" value="30deg"/>
+        <parameter name="armsWidth" value="5deg"/>
+        <parameter name="armsSeparationAngle" value="60degrees"/>
+        <parameter name="initialRadius" value="6cm"/>
+    </TRestSpiderMask>
+    <TRestCombinedMask name="combined" verboseLevel="warning">
+        <TRestSpiderMask name="spider1" verboseLevel="warning">
+            <parameter name="maskRadius" value="20cm"/>
+            <parameter name="offset" value="(0,0)cm"/>
+            <parameter name="rotationAngle" value="10deg"/>
+            <parameter name="armsWidth" value="7deg"/>
+            <parameter name="armsSeparationAngle" value="30deg"/>
+            <parameter name="initialRadius" value="5cm"/>
+        </TRestSpiderMask>
+        <TRestRingsMask name="rings" verboseLevel="warning">
+            <parameter name="maskRadius" value="20cm"/>
+            <parameter name="offset" value="(0,0)mm"/>
+            <parameter name="rotationAngle" value="0"/>
+            <parameter name="ringsGap" value="25mm"/>
+            <parameter name="ringsThickness" value="15mm"/>
+            <parameter name="initialRadius" value="5cm"/>
+            <parameter name="nRings" value="6"/>
+        </TRestRingsMask>
+    </TRestCombinedMask>
 </masks>

source/bin/restRoot.cxx

@@ -13,7 +13,7 @@ using namespace std;
 #ifdef WIN32
 // in windows the pointer address from string conversion is without "0x", we must add
 // the prefix so that ROOT can correctly initialize run/metadata objects
-#define PTR_ADDR_PREFIX "0x"  
+#define PTR_ADDR_PREFIX "0x"
 #else
 #define PTR_ADDR_PREFIX ""
 #endif  // WIN32
@@ -75,6 +75,7 @@ int main(int argc, char* argv[]) {
 
     gROOT->ProcessLine("#include <TRestStringHelper.h>");
     gROOT->ProcessLine("#include <TRestPhysics.h>");
+    gROOT->ProcessLine("#include <TRestSystemOfUnits.h>");
     if (loadMacros) {
         if (!silent) printf("= Loading macros ...\n");
         auto a = TRestTools::Execute(

source/framework/CMakeLists.txt

@@ -1,6 +1,6 @@
 add_subdirectory(external)
 
-set(contents external/tinyxml tools core analysis)
+set(contents external/tinyxml tools core analysis masks)
 
 file(GLOB_RECURSE addon_src
         "tiny*cpp"

source/framework/analysis/src/TRestMySQLToAnalysisProcess.cxx

@@ -157,7 +157,14 @@ void TRestMySQLToAnalysisProcess::InitProcess() {
 /// \brief Function to initialize input/output event members and define the
 /// section name and library version
 ///
-void TRestMySQLToAnalysisProcess::Initialize() { SetSectionName(this->ClassName()); }
+void TRestMySQLToAnalysisProcess::Initialize() {
+    SetSectionName(this->ClassName());
+
+#ifndef USE_SQL
+    RESTWarning << "TRestMySQLToAnalysisProcess. REST was compiled without mySQL support" << RESTendl;
+    RESTWarning << "This process will not be funcional" << RESTendl;
+#endif
+}
 
 ///////////////////////////////////////////////
 /// \brief The main processing event function

source/framework/core/inc/TRestMetadata.h

@@ -236,6 +236,7 @@ class TRestMetadata : public TNamed {
     Int_t LoadConfigFromFile(const std::string& configFilename, const std::string& sectionName = "");
     Int_t LoadConfigFromBuffer();
 
+    TRestMetadata* InstantiateChildMetadata(int index, std::string pattern = "");
     TRestMetadata* InstantiateChildMetadata(std::string pattern = "", std::string name = "");
 
     /// Making default settings.

source/framework/core/src/TRestMetadata.cxx

@@ -668,8 +668,63 @@ Int_t TRestMetadata::LoadConfigFromBuffer() {
 
 ///////////////////////////////////////////////
 /// \brief This method will retrieve a new TRestMetadata instance of a child element
-/// of the present TRestMetadata instance. I.e. `TRestChildClass` in the following
-/// example:
+/// of the present TRestMetadata instance based on the `index` given by argument,
+/// which defines the element order to be retrieved, 0 for first element found, 1 for
+/// the second element found, etc.
+///
+/// In brief, it will create an instance of `TRestChildClass` in the following example:
+///
+/// \code
+///    <TRestThisMetadataClass ...
+///         <TRestChildClass ...> <!-- if index = 0 -->
+///         <TRestChildClass ...> <!-- if index = 1 -->
+///         <TRestChildClass ...> <!-- if index = 2 -->
+/// \endcode
+///
+/// An optional argument may help to restrict the search to a particular metadata
+/// element.
+///
+/// - *pattern*: If a pattern value is given, then the pattern must be contained inside
+/// the metadata class name. I.e. pattern="TRestGeant4" will require that the class
+/// belongs to the geant4 library.
+///
+/// Otherwise, the first child section that satisfies that it starts by `TRest` will be
+/// considered.
+///
+/// If no child element is found with the required criteria, `nullptr` will be returned.
+///
+TRestMetadata* TRestMetadata::InstantiateChildMetadata(int index, std::string pattern) {
+    int count = 0;
+    auto paraele = fElement->FirstChildElement();
+    while (paraele != nullptr) {
+        std::string xmlChild = paraele->Value();
+        if (xmlChild.find("TRest") == 0) {
+            if (pattern == "" || xmlChild.find(pattern) != string::npos) {
+                if (count == index) {
+                    TClass* c = TClass::GetClass(xmlChild.c_str());
+                    if (c)  // this means we have the metadata class was found
+                    {
+                        TRestMetadata* md = (TRestMetadata*)c->New();
+                        TiXmlElement* rootEle = GetElementFromFile(fConfigFileName);
+                        TiXmlElement* Global = GetElement("globals", rootEle);
+                        md->LoadConfigFromElement(paraele, Global, {});
+                        md->Initialize();
+                        return md;
+                    }
+                }
+                count++;
+            }
+        }
+        paraele = paraele->NextSiblingElement();
+    }
+    return nullptr;
+}
+
+///////////////////////////////////////////////
+/// \brief This method will retrieve a new TRestMetadata instance of a child element
+/// of the present TRestMetadata instance based on the `name` given by argument.
+///
+/// In brief, it will create an instance of `TRestChildClass` in the following example:
 ///
 /// \code
 ///    <TRestThisMetadataClass ...
@@ -688,22 +743,23 @@ Int_t TRestMetadata::LoadConfigFromBuffer() {
 /// Otherwise, the first child section that satisfies that it starts by `TRest` will be
 /// returned.
 ///
-/// If no child element is found `nullptr` will be returned.
+/// If no child element is found with the required criteria, `nullptr` will be returned.
 ///
 TRestMetadata* TRestMetadata::InstantiateChildMetadata(std::string pattern, std::string name) {
     auto paraele = fElement->FirstChildElement();
     while (paraele != nullptr) {
         std::string xmlChild = paraele->Value();
         if (xmlChild.find("TRest") == 0) {
             if (pattern.empty() || xmlChild.find(pattern) != string::npos) {
-                if (!name.empty() && name == (string)paraele->Attribute("name")) {
+                if (name.empty() || !name.empty() && name == (string)paraele->Attribute("name")) {
                     TClass* c = TClass::GetClass(xmlChild.c_str());
                     if (c)  // this means we have the metadata class was found
                     {
                         TRestMetadata* md = (TRestMetadata*)c->New();
                         TiXmlElement* rootEle = GetElementFromFile(fConfigFileName);
                         TiXmlElement* Global = GetElement("globals", rootEle);
                         md->LoadConfigFromElement(paraele, Global, {});
+                        md->Initialize();
                         return md;
                     }
                 }

source/framework/masks/README.md

@@ -0,0 +1 @@
+Pattern masks implemented to be used un ray-tracking at axionlib, but given their generic nature have been placed directly in the framework.

source/framework/masks/inc/TRestCombinedMask.h

@@ -0,0 +1,60 @@
+/*************************************************************************
+ * This file is part of the REST software framework.                     *
+ *                                                                       *
+ * Copyright (C) 2016 GIFNA/TREX (University of Zaragoza)                *
+ * For more information see https://gifna.unizar.es/trex                 *
+ *                                                                       *
+ * REST is free software: you can redistribute it and/or modify          *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * REST is distributed in the hope that it will be useful,               *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
+ * GNU General Public License for more details.                          *
+ *                                                                       *
+ * You should have a copy of the GNU General Public License along with   *
+ * REST in $REST_PATH/LICENSE.                                           *
+ * If not, see https://www.gnu.org/licenses/.                            *
+ * For the list of contributors see $REST_PATH/CREDITS.                  *
+ *************************************************************************/
+
+#ifndef REST_TRestCombinedMask
+#define REST_TRestCombinedMask
+
+#include <TRestPatternMask.h>
+
+/// A class used to define and generate a combined structure mask
+class TRestCombinedMask : public TRestPatternMask {
+   private:
+    std::vector<TRestPatternMask*> fMasks;
+
+   public:
+    void Initialize() override;
+
+    void AddMask(TRestPatternMask* mask) { fMasks.push_back(mask); }
+
+    TRestPatternMask* const& GetMask(int index) const {
+        if (index < fMasks.size()) {
+            return fMasks[index];
+        }
+        if (index == 0) RESTError << "TRestCombinedMask does not contain any masks" << RESTendl;
+        return fMasks[0];
+    }
+
+    Int_t GetRegion(Double_t x, Double_t y) override;
+
+    void InitFromConfigFile() override;
+
+    void PrintMetadata() override;
+    void PrintMaskMembers() override;
+    void PrintMask() override;
+
+    TRestCombinedMask();
+    TRestCombinedMask(const char* cfgFileName, std::string name = "");
+    ~TRestCombinedMask();
+
+    ClassDefOverride(TRestCombinedMask, 1);
+};
+#endif

source/framework/tools/inc/TRestGridMask.h → source/framework/masks/inc/TRestGridMask.h

@@ -52,8 +52,8 @@ class TRestGridMask : public TRestPatternMask {
     Int_t GetModulus() { return fModulus; }
 
     void PrintMetadata() override;
-
-    void Print() override;
+    void PrintMaskMembers() override;
+    void PrintMask() override;
 
     TRestGridMask();
     TRestGridMask(const char* cfgFileName, std::string name = "");

source/framework/tools/inc/TRestPatternMask.h → source/framework/masks/inc/TRestPatternMask.h

@@ -44,7 +44,10 @@ class TRestPatternMask : public TRestMetadata {
 
    protected:
     /// The maximum mask radius in mm (if 0 it will be infinite)
-    Double_t fMaskRadius = 0;
+    Double_t fMaskRadius = 0;  //<
+
+    /// The maximum number of regions allowed in each mask
+    Int_t fMaxRegions = 100;  //<
 
     /// It defines the mask type. To be called by the inherited class constructor.
     void SetType(const std::string& type) { fPatternType = type; }
@@ -55,8 +58,13 @@ class TRestPatternMask : public TRestMetadata {
     TRestPatternMask(const char* cfgFileName, std::string name = "");
 
    public:
+    Int_t GetMaxRegions() { return fMaxRegions; }
+
+    void SetMaxRegions(Int_t regions) { fMaxRegions = regions; }
+
     Bool_t HitsPattern(Double_t x, Double_t y);
 
+    /// To be implemented at the inherited class with the pattern and region identification logic
     virtual Int_t GetRegion(Double_t x, Double_t y) = 0;
 
     /// It returns the mask pattern type
@@ -80,9 +88,12 @@ class TRestPatternMask : public TRestMetadata {
     /// It defines the mask radius
     void SetMaskRadius(const Double_t& radius) { fMaskRadius = radius; }
 
-    void PrintMetadata() override;
+    void PrintCommonPatternMembers();
+
+    virtual void PrintMaskMembers() = 0;
+    virtual void PrintMask() = 0;
 
-    virtual void Print();
+    void PrintMetadata() override;
 
     TCanvas* DrawMonteCarlo(Int_t nSamples = 10000);
 

source/framework/tools/inc/TRestRingsMask.h → source/framework/masks/inc/TRestRingsMask.h

@@ -76,6 +76,9 @@ class TRestRingsMask : public TRestPatternMask {
     }
 
     void PrintMetadata() override;
+    void PrintMaskMembers() override;
+    void PrintMask() override;
+    void PrintRings();
 
     TRestRingsMask();
     TRestRingsMask(const char* cfgFileName, std::string name = "");

source/framework/tools/inc/TRestSpiderMask.h → source/framework/masks/inc/TRestSpiderMask.h

@@ -29,7 +29,6 @@
 class TRestSpiderMask : public TRestPatternMask {
    private:
     void Initialize() override;
-
     /// The angle between two consecutive spider arms measured in radians.
     Double_t fArmsSeparationAngle = 0;  //<
 
@@ -60,6 +59,8 @@ class TRestSpiderMask : public TRestPatternMask {
     Double_t GetInitialRadius() { return fInitialRadius; }
 
     void PrintMetadata() override;
+    void PrintMaskMembers() override;
+    void PrintMask() override;
 
     TRestSpiderMask();
     TRestSpiderMask(const char* cfgFileName, std::string name = "");