Struct astrea::trace::RiseSetStats

ClassList > astrea > trace > RiseSetStats

The RiseSetStats struct represents statistics for rise and set times based on aRiseSetArray and a RiseSetMetric.More...

• #include <RiseSetStats.hpp>

Public Functions

Type	Name
	RiseSetStats () = default Default constructor for RiseSetStats .
	RiseSetStats (const RiseSetArray & risesets) Constructs a RiseSetStats object from aRiseSetArray and a RiseSetMetric.
const auto &	at (const RiseSetMetric & metric) const Accesses the statistics for a given RiseSetMetric.
auto &	operator[] (const RiseSetMetric & metric) Accesses the statistics for a given RiseSetMetric.
std::vector< std::string >	to_string_vector () const Converts the statistics to a vector of strings for output.

Detailed Description

It contains a map of RiseSetMetric to Stats<Time>, which holds the calculated statistics for each metric (GAP and ACCESS_TIME).

Public Functions Documentation

function RiseSetStats [1/2]

Default constructor for RiseSetStats .

astrea::trace::RiseSetStats::RiseSetStats () = default

---

function RiseSetStats [2/2]

Constructs a RiseSetStats object from aRiseSetArray and a RiseSetMetric.

astrea::trace::RiseSetStats::RiseSetStats (
    const RiseSetArray & risesets
) 

Parameters:

• risesets The RiseSetArray containing the rise and set times to calculate statistics for.

Exception:

• std::runtime_error If the RiseSetMetric is unrecognized.

---

function at

Accesses the statistics for a given RiseSetMetric.

inline const auto & astrea::trace::RiseSetStats::at (
    const RiseSetMetric & metric
) const

Parameters:

• metric The RiseSetMetric to access statistics for.

Returns:

const Stats<Time>& A reference to the Stats<Time> object containing the statistics for the given metric.

---

function operator[]

Accesses the statistics for a given RiseSetMetric.

inline auto & astrea::trace::RiseSetStats::operator[] (
    const RiseSetMetric & metric
) 

Parameters:

• metric The RiseSetMetric to access statistics for.

Returns:

Stats<Time>& A reference to the Stats<Time> object containing the statistics for the given metric.

---

function to_string_vector

Converts the statistics to a vector of strings for output.

std::vector< std::string > astrea::trace::RiseSetStats::to_string_vector () const

Returns:

std::vector<std::string> A vector of strings representing the statistics for each metric.

---

---

The documentation for this class was generated from the following file astrea/trace/trace/analysis/stats/RiseSetStats.hpp