icarus::opdet::CustomPulseFunctionTool Struct Reference

Creates a CustomPulseFunction pulse shape. More...

Inheritance diagram for icarus::opdet::CustomPulseFunctionTool:

Classes
struct	Config
	Configuration parameters. More...

Public Types
using	Parameters = art::ToolConfigTable< Config >
	Tool parameter configuration. More...
Public Types inherited from icarus::opdet::SinglePhotonPulseFunctionTool
using	nanoseconds = util::quantities::nanosecond
	Convenience definition for time stored in nanoseconds. More...
using	PulseFunction_t = icarus::opdet::PhotoelectronPulseFunction< nanoseconds >
	Type of function returned. More...

Public Member Functions
	CustomPulseFunctionTool (Parameters const &config)
	Constructor: sets the configuration. More...
Public Member Functions inherited from icarus::opdet::SinglePhotonPulseFunctionTool
virtual	~SinglePhotonPulseFunctionTool ()=default
std::unique_ptr< PulseFunction_t >	getPulseFunction ()
	Returns an instance of the pulse function. More...

Private Member Functions
virtual std::unique_ptr < PulseFunction_t >	doGetPulseFunction () override
	Returns the function that was created at construction time. More...

Static Private Member Functions
static std::unique_ptr < PulseFunction_t >	makePulseFunction (Config const &config)
	Creates and returns a pulse function with the specified configuration. More...

Private Attributes
std::unique_ptr< PulseFunction_t >	fPulseFunction
	Function stored while waiting to be delivered. More...

Detailed Description

Creates a CustomPulseFunction pulse shape.

See Also

icarus::opdet::SinglePhotonPulseFunctionTool

This tool creates a icarus::opdet::CustomPulseFunction<nanosecond> function to describe an arbitrary pulse shape.

See icarus::opdet::CustomPulseFunction for the details of the function.

Configuration

Run lar --print-description CustomPulseFunctionTool (or read Config data structure) for a short explanation of the meaning of the parameters.

• ShapeFormula (string, mandatory): an expression for the pulse shape; for example: [A] * exp(-0.5*((x - [mu])/(sqrt2*[sigma]))**2) is an extended way to describe a Gaussian pulse; the syntax is mostly C++ with a few ROOT extensions (see ROOT 6 TFormula documentation); x variable represents the time in nanoseconds, with x = 0 the time of emission of the photoelectron;
• PeakTime (string, mandatory): evaluates to the time at which the pulse has its peak, in nanoseconds; the format can be an expression in the same fashion as ShapeFormula and it can use any of the parameters in ShapeFormula, but no extra parameters and with no variable, for example [mu] for the Gaussian pulse peak; or it can be a time, for example 55.1 ns;
• Parameters (string): a table with one entry for each parameter of the pulse shape, and their numerical value (no unit is used); for example, mu: 55.1 sigma: 2.4 A: -10.1 sets the parameters of the Gaussian shape in the previous example. This parameter must contain one entry for each parameter in ShapeFormula and no extra values; if ShapeFormula has no parameters, the Parameters table can be omitted.

Note

Because of the limitations of FHiCL language in Parameters specification, the names of the parameters need to be simple (e.g. [mu] rather than [mu]).

Definition at line 77 of file CustomPulseFunctionTool_tool.cc.

Member Typedef Documentation

using icarus::opdet::CustomPulseFunctionTool::Parameters = art::ToolConfigTable<Config>

Tool parameter configuration.

Definition at line 106 of file CustomPulseFunctionTool_tool.cc.

Constructor & Destructor Documentation

icarus::opdet::CustomPulseFunctionTool::CustomPulseFunctionTool ( Parameters const &  config )

inline

Constructor: sets the configuration.

Definition at line 109 of file CustomPulseFunctionTool_tool.cc.

    : fPulseFunction(makePulseFunction(config())) {}

Member Function Documentation

virtual std::unique_ptr<PulseFunction_t> icarus::opdet::CustomPulseFunctionTool::doGetPulseFunction ( )

inlineoverrideprivatevirtual

Returns the function that was created at construction time.

Implements icarus::opdet::SinglePhotonPulseFunctionTool.

Definition at line 118 of file CustomPulseFunctionTool_tool.cc.

    { return std::move(fPulseFunction); }

auto icarus::opdet::CustomPulseFunctionTool::makePulseFunction ( Config const &  config )

staticprivate

Creates and returns a pulse function with the specified configuration.

Definition at line 139 of file CustomPulseFunctionTool_tool.cc.

{
  
  using MyFunction_t = icarus::opdet::CustomPulseFunction<nanoseconds>;
  
  std::string const& expression = config.ShapeFormula();
  
  // collect the parameters
  fhicl::ParameterSet configuredParameters; // will stay empty if not present
  config.Parameters.get_if_present(configuredParameters);
  MyFunction_t::PulseParameters_t parameters;
  for (auto const& parName: configuredParameters.get_names())
    parameters.emplace_back(parName, configuredParameters.get<double>(parName));
  
  std::string const& peakTimeStr = config.PeakTime();
  
  try {
    // try to convert `peakTimeStr` into a nanosecond quantity
    return std::make_unique<MyFunction_t>(
      expression,
      parameters,
      util::quantities::makeQuantity<nanoseconds>(peakTimeStr, true)
      );
  }
  catch (util::quantities::ValueError const&) {}
  catch (util::quantities::ExtraCharactersError const&) {}
  
  mf::LogDebug("CustomPulseFunctionTool")
    << "Parameter PeakTime ('" << peakTimeStr
    << "') does not seem to be a nanosecond quantity; will try as formula."
    ;
  
  return std::make_unique<MyFunction_t>(expression, parameters, peakTimeStr);
  
} // icarus::opdet::CustomPulseFunctionTool::makePulseFunction()

Member Data Documentation

std::unique_ptr<PulseFunction_t> icarus::opdet::CustomPulseFunctionTool::fPulseFunction

private

Function stored while waiting to be delivered.

Definition at line 124 of file CustomPulseFunctionTool_tool.cc.

---

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

• CustomPulseFunctionTool_tool.cc