Conditions provider for the per-channel tracker pedestals/noise. More...

Public Member Functions
	TrackerPedestalProvider (const std::string &name, const std::string &tagname, const framework::config::Parameters &parameters, framework::Process &process)

std::pair< const framework::ConditionsObject *, framework::ConditionsIOV >	getCondition (const ldmx::EventHeader &) override
	Pure virtual getCondition function.

Public Member Functions inherited from framework::ConditionsObjectProvider
	DECLARE_FACTORY (ConditionsObjectProvider, std::shared_ptr< ConditionsObjectProvider >, const std::string &, const std::string &, const framework::config::Parameters &, Process &)
	declare that we have a factory for these types of classes

	ConditionsObjectProvider (const std::string &objname, const std::string &tagname, const framework::config::Parameters &parameters, Process &process)
	Class constructor.

virtual	~ConditionsObjectProvider ()=default
	Class destructor.

virtual void	releaseConditionsObject (const ConditionsObject *co)
	Called by conditions system when done with a conditions object, appropriate point for cleanup.

virtual void	onProcessStart ()
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts.

virtual void	onProcessEnd ()
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events finishes, such as closing database connections.

virtual void	onNewRun (ldmx::RunHeader &)
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts for a given run.

const std::string &	getConditionObjectName () const
	Get the list of conditions objects available from this provider.

const std::string &	getTagName () const
	Access the tag name.

Private Member Functions
void	loadJson (TrackerPedestals &peds) const

Private Attributes
std::string	pedestal_file_

std::string	pedestal_format_ {"json"}

Additional Inherited Members
Protected Member Functions inherited from framework::ConditionsObjectProvider
std::pair< const ConditionsObject *, ConditionsIOV >	requestParentCondition (const std::string &name, const ldmx::EventHeader &context)
	Request another condition needed to construct this condition.

const Process &	process () const
	Get the process handle.

Protected Attributes inherited from framework::ConditionsObjectProvider
logging::logger	the_log_
	The logger for this ConditionsObjectProvider.

Detailed Description

Conditions provider for the per-channel tracker pedestals/noise.

Reads the pedestal file written by PedestalCalculator and serves it as a TrackerPedestals conditions object. The storage backend ("json"; future: "sqlite", ...) is selected by the pedestal_format parameter, so the choice of source lives entirely here rather than in any consuming processor.

Definition at line 23 of file TrackerPedestalProvider.cxx.

Constructor & Destructor Documentation

◆ TrackerPedestalProvider()

tracking::reco::TrackerPedestalProvider::TrackerPedestalProvider	(	const std::string &	name,
		const std::string &	tagname,
		const framework::config::Parameters &	parameters,
		framework::Process &	process )

inline

Definition at line 25 of file TrackerPedestalProvider.cxx.

      : framework::ConditionsObjectProvider(TrackerPedestals::CONDITIONS_NAME,
                                            tagname, parameters, process) {
    if (name != TrackerPedestals::CONDITIONS_NAME) {
      EXCEPTION_RAISE("BadConfig",
                      "The name provided to TrackerPedestalProvider '" + name +
                          "' is not the expected '" +
                          TrackerPedestals::CONDITIONS_NAME + "'.");
    }
    pedestal_file_ = parameters.get<std::string>("pedestal_file");
    pedestal_format_ =
        parameters.get<std::string>("pedestal_format", pedestal_format_);
  }

Member Function Documentation

◆ getCondition()

std::pair< const framework::ConditionsObject *, framework::ConditionsIOV > tracking::reco::TrackerPedestalProvider::getCondition ( const ldmx::EventHeader & context )

inlineoverridevirtual

Pure virtual getCondition function.

Must be implemented by any Conditions providers.

Implements framework::ConditionsObjectProvider.

Definition at line 42 of file TrackerPedestalProvider.cxx.

                                                  {
    auto* peds = new TrackerPedestals();
 
    // Dispatch on the configured storage backend.  Only JSON is supported
    // today; additional backends (e.g. SQLite) can be added as new load*().
    if (pedestal_format_ == "json") {
      loadJson(*peds);
    } else {
      EXCEPTION_RAISE("BadConfiguration",
                      "TrackerPedestalProvider unknown pedestal_format '" +
                          pedestal_format_ + "' (supported: 'json').");
    }
 
    std::cout << "[TrackerPedestalProvider] Loaded " << peds->size()
              << " channel pedestals from '" << pedestal_file_ << "'"
              << std::endl;
 
    // Pedestals are valid for all runs (data and MC) for now.
    return {peds, framework::ConditionsIOV(true, true)};
  }

◆ loadJson()

void tracking::reco::TrackerPedestalProvider::loadJson ( TrackerPedestals & peds ) const

inlineprivate

Definition at line 64 of file TrackerPedestalProvider.cxx.

                                              {
    std::ifstream in(pedestal_file_);
    if (!in) {
      EXCEPTION_RAISE("FileNotFound",
                      "TrackerPedestalProvider could not open pedestal file '" +
                          pedestal_file_ + "'.");
    }
 
    nlohmann::json doc;
    try {
      in >> doc;
    } catch (const nlohmann::json::parse_error& e) {
      EXCEPTION_RAISE(
          "BadFormat",
          "TrackerPedestalProvider failed to parse pedestal file '" +
              pedestal_file_ + "': " + e.what());
    }
 
    // Each channel is keyed "feb:hyb:apv:ch" -> {"mean":[...], "noise":[...]}.
    for (const auto& [key, ch] : doc.at("channels").items()) {
      uint8_t feb, hybrid, apv, channel;
      if (!channelmap::parseChannelKey(key, feb, hybrid, apv, channel))
        continue;
      TrackerPedestals::Channel ped;
      ped.mean_ = ch.at("mean").get<decltype(ped.mean_)>();
      ped.noise_ = ch.at("noise").get<decltype(ped.noise_)>();
      peds.add(feb, hybrid, apv, channel, ped);
    }
  }

Member Data Documentation

◆ pedestal_file_

std::string tracking::reco::TrackerPedestalProvider::pedestal_file_

private

Definition at line 94 of file TrackerPedestalProvider.cxx.

◆ pedestal_format_

std::string tracking::reco::TrackerPedestalProvider::pedestal_format_ {"json"}

private

Definition at line 95 of file TrackerPedestalProvider.cxx.

95{"json"};

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

Tracking/src/Tracking/Reco/TrackerPedestalProvider.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members