magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer Class Reference

Inheritance diagram for magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer:

Public Member Functions
	DD4hep_VolumeBasedMagneticFieldESProducer (const edm::ParameterSet &iConfig)
	DD4hep_VolumeBasedMagneticFieldESProducer (const DD4hep_VolumeBasedMagneticFieldESProducer &)=delete
const DD4hep_VolumeBasedMagneticFieldESProducer &	operator= (const DD4hep_VolumeBasedMagneticFieldESProducer &)=delete
std::unique_ptr< MagneticField >	produce (const IdealMagneticFieldRecord &iRecord)
Public Member Functions inherited from edm::ESProducer
	ESProducer ()
	ESProducer (const ESProducer &)=delete
ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const
ESRecordIndex const *	getTokenRecordIndices (unsigned int iIndex) const
bool	hasMayConsumes () const noexcept
size_t	numberOfTokenIndices (unsigned int iIndex) const
ESProducer const &	operator= (const ESProducer &)=delete
SerialTaskQueueChain &	queue ()
template<typename Record >
std::optional< std::vector< ESProxyIndex > >	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &) final
	~ESProducer () noexcept(false) override
Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()
	ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete
const ESProxyFactoryProducer &	operator= (const ESProxyFactoryProducer &)=delete
	~ESProxyFactoryProducer () noexcept(false) override
Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void	createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
	DataProxyProvider ()
	DataProxyProvider (const DataProxyProvider &)=delete
const ComponentDescription &	description () const
void	fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const
virtual void	initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
bool	isUsingRecord (const EventSetupRecordKey &key) const
KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)
const DataProxyProvider &	operator= (const DataProxyProvider &)=delete
void	setAppendToDataLabel (const edm::ParameterSet &)
void	setDescription (const ComponentDescription &iDescription)
std::set< EventSetupRecordKey >	usingRecords () const
virtual	~DataProxyProvider () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)

Private Attributes
const MagFieldConfig	conf_
edm::ESGetToken< cms::DDCompactView, IdealMagneticFieldRecord >	cpvToken_
const bool	debug_
edm::ESGetToken< MagneticField, IdealMagneticFieldRecord >	paramFieldToken_
edm::ParameterSet	pset_
const bool	useMergeFileIfAvailable_
const bool	useParametrizedTrackerField_
const std::string	version_

Additional Inherited Members
Protected Types inherited from edm::ESProxyFactoryProducer
using	EventSetupRecordKey = eventsetup::EventSetupRecordKey
Protected Types inherited from edm::eventsetup::DataProxyProvider
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>
Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &iLabel={})
template<typename T >
auto	setWhatProduced (T *iThis, const char *iLabel)
template<typename T >
auto	setWhatProduced (T *iThis, const std::string &iLabel)
template<typename T , typename TDecorator >
auto	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord , typename TArg >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})
template<typename TFunc >
auto	setWhatProduced (TFunc &&func, const es::Label &iLabel={})
template<typename TReturn , typename TRecord , typename TFunc , typename TDecorator >
ESConsumesCollectorT< TRecord >	setWhatProduced (TFunc &&func, TDecorator &&iDec, const es::Label &iLabel={})
void	usesResources (std::vector< std::string > const &)
Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())
virtual void	registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())
KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override
Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void	usingRecord ()
void	usingRecordWithKey (const EventSetupRecordKey &key)

Detailed Description

Definition at line 28 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Constructor & Destructor Documentation

DD4hep_VolumeBasedMagneticFieldESProducer() [1/2]

DD4hep_VolumeBasedMagneticFieldESProducer::DD4hep_VolumeBasedMagneticFieldESProducer

(

const edm::ParameterSet &

iConfig

)

Definition at line 55 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

    : pset_{iConfig},
      debug_{iConfig.getUntrackedParameter<bool>("debugBuilder", false)},
      useParametrizedTrackerField_{iConfig.getParameter<bool>("useParametrizedTrackerField")},
      useMergeFileIfAvailable_{iConfig.getParameter<bool>("useMergeFileIfAvailable")},
      conf_{iConfig, debug_},
      version_{iConfig.getParameter<std::string>("version")} {
  LogTrace("MagGeoBuilder") << "info:Constructing a DD4hep_VolumeBasedMagneticFieldESProducer";

  auto cc = setWhatProduced(this, iConfig.getUntrackedParameter<std::string>("label", ""));
  cpvToken_ = cc.consumes(edm::ESInputTag{"", "magfield"});
  if (useParametrizedTrackerField_) {
    paramFieldToken_ = cc.consumes(edm::ESInputTag{"", iConfig.getParameter<std::string>("paramLabel")});
  }
}

DD4hep_VolumeBasedMagneticFieldESProducer() [2/2]

magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::DD4hep_VolumeBasedMagneticFieldESProducer ( const DD4hep_VolumeBasedMagneticFieldESProducer &  )

delete

Member Function Documentation

fillDescriptions()

void DD4hep_VolumeBasedMagneticFieldESProducer::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 113 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

References edm::ParameterSetDescription::add(), edm::ConfigurationDescriptions::addDefault(), submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                           {
  edm::ParameterSetDescription desc;
  desc.addUntracked<bool>("debugBuilder", false);
  desc.add<bool>("useMergeFileIfAvailable", true);
  desc.add<bool>("useParametrizedTrackerField");
  desc.addUntracked<std::string>("label", "");
  desc.add<std::string>("version");
  desc.add<std::string>("paramLabel");

  //from MagFieldConfig
  desc.add<int>("geometryVersion");
  {
    edm::ParameterSetDescription sub;
    sub.add<std::string>("volumes");
    sub.add<std::string>("sectors");
    sub.add<int>("master");
    sub.add<std::string>("path");
    desc.addVPSet("gridFiles", sub);
  }
  desc.add<std::vector<int> >("scalingVolumes");
  desc.add<std::vector<double> >("scalingFactors");
  //default used to be compatible with older configurations
  desc.add<std::vector<double> >("paramData", std::vector<double>());

  descriptions.addDefault(desc);
}

operator=()

const DD4hep_VolumeBasedMagneticFieldESProducer& magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::operator= ( const DD4hep_VolumeBasedMagneticFieldESProducer &  )

delete

produce()

std::unique_ptr< MagneticField > DD4hep_VolumeBasedMagneticFieldESProducer::produce

(

const IdealMagneticFieldRecord &

iRecord

)

Definition at line 72 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

References magneticfield::MagGeoBuilder::barrelLayers(), magneticfield::MagGeoBuilder::barrelVolumes(), magneticfield::MagGeoBuilder::build(), conf_, cpvToken_, debug_, cms::DDCompactView::detector(), magneticfield::MagGeoBuilder::endcapSectors(), magneticfield::MagGeoBuilder::endcapVolumes(), MagFieldConfig::geometryVersion, edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::get(), edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::getTransientHandle(), MagFieldConfig::gridFiles, MagFieldConfig::keys, LogTrace, magneticfield::MagGeoBuilder::maxR(), magneticfield::MagGeoBuilder::maxZ(), paramFieldToken_, magneticfield::MagGeoBuilder::setGridFiles(), magneticfield::MagGeoBuilder::setScaling(), useMergeFileIfAvailable_, useParametrizedTrackerField_, MagFieldConfig::values, MagFieldConfig::version, and version_.

                                             {
  if (debug_) {
    LogTrace("MagGeoBuilder") << "DD4hep_VolumeBasedMagneticFieldESProducer::produce() " << version_;
  }

  MagGeoBuilder builder(conf_.version, conf_.geometryVersion, debug_, useMergeFileIfAvailable_);

  // Set scaling factors
  if (!conf_.keys.empty()) {
    builder.setScaling(conf_.keys, conf_.values);
  }

  // Set specification for the grid tables to be used.
  if (!conf_.gridFiles.empty()) {
    builder.setGridFiles(conf_.gridFiles);
  }

  auto cpv = iRecord.getTransientHandle(cpvToken_);
  const cms::DDCompactView* cpvPtr = cpv.product();
  const cms::DDDetector* det = cpvPtr->detector();
  builder.build(det);
  LogTrace("MagGeoBuilder") << "produce() finished build";

  // Get slave field (from ES)
  const MagneticField* paramField = nullptr;
  if (useParametrizedTrackerField_) {
    LogTrace("MagGeoBuilder") << "Getting MF for parametrized field";
    paramField = &iRecord.get(paramFieldToken_);
  }
  return std::make_unique<VolumeBasedMagneticField>(conf_.geometryVersion,
                                                    builder.barrelLayers(),
                                                    builder.endcapSectors(),
                                                    builder.barrelVolumes(),
                                                    builder.endcapVolumes(),
                                                    builder.maxR(),
                                                    builder.maxZ(),
                                                    paramField,
                                                    false);
}

Member Data Documentation

conf_

const MagFieldConfig magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::conf_

private

Definition at line 46 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

cpvToken_

edm::ESGetToken<cms::DDCompactView, IdealMagneticFieldRecord> magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::cpvToken_

private

Definition at line 49 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

debug_

const bool magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::debug_

private

Definition at line 43 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

paramFieldToken_

edm::ESGetToken<MagneticField, IdealMagneticFieldRecord> magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::paramFieldToken_

private

Definition at line 48 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

pset_

edm::ParameterSet magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::pset_

private

Definition at line 42 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

useMergeFileIfAvailable_

const bool magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::useMergeFileIfAvailable_

private

Definition at line 45 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

useParametrizedTrackerField_

const bool magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::useParametrizedTrackerField_

private

Definition at line 44 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

version_

const std::string magneticfield::DD4hep_VolumeBasedMagneticFieldESProducer::version_

private

Definition at line 47 of file DD4hep_VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().