recob::dumper Namespace Reference

Classes
struct	IndentOptions_t
	Structure collecting indentation options. More...
class	NewLine
	Starts a new line in a output stream. More...
struct	SpacePointPrintOptions_t
	Collection of available printing style options. More...

Functions
template<typename Stream >
NewLine< Stream >	makeNewLine (Stream &stream, std::string indent, bool followLine=false)
	Convenience function to create a temporary NewLine. More...
template<typename Stream >
NewLine< Stream >	makeNewLine (Stream &stream, IndentOptions_t const &options)
	Convenience function to create a temporary NewLine. More...
template<typename Stream , typename NewLineRef >
std::enable_if_t< std::is_same< recob::dumper::NewLine< std::decay_t< Stream > >, std::decay_t< NewLineRef > >::value >	DumpPCAxis (Stream &&out, recob::PCAxis const &pca, NewLineRef &&nl)
template<typename Stream >
void	DumpPCAxis (Stream &&out, recob::PCAxis const &pca, std::string indent="", bool indentFirst=true)
	Dumps the content of the specified PCA axis into a stream. More...
template<typename Stream , typename NewLineRef = recob::dumper::NewLine<Stream>>
auto	DumpSpacePoint (Stream &&out, recob::SpacePoint const &sp, SpacePointPrintOptions_t const &options={}) -> std::enable_if_t< std::is_same< NewLine< std::decay_t< Stream >>, std::decay_t< NewLineRef >>::value >
	Dumps the content of the specified space point into a stream. More...

Function Documentation

template<typename Stream , typename NewLineRef >

std::enable_if_t< std::is_same< recob::dumper::NewLine< std::decay_t< Stream > >, std::decay_t< NewLineRef > >::value > recob::dumper::DumpPCAxis	(	Stream &&	out,
		recob::PCAxis const &	pca,
		NewLineRef &&	nl
	)

Dumps the content of the specified PCA axis (indentation info in nl)

Template Parameters

Stream	the type of the output stream
NewLineRef	NewLine reference type (to get a universal reference)

Definition at line 68 of file PCAxisDumpers.h.

References recob::PCAxis::getAveHitDoca(), recob::PCAxis::getAvePosition(), recob::PCAxis::getEigenValues(), recob::PCAxis::getEigenVectors(), recob::PCAxis::getID(), recob::PCAxis::getNumHitsUsed(), recob::PCAxis::getSvdOK(), fhicl::detail::nl(), and art::right().

Referenced by DumpPCAxis().

{

  if (!pca.getSvdOK()) {
    nl() << "<not valid>";
    return;
  }

  nl() << std::setiosflags(std::ios::fixed) << std::setprecision(2) << " ID " << pca.getID()
       << " run on " << pca.getNumHitsUsed() << " space points";
  nl() << "  - center position: " << std::setw(6) << pca.getAvePosition()[0] << ", "
       << pca.getAvePosition()[1] << ", " << pca.getAvePosition()[2];
  nl() << "  - eigen values: " << std::setw(8) << std::right << pca.getEigenValues()[0] << ", "
       << pca.getEigenValues()[1] << ", " << pca.getEigenValues()[2];
  nl() << "  - average doca: " << pca.getAveHitDoca();
  nl() << "  - principle axis: " << std::setw(7) << std::setprecision(4)
       << pca.getEigenVectors()[0][0] << ", " << pca.getEigenVectors()[0][1] << ", "
       << pca.getEigenVectors()[0][2];
  nl() << "  - second axis: " << std::setw(7) << std::setprecision(4) << pca.getEigenVectors()[1][0]
       << ", " << pca.getEigenVectors()[1][1] << ", " << pca.getEigenVectors()[1][2];
  nl() << "  - third axis: " << std::setw(7) << std::setprecision(4) << pca.getEigenVectors()[2][0]
       << ", " << pca.getEigenVectors()[2][1] << ", " << pca.getEigenVectors()[2][2];

} // recob::dumper::DumpPCAxis()

template<typename Stream >

void recob::dumper::DumpPCAxis	(	Stream &&	out,
		recob::PCAxis const &	pca,
		std::string	indent = "",
		bool	indentFirst = true
	)

Dumps the content of the specified PCA axis into a stream.

---

Template Parameters

Stream

the type of output stream

Parameters

out	the output stream
pca	the principal component axis to be dumped
indent	indentation string (none by default)
indentFirst	whether to indent the first line (yes by default)

Insertion operators are required that insert into Stream basic types.

This function does not insert a end-of-line after its output.

Definition at line 48 of file PCAxisDumpers.h.

References DumpPCAxis(), art::detail::indent(), makeNewLine(), and value.

    {
      DumpPCAxis(std::forward<Stream>(out), pca, makeNewLine(out, indent, !indentFirst));
    }

template<typename Stream , typename NewLineRef = recob::dumper::NewLine<Stream>>

auto recob::dumper::DumpSpacePoint	(	Stream &&	out,
		recob::SpacePoint const &	sp,
		SpacePointPrintOptions_t const &	options = {}
	)		-> std::enable_if_t< std::is_same<NewLine<std::decay_t<Stream>>, std::decay_t<NewLineRef>>::value>

Dumps the content of the specified space point into a stream.

Template Parameters

Stream	the type of the output stream
NewLineRef	NewLine reference type (to get a universal reference)

Parameters

out	the output stream
sp	the space point to be dumped
options	indentation and formatting options

Definition at line 75 of file SpacePointDumpers.h.

References fhicl::detail::nl().

Referenced by recob::dumper::SpacePointPrintOptions_t::SpacePointPrintOptions_t().

{
  double const* pos = sp.XYZ();
  double const* err = sp.ErrXYZ();

  NewLineRef nl(out, options.indent);
  lar::OptionalHexFloat hexfloat(options.hexFloats);

  nl() << "ID=" << sp.ID() << " at (" << hexfloat(pos[0]) << ", " << hexfloat(pos[1]) << ", "
       << hexfloat(pos[2]) << ") cm, chi^2/NDF=" << hexfloat(sp.Chisq());

  nl() << "variances { x^2=" << hexfloat(err[0]) << " y^2=" << hexfloat(err[2])
       << " z^2=" << hexfloat(err[5]) << " xy=" << hexfloat(err[1]) << " xz=" << hexfloat(err[3])
       << " yz=" << hexfloat(err[4]) << " }";

} // recob::dumper::DumpSpacePoint()

template<typename Stream >

NewLine<Stream> recob::dumper::makeNewLine ( Stream &  stream, std::string  indent, bool  followLine = false  )

inline

Convenience function to create a temporary NewLine.

Definition at line 148 of file NewLine.h.

References recob::dumper::IndentOptions_t::indent.

Referenced by DumpPCAxis().

    {
      return NewLine<Stream>(stream, indent, followLine);
    }

template<typename Stream >

NewLine<Stream> recob::dumper::makeNewLine ( Stream &  stream, IndentOptions_t const &  options  )

inline

Convenience function to create a temporary NewLine.

Definition at line 155 of file NewLine.h.

    {
      return NewLine<Stream>(stream, options);
    }