Belle2::HTML Namespace Reference

return information on objects in a nice format. More...

Functions
std::string	getString (const TMatrixFBase &matrix, int precision=2, bool color=true)
	get HTML table representing a matrix.
std::string	getString (const TMatrixDBase &matrix, int precision=2, bool color=true)
	get HTML table representing a matrix (double precision).
std::string	getString (const ROOT::Math::XYZVector &vec, int precision=2)
	get a string with vector coordinates: (x, y, z).
std::string	getStringConvertToUnit (const ROOT::Math::XYZVector &vec, int precision=2, const std::string &unitType="cm")
	get a string with vector coordinates: (x, y, z).
std::string	chooseUnitOfLength (const ROOT::Math::XYZVector &vec)
	get a string with a unit type to convert a vector, so that it is easily readable.
std::string	getHexDump (const int *buf, int length)
	Create hexdump of given buffer.
std::string	htmlToPlainText (const std::string &html)
	Reformat given HTML string into terminal-friendly plain text.
std::string	escape (const std::string &str)
	Convert &, <, > etc.
std::string	unescape (const std::string &str)
	inverse of escape()

Detailed Description

return information on objects in a nice format.

See also

RelationsObject::getInfoHTML()

Function Documentation

chooseUnitOfLength()

std::string chooseUnitOfLength

(

const ROOT::Math::XYZVector &

vec

)

get a string with a unit type to convert a vector, so that it is easily readable.

valid unit types are (um, cm) for now. the maximum of the vector entries defines the unit.

Definition at line 102 of file HTML.cc.

{
  double xyz [3];
  std::string unitType;
  vec.GetCoordinates(xyz);
  double max = 0;
 
  for (auto entry : xyz)
    if (std::abs(entry) > max)
      max = std::abs(entry);
 
  // choose specific range for that the unit is useful
  if (max < 0.1)
    unitType = "um";
  else
    unitType = "cm";
  return unitType;
}

escape()

std::string escape

(

const std::string &

str

)

Convert &, <, > etc.

to entities. (not a complete list!)

Definition at line 159 of file HTML.cc.

{
  std::string tmp = str;
  replace_all(tmp, "&", "&"); //must be first
  replace_all(tmp, ">", ">");
  replace_all(tmp, "<", "&lt;");
  replace_all(tmp, "\"", "&quot;");
  return tmp;
}

getHexDump()

std::string getHexDump	(	const int *	buf,
		int	length
	)

Create hexdump of given buffer.

Parameters

buf	the buffer
length	size of buf in 32bit words

Definition at line 121 of file HTML.cc.

{
  std::stringstream stream;
  stream << "<small><tt>";
  char str[10];
  //print everything in blocks of 4 bytes, 4 blocks per line
  for (int i = 0; i < length; i++) {
    //byte = 2letters
    //4byte = 8 letters
    snprintf(str, sizeof(str), "%08x ", buf[i]);
    stream << str;
  }
  stream << "</tt></small>";
  return stream.str();
}

getString() [1/3]

std::string getString	(	const ROOT::Math::XYZVector &	vec,
		int	precision = 2
	)

get a string with vector coordinates: (x, y, z).

(uses fixed-length output).

Parameters

vec	the vector to be printend
precision	The amount of digits to use

Definition at line 76 of file HTML.cc.

{
  std::stringstream stream;
  stream.precision(precision);
 
  stream << std::fixed << "(" << vec.X() << ", " <<  vec.Y() << ", " <<  vec.Z() << ")";
  return stream.str();
}

getString() [2/3]

std::string getString	(	const TMatrixDBase &	matrix,
		int	precision = 2,
		bool	color = true
	)

get HTML table representing a matrix (double precision).

Parameters

matrix	The matrix to be represented
precision	The amount of significant digits to use
color	If true, vary background colour depending on value.

Definition at line 36 of file HTML.cc.

{
  std::stringstream stream;
  stream.precision(precision);
 
  stream << "<table padding=0>";
  const double max = matrix.Max();
  const double min = matrix.Min();
  for (int i = 0; i < matrix.GetNrows(); i++) {
    stream << "<tr>";
    for (int k = 0; k < matrix.GetNcols(); k++) {
      const double value = matrix(i, k);
      stream << "<td align=right";
      if (color and value != 0.0) {
        //0 white, min cyan, max red
        int b = 255;
        int r = 255;
        int g = 255;
        if (value > 0)
          b = g = 255 - 180 * value / max;
        else
          r = 255 - 200 * value / min;
 
        stream << " bgcolor=" << std::setfill('0') << std::hex;
        stream << std::setw(2) << r;
        stream << std::setw(2) << g;
        stream << std::setw(2) << b;
        stream << std::dec << std::setfill(' ');
      }
      stream << ">" << std::setw(11) << value;
      stream << "</td>";
    }
    stream << "</tr>";
  }
  stream << "</table>";
  stream << "<br>";
 
  return stream.str();
}

getString() [3/3]

std::string getString	(	const TMatrixFBase &	matrix,
		int	precision = 2,
		bool	color = true
	)

get HTML table representing a matrix.

Parameters

matrix	The matrix to be represented
precision	The amount of significant digits to use
color	If true, vary background colour depending on value.

Definition at line 24 of file HTML.cc.

{
  const int nr = matrix.GetNrows();
  const int nc = matrix.GetNcols();
 
  TMatrixD matrix_double(nr, nc);
  for (int ir = 0; ir < nr; ir++)
    for (int ic = 0; ic < nc; ic++)
      matrix_double(ir, ic) = matrix(ir, ic);
  return getString(matrix_double, precision, color);
}

getStringConvertToUnit()

std::string getStringConvertToUnit	(	const ROOT::Math::XYZVector &	vec,
		int	precision = 2,
		const std::string &	unitType = "cm"
	)

get a string with vector coordinates: (x, y, z).

(uses fixed-length output). converts floating point value from standard framework unit to given unit.

Parameters

vec	the vector to be printend
precision	The amount of digits to use
unitType	Defines the unit to convert the vector values from standard framework unit.

Definition at line 85 of file HTML.cc.

{
  std::stringstream stream;
  stream.precision(precision);
  std::string displayedUnitType = unitType;
 
  if (unitType == "um")
    displayedUnitType = "\x0b5m";
 
 
  stream << std::fixed << "(" << Unit::convertValueToUnit(vec.X(), unitType) << ", "
         <<  Unit::convertValueToUnit(vec.Y(), unitType) << ", " <<  Unit::convertValueToUnit(vec.Z(), unitType)
         << ") " << displayedUnitType;
 
 
  return stream.str();
}

htmlToPlainText()

std::string htmlToPlainText

(

const std::string &

html

)

Reformat given HTML string into terminal-friendly plain text.

Definition at line 138 of file HTML.cc.

{
  std::string tmp = html;
  //conversions to plaintext
  replace_all(tmp, "<br>", "\n");
  replace_all(tmp, "</p>", "\n");
  replace_all(tmp, "</tr>", "\n");
  replace_all(tmp, "&nbsp;", " ");
 
  //remove non-ascii \mu
  replace_all(tmp, "\x0b5", "u");
 
  //remove all unknown tags (non-greedy match)
  const static std::regex tagRegex("<.*?>");
  tmp = std::regex_replace(tmp, tagRegex, "");
 
  tmp = unescape(tmp);
 
  return tmp;
}

unescape()

std::string unescape

(

const std::string &

str

)

inverse of escape()

Definition at line 169 of file HTML.cc.

{
  std::string tmp = str;
  //replace entities (important ones at least)
  replace_all(tmp, """, "\"");
  replace_all(tmp, ">", ">");
  replace_all(tmp, "&lt;", "<");
  replace_all(tmp, "&amp;", "&"); //must be last
  return tmp;
}