Merge branch 'toolConstantsCondAlg.CaloRec-20200623' into 'master'

CaloRec: Add ToolConstantsCondAlg.

See merge request atlas/athena!34022

Calorimeter/CaloRec/CMakeLists.txt

@@ -135,6 +135,11 @@ atlas_add_test( CaloThinCellsByClusterAlg_test
                 LOG_SELECT_PATTERN "ERROR|error|WARNING [^U]|FATAL|processing" )
 
 
+atlas_add_test( ToolConstantsCondAlg_test
+                SCRIPT test/ToolConstantsCondAlg_test.py
+                LOG_IGNORE_PATTERN "Cache alignment|Current filenames|Unable to locate catalog|peeking into" )
+
+
 atlas_add_test( CaloCellContainerAliasAlgConfig_test
                 SCRIPT python -m CaloRec.CaloCellContainerAliasAlgConfig
                 LOG_SELECT_PATTERN "ComponentAccumulator" )
@@ -148,3 +153,8 @@ atlas_add_test( CaloThinCellsByClusterAlgConfig_test
 atlas_add_test( CaloThinCellsBySamplingAlgConfig_test
                 SCRIPT python -m CaloRec.CaloThinCellsBySamplingAlgConfig
                 LOG_SELECT_PATTERN "ComponentAccumulator" )
+
+atlas_add_test( ToolConstantsCondAlgConfig_test
+                SCRIPT python -m CaloRec.ToolConstantsCondAlgConfig
+                LOG_SELECT_PATTERN "ComponentAccumulator|^---" )
+

Calorimeter/CaloRec/python/ToolConstantsCondAlgConfig.py

+# Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
+
+# File: CaloRec/python/ToolConstantsCondAlgConfig.py
+# Created: Jun 2020, sss
+# Purpose: Configure ToolConstantsCondAlg.
+
+from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
+from AthenaConfiguration.ComponentFactory import CompFactory
+
+
+def ToolConstantsCondAlgCfg (flags, key, DetStoreKey='', COOLFolder=''):
+    """Configure a conditions algorithm to convert inline COOL data or detector store data to ToolConstants.
+    KEY is also the key of the output conditions object.
+    For reading from COOL inline data, COOLFOLDER gives the name
+    of the COOL folder; the dta are given by KEY within the folder.
+    The caller should register the folder with IOVDbSvc.
+    For copying a ToolConstants object from the detector store,
+    set DETSTOREKEY to the key of the object to copy."""
+
+    if ((DetStoreKey == '' and COOLFolder == '') or
+        (DetStoreKey != '' and COOLFolder != '')):
+        raise RuntimeError ("ToolConstantsCondAlgCfg: For key " + key + ", exactly one of DetStoreKey or COOLFolder must be specified")
+
+    result = ComponentAccumulator()
+
+    name = 'ToolConstantsCondAlg_' + key
+
+    ToolConstantsCondAlg = CompFactory.ToolConstantsCondAlg # CaloRec
+    alg = ToolConstantsCondAlg (name,
+                                COOLFolderKey = COOLFolder,
+                                ToolConstantsKey = key,
+                                DetStoreKey = DetStoreKey)
+    result.addCondAlgo (alg)
+
+    return result
+
+
+if __name__ == "__main__":
+    from AthenaCommon.Configurable import Configurable
+    Configurable.configurableRun3Behavior = 1
+    from AthenaConfiguration.AllConfigFlags import ConfigFlags
+    ConfigFlags.loadAllDynamicFlags()
+
+    flags = ConfigFlags.clone()
+    flags.lock()
+
+    print ('--- detstore')
+    acc1 = ToolConstantsCondAlgCfg (flags, 'key1', DetStoreKey='ds1')
+    acc1.printConfig(summariseProps=True)
+    acc1.wasMerged()
+
+    print ('--- cool')
+    acc2 = ToolConstantsCondAlgCfg (flags, 'key2', COOLFolder='folder2')
+    acc2.printConfig(summariseProps=True)
+    acc2.wasMerged()
+
+    print ('--- error')
+    try:
+        acc3 = ToolConstantsCondAlgCfg (flags, 'key3', COOLFolder='folder3', DetStoreKey='ds3')
+    except RuntimeError:
+        pass
+    else:
+        assert 0, 'not caught'

Calorimeter/CaloRec/python/ToolConstantsCondAlgDefault.py

+# Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
+
+# File: CaloRec/python/ToolConstantsCondAlgDefault.py
+# Created: Jun 2020, sss
+# Purpose: Configure ToolConstantsCondAlg.
+
+
+from AthenaCommon.AlgSequence import AthSequencer
+from AthenaConfiguration.ComponentFactory import CompFactory
+
+
+def ToolConstantsCondAlgDefault (key, DetStoreKey='', COOLFolder=''):
+    """Configure a conditions algorithm to convert inline COOL data or detector store data to ToolConstants.
+    KEY is also the key of the output conditions object.
+    For reading from COOL inline data, COOLFOLDER gives the name
+    of the COOL folder; the dta are given by KEY within the folder.
+    The caller should register the folder with IOVDbSvc.
+    For copying a ToolConstants object from the detector store,
+    set DETSTOREKEY to the key of the object to copy."""
+
+    if ((DetStoreKey == '' and COOLFolder == '') or
+        (DetStoreKey != '' and COOLFolder != '')):
+        raise RuntimeError ("ToolConstantsCondAlgCfg: For key " + key + ", exactly one of DetStoreKey or COOLFolder must be specified")
+
+    name = 'ToolConstantsCondAlg_' + key
+    condSeq = AthSequencer ('AthCondSeq')
+
+    if hasattr (condSeq, name):
+        return getattr (condSeq, name)
+
+    ToolConstantsCondAlg = CompFactory.ToolConstantsCondAlg # CaloRec
+    alg = ToolConstantsCondAlg (name,
+                                COOLFolderKey = COOLFolder,
+                                ToolConstantsKey = key,
+                                DetStoreKey = DetStoreKey)
+
+    condSeq += alg
+    return alg
+
+    

Calorimeter/CaloRec/share/ToolConstantsCondAlgConfig_test.ref

+Py:Athena            INFO using release [?-22.0.0] [?] [?/?] -- built on [?]
+--- detstore
+Py:ComponentAccumulator    INFO Event Inputs
+Py:ComponentAccumulator    INFO Event Algorithm Sequences
+Py:ComponentAccumulator    INFO Top sequence 0
+Py:ComponentAccumulator    INFO \__ AthAlgSeq (seq: SEQ AND)
+Py:ComponentAccumulator    INFO Condition Algorithms
+Py:ComponentAccumulator    INFO  \__ ToolConstantsCondAlg_key1 (cond alg)
+Py:ComponentAccumulator    INFO      * COOLFolderKey: 
+Py:ComponentAccumulator    INFO      * DetStoreKey: ds1
+Py:ComponentAccumulator    INFO      * ToolConstantsKey: key1
+Py:ComponentAccumulator    INFO Services
+Py:ComponentAccumulator    INFO []
+Py:ComponentAccumulator    INFO Public Tools
+Py:ComponentAccumulator    INFO [
+Py:ComponentAccumulator    INFO ]
+Py:ComponentAccumulator    INFO Private Tools
+Py:ComponentAccumulator    INFO [
+Py:ComponentAccumulator    INFO ]
+Py:ComponentAccumulator    INFO TheApp properties
+--- cool
+Py:ComponentAccumulator    INFO Event Inputs
+Py:ComponentAccumulator    INFO Event Algorithm Sequences
+Py:ComponentAccumulator    INFO Top sequence 0
+Py:ComponentAccumulator    INFO \__ AthAlgSeq (seq: SEQ AND)
+Py:ComponentAccumulator    INFO Condition Algorithms
+Py:ComponentAccumulator    INFO  \__ ToolConstantsCondAlg_key2 (cond alg)
+Py:ComponentAccumulator    INFO      * COOLFolderKey: folder2
+Py:ComponentAccumulator    INFO      * DetStoreKey: 
+Py:ComponentAccumulator    INFO      * ToolConstantsKey: key2
+Py:ComponentAccumulator    INFO Services
+Py:ComponentAccumulator    INFO []
+Py:ComponentAccumulator    INFO Public Tools
+Py:ComponentAccumulator    INFO [
+Py:ComponentAccumulator    INFO ]
+Py:ComponentAccumulator    INFO Private Tools
+Py:ComponentAccumulator    INFO [
+Py:ComponentAccumulator    INFO ]
+Py:ComponentAccumulator    INFO TheApp properties
+--- error

Calorimeter/CaloRec/src/ToolConstantsCondAlg.cxx

+/*
+ * Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration.
+ */
+/**
+ * @file CaloRec/ToolConstantsCondAlg.h
+ * @author scott snyder <snyder@bnl.gov>
+ * @date Jun, 2020
+ * @brief Convert from COOL inline data / POOL data to ToolConstants.
+ */
+
+
+#include "ToolConstantsCondAlg.h"
+#include "GaudiKernel/ICondSvc.h"
+#include "GaudiKernel/ServiceHandle.h"
+
+
+/**
+ * @brief Algorithm initialize method.
+ */
+StatusCode ToolConstantsCondAlg::initialize()
+{
+  if (!m_coolFolderKey.empty()) {
+    if (!m_detStoreKey.empty()) {
+      ATH_MSG_ERROR( "Configuration error: both COOL folder and det store key specified." );
+      return StatusCode::FAILURE;
+    }
+    ATH_CHECK( m_blobTool.retrieve() );
+    ATH_CHECK( m_coolFolderKey.initialize() );
+  }
+  else if (m_detStoreKey.empty()) {
+    ATH_MSG_ERROR( "Configuration error: neither COOL folder nor det store key specified." );
+    return StatusCode::FAILURE;
+  }
+
+  ATH_CHECK( m_toolConstantsKey.initialize() );
+
+  ServiceHandle<ICondSvc> condSvc ("CondSvc", name());
+  ATH_CHECK( condSvc.retrieve() );
+  ATH_CHECK( condSvc->regHandle (this, m_toolConstantsKey) );
+
+  return StatusCode::SUCCESS;
+}
+
+
+/**
+ * @brief Algorithm execute method.
+ * @param ctx Event context.
+ */
+StatusCode ToolConstantsCondAlg::execute (const EventContext& ctx) const
+{
+  SG::WriteCondHandle<CaloRec::ToolConstants> toolConstants
+    (m_toolConstantsKey, ctx);
+
+  auto tc = std::make_unique<CaloRec::ToolConstants>();
+
+  if (!m_coolFolderKey.empty()) {
+    SG::ReadCondHandle<CondAttrListCollection> coolFolder(m_coolFolderKey, ctx);
+
+    const std::string key = m_toolConstantsKey.key();
+
+    const unsigned chNbr = m_blobTool->nameToChannelNumber (key);
+    // Check that this channel actually exits
+    const std::string& chanName = coolFolder->chanName (chNbr);
+    if (chanName.size()>0 && key!=chanName) {
+      ATH_MSG_ERROR( "Channel name does not match! Expected " << key << " found " << chanName );
+      return StatusCode::FAILURE;
+    }
+    else {
+      ATH_MSG_DEBUG( "Found channel number " << chNbr << " named " << key );
+    }
+
+    const coral::AttributeList& attrList = coolFolder->attributeList (chNbr);
+    ATH_CHECK( m_blobTool->AttrListToToolConstants (attrList, *tc) );
+
+    toolConstants.addDependency (coolFolder);
+  }
+  else if (!m_detStoreKey.empty()) {
+    const CaloRec::ToolConstants* tc_in = nullptr;
+    ATH_CHECK( detStore()->retrieve (tc_in, m_detStoreKey) );
+    *tc = *tc_in;
+
+    const EventIDBase::number_type UNDEFEVT = EventIDBase::UNDEFEVT;
+    const EventIDBase::number_type UNDEFNUM = EventIDBase::UNDEFNUM;
+    const EventIDRange fullRange (EventIDBase (0, UNDEFEVT, 0, 0, 0),
+                                  EventIDBase (UNDEFNUM-1, UNDEFEVT, UNDEFNUM-1, 0, 0));
+
+    toolConstants.addDependency (fullRange);
+  }
+  else {
+    ATH_MSG_ERROR( "Bad configuration." );
+    return StatusCode::FAILURE;
+  }
+
+  ATH_CHECK( toolConstants.record (std::move (tc)) );
+  return StatusCode::SUCCESS;
+}

Calorimeter/CaloRec/src/ToolConstantsCondAlg.h

+// This file's extension implies that it's C, but it's really -*- C++ -*-.
+/*
+ * Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration.
+ */
+/**
+ * @file CaloRec/ToolConstantsCondAlg.h
+ * @author scott snyder <snyder@bnl.gov>
+ * @date Jun, 2020
+ * @brief Convert from COOL inline data / POOL data to ToolConstants.
+ */
+
+
+#ifndef CALOREC_TOOLCONSTANTSCONDALG_H
+#define CALOREC_TOOLCONSTANTSCONDALG_H
+
+
+#include "CaloRec/Blob2ToolConstants.h"
+#include "CaloConditions/ToolConstants.h"
+#include "AthenaPoolUtilities/CondAttrListCollection.h"
+#include "AthenaBaseComps/AthReentrantAlgorithm.h"
+#include "StoreGate/ReadCondHandleKey.h"
+#include "StoreGate/WriteCondHandleKey.h"
+#include "GaudiKernel/ToolHandle.h"
+
+
+/**
+ * @brief Convert from COOL inline data to ToolConstants.
+ *
+ * For some tools, the input data are saved as COOL online data rather
+ * than as a ToolConstants object directly.  This conditions algorithm
+ * will convert these data to a ToolConstants object in the condition store.
+ *
+ * In some cases, we may also want to read a POOL file directly.
+ * In this case, the ToolConstants objects are available in the detector store.
+ * To handle this, we can also copy these objects to the conditions store.
+ *
+ * To read from COOL, the COOLFolderKey property should be set.
+ * To read from the detector store, the DetStoreKey property should be set.
+ */
+class ToolConstantsCondAlg
+  : public AthReentrantAlgorithm
+{
+public:
+  /// Inherit constructor.
+  using AthReentrantAlgorithm::AthReentrantAlgorithm;
+
+
+  /// Gaudi initialize method.
+  virtual StatusCode initialize() override;
+
+
+  /// Gaudi execute method.
+  StatusCode execute (const EventContext& ctx) const override;
+
+
+private:
+  ToolHandle<Blob2ToolConstants> m_blobTool
+  { this, "BlobTool", "Blob2ToolConstants", "Tool to convert from COOL inline ata." };
+
+  SG::ReadCondHandleKey<CondAttrListCollection> m_coolFolderKey
+  { this, "COOLFolderKey", "", "Name of COOL folder" };
+
+  StringProperty m_detStoreKey
+  { this, "DetStoreKey", "", "Key in DetetorStore of ToolConstants object." };
+
+  SG::WriteCondHandleKey<CaloRec::ToolConstants> m_toolConstantsKey
+  { this, "ToolConstantsKey", "", "SG key of output ToolConstants object" };
+};
+
+
+#endif // not CALOREC_TOOLCONSTANTSCONDALG_H

Calorimeter/CaloRec/src/components/CaloRec_entries.cxx

@@ -34,6 +34,7 @@
 #include "../CaloThinCellsByClusterAlg.h"
 #include "../CaloThinCellsBySamplingAlg.h"
 #include "../CaloCellContainerAliasAlg.h"
+#include "../ToolConstantsCondAlg.h"
 
 
 DECLARE_COMPONENT( CaloTowerMonitor )
@@ -78,3 +79,4 @@ DECLARE_COMPONENT (CaloCellDumper)
 DECLARE_COMPONENT (CaloThinCellsByClusterAlg)
 DECLARE_COMPONENT (CaloThinCellsBySamplingAlg)
 DECLARE_COMPONENT (CaloCellContainerAliasAlg)
+DECLARE_COMPONENT (ToolConstantsCondAlg)

Calorimeter/CaloRec/test/ToolConstantsCondAlg_test.py

+#!/usr/bin/env python
+#
+# Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration.
+#
+# File: CaloRec/python/ToolConstantsCondALg_test.py
+# Author: scott snyder
+# Date: Jun, 2020
+# Brief: Test for ToolConstantsCondAlg.
+#
+
+
+from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
+from AthenaConfiguration.ComponentFactory import CompFactory
+import ROOT
+
+
+def testCfg (configFlags):
+    result = ComponentAccumulator()
+
+    from IOVDbSvc.IOVDbSvcConfig import addFolders
+    result.merge (addFolders (configFlags,
+                              '/LAR/CellCorrOfl/deadOTX',
+                              detDb = 'LAR_OFL',
+                              className = 'CondAttrListCollection'))
+
+    from CaloRec.ToolConstantsCondAlgConfig import ToolConstantsCondAlgCfg
+    result.merge (ToolConstantsCondAlgCfg (configFlags,
+                                           'deadOTXCorrCtes',
+                                           COOLFolder='/LAR/CellCorrOfl/deadOTX'))
+
+    from EventSelectorAthenaPool.CondProxyProviderConfig import CondProxyProviderCfg
+    from CaloClusterCorrection.poolfiles import poolfiles
+    result.merge (CondProxyProviderCfg (configFlags,
+                                        poolFiles = [poolfiles['caloswcorr_pool_v22']]))
+    result.merge (ToolConstantsCondAlgCfg (configFlags,
+                                           'CaloSwClusterCorrections.rfac-v5',
+                                           DetStoreKey='CaloSwClusterCorrections.rfac-v5'))
+
+    CaloClusterCorrDumper = CompFactory.CaloClusterCorrDumper # CaloRec
+    alg = CaloClusterCorrDumper ('dumper1',
+                                 Constants = ['deadOTXCorrCtes',
+                                              'CaloSwClusterCorrections.rfac-v5'])
+    result.addEventAlgo (alg)
+    return result
+
+
+from AthenaCommon.Configurable import Configurable
+Configurable.configurableRun3Behavior=1
+from AthenaConfiguration.AllConfigFlags import ConfigFlags
+from AthenaConfiguration.TestDefaults import defaultTestFiles
+
+ConfigFlags.Input.Files = defaultTestFiles.RDO
+ConfigFlags.addFlag("Input.InitialTimeStamp", 1000)
+
+ConfigFlags.lock()
+from AthenaConfiguration.MainServicesConfig import MainServicesCfg 
+acc=MainServicesCfg (ConfigFlags)
+
+from McEventSelector.McEventSelectorConfig import McEventSelectorCfg
+acc.merge (McEventSelectorCfg (ConfigFlags))
+
+acc.merge (testCfg (ConfigFlags))
+acc.run(1)