gar::geo::GeometryGArConfigurationWriter Class Reference

Writes geometry configuration information into art runs. More...

Inheritance diagram for gar::geo::GeometryGArConfigurationWriter:

Classes
struct	Config
	Service configuration. More...

Public Types
using	Parameters = art::ServiceTable< Config >

Public Member Functions
	GeometryGArConfigurationWriter (Parameters const &)
	Constructor: gets its configuration and does nothing with it. More...
Public Member Functions inherited from art::ProducingService
	ProducingService ()
virtual	~ProducingService () noexcept
void	setModuleDescription (ModuleDescription const &)
void	registerCallbacks (ProducingServiceSignals &)
void	doPostReadRun (RunPrincipal &)
void	doPostReadSubRun (SubRunPrincipal &)
void	doPostReadEvent (EventPrincipal &)

Private Types
using	InfoPtr_t = std::unique_ptr< gar::sumdata::GeometryConfigurationInfo >
	Alias for the pointer to the data product object to be put into the run. More...

Private Member Functions
virtual void	postReadRun (art::Run &run) override
	Writes the information from the service configuration into the run. More...
InfoPtr_t	loadInfo (art::Run &run) const
	Loads the geometry information from the run (either directly or legacy). More...
InfoPtr_t	readGeometryInformation (art::Run &run) const
	Reads geometry information from the run (returns null pointer if none). More...
InfoPtr_t	makeInfoFromRunData (art::Run &run) const
gar::sumdata::RunData const *	readRunData (art::Run &run) const
	Returns a pointer to the sumdata::RunData in run (nullptr if none). More...

Static Private Member Functions
static InfoPtr_t	extractInfoFromGeometry ()
	Creates configuration information based on the current Geometry service. More...
static InfoPtr_t	convertRunDataToGeometryInformation (gar::sumdata::RunData const &data)
	Converts the legacy data into geometry configuration information. More...
static InfoPtr_t	makeInfoPtr (gar::sumdata::GeometryConfigurationInfo const &info)
	Alias to std::make_unique<sumdata::GeometryConfigurationInfo>. More...

Additional Inherited Members
Static Public Attributes inherited from art::ProducingService
static constexpr bool	service_handle_allowed {false}

Detailed Description

Writes geometry configuration information into art runs.

This service is part of the mandatory version check of gar::geo::Geometry service. It does not require any special configuration, but it must be listed in the configuration in order for Geometry to work:

services: {

  GeometryGArConfigurationWriter: {}

  Geometry: @local::experiment_geometry

  # ...

}

The configuration check is described in the documentation of gar::geo::Geometry service.

Produced data products

The service guarantees that configuration information of type sumdata::GeometryConfigurationInfo is present into the run, accessible with an input tag GeometryGArConfigurationWriter:

• if such information is already available in the run, no further information is added
• legacy: if there is no such information, but there is a sumdata::RunData data product, a reduced version of the configuration information is created from the information in that data product (the first one, if multiple are present)
• finally, if no information is present neither in the full sumdata::GeometryConfigurationInfo form nor in the legacy sumdata::RunData form, information is put together based on the current configuration of the Geometry service.

Service dependencies

• Geometry service (for obtaining the current configuration to put into the event)

Definition at line 83 of file GeometryGArConfigurationWriter_service.cc.

Member Typedef Documentation

using gar::geo::GeometryGArConfigurationWriter::InfoPtr_t = std::unique_ptr<gar::sumdata::GeometryConfigurationInfo>

private

Alias for the pointer to the data product object to be put into the run.

Definition at line 105 of file GeometryGArConfigurationWriter_service.cc.

using gar::geo::GeometryGArConfigurationWriter::Parameters = art::ServiceTable<Config>

Definition at line 92 of file GeometryGArConfigurationWriter_service.cc.

Constructor & Destructor Documentation

gar::geo::GeometryGArConfigurationWriter::GeometryGArConfigurationWriter

(

Parameters const &

)

Constructor: gets its configuration and does nothing with it.

Definition at line 137 of file GeometryGArConfigurationWriter_service.cc.

{
  produces<gar::sumdata::GeometryConfigurationInfo, art::InRun>();
}

Member Function Documentation

auto gar::geo::GeometryGArConfigurationWriter::convertRunDataToGeometryInformation ( gar::sumdata::RunData const &  data )

staticprivate

Converts the legacy data into geometry configuration information.

Definition at line 221 of file GeometryGArConfigurationWriter_service.cc.

{
  
  gar::sumdata::GeometryConfigurationInfo confInfo;
  
  // we use the simplest version 1 data format (legacy format)
  confInfo.dataVersion = gar::sumdata::GeometryConfigurationInfo::DataVersion_t{1};
  confInfo.detectorName = data.DetName();

  MF_LOG_DEBUG("GeometryGArConfigurationWriter")
      << "Built geometry configuration information from run data:\n"
      << confInfo;

  return makeInfoPtr(std::move(confInfo));
  
} // gar::geo::GeometryGArConfigurationWriter::convertRunDataToGeometryInformation()

auto gar::geo::GeometryGArConfigurationWriter::extractInfoFromGeometry ( )

staticprivate

Creates configuration information based on the current Geometry service.

Definition at line 176 of file GeometryGArConfigurationWriter_service.cc.

                                                                                {
  
  gar::sumdata::GeometryConfigurationInfo confInfo = art::ServiceHandle<gar::geo::GeometryGAr>()->configurationInfo();

  MF_LOG_DEBUG("GeometryGArConfigurationWriter") << "Geometry configuration information from service:\n"
                                                 << confInfo;

  return makeInfoPtr(std::move(confInfo));
  
} // gar::geo::GeometryGArConfigurationWriter::extractInfoFromGeometry()

auto gar::geo::GeometryGArConfigurationWriter::loadInfo ( art::Run &  run ) const

private

Loads the geometry information from the run (either directly or legacy).

Definition at line 156 of file GeometryGArConfigurationWriter_service.cc.

{
  
  /*
   * Read geometry configuration information from the run:
   * 
   * 1. first attempt to directly read information from past runs of this
   *    service
   * 2. if none is found, attempt reading legacy information and upgrade it
   * 3. if no legacy information is found either, return a null pointer
   * 
   */
  InfoPtr_t info = readGeometryInformation(run);
  
  return info ? std::move(info) : makeInfoFromRunData(run);
  
} // gar::geo::GeometryGArConfigurationWriter::loadInfo()

auto gar::geo::GeometryGArConfigurationWriter::makeInfoFromRunData ( art::Run &  run ) const

private

Upgrades legacy sumdata::RunData in run to geometry information (returns null pointer if no legacy information is present).

Definition at line 202 of file GeometryGArConfigurationWriter_service.cc.

{
  
  gar::sumdata::RunData const* runData = readRunData(run);
  return runData ? convertRunDataToGeometryInformation(*runData): InfoPtr_t{};
  
} // gar::geo::GeometryGArConfigurationWriter::makeInfoFromRunData()

static InfoPtr_t gar::geo::GeometryGArConfigurationWriter::makeInfoPtr ( gar::sumdata::GeometryConfigurationInfo const &  info )

inlinestaticprivate

Alias to std::make_unique<sumdata::GeometryConfigurationInfo>.

Definition at line 128 of file GeometryGArConfigurationWriter_service.cc.

{ return std::make_unique<gar::sumdata::GeometryConfigurationInfo>(info); }

void gar::geo::GeometryGArConfigurationWriter::postReadRun ( art::Run &  run )

overrideprivatevirtual

Writes the information from the service configuration into the run.

Reimplemented from art::ProducingService.

Definition at line 144 of file GeometryGArConfigurationWriter_service.cc.

                                                                  {
  
  InfoPtr_t confInfo = gar::geo::GeometryGArConfigurationWriter::loadInfo(run);
  
  if (!confInfo) confInfo = extractInfoFromGeometry();
  
  run.put(std::move(confInfo), art::fullRun());
  
} // gar::geo::GeometryGArConfigurationWriter::postReadRun()

auto gar::geo::GeometryGArConfigurationWriter::readGeometryInformation ( art::Run &  run ) const

private

Reads geometry information from the run (returns null pointer if none).

Definition at line 189 of file GeometryGArConfigurationWriter_service.cc.

{
  auto infoHandle = run.getHandle<gar::sumdata::GeometryConfigurationInfo>(art::InputTag{"GeometryGArConfigurationWriter"});
  if (infoHandle)
    {
      return makeInfoPtr(*infoHandle);
    }
  return InfoPtr_t{};

} // gar::geo::GeometryGArConfigurationWriter::hasGeometryInformation()

gar::sumdata::RunData const * gar::geo::GeometryGArConfigurationWriter::readRunData ( art::Run &  run ) const

private

Returns a pointer to the sumdata::RunData in run (nullptr if none).

Definition at line 212 of file GeometryGArConfigurationWriter_service.cc.

{
  auto allRunData = run.getMany<gar::sumdata::RunData>();

  return allRunData.empty() ? nullptr: allRunData.front().product();
} // gar::geo::GeometryGArConfigurationWriter::readRunData()

---

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

• garsoft/Geometry/GeometryGArConfigurationWriter_service.cc