RunningStats Class Reference

Public Member Functions
void	CreatePorts () override
void	CompleteStreamInfo () override
void	Preprocess (ProcessingContext &context) override
void	Process (ProcessingContext &context) override
Public Member Functions inherited from IProcessor
	IProcessor (ThreadPriority priority=PRIORITY_HIGH)
void	record_metrics (uint64_t sync, uint64_t work) noexcept
void	dump_benchmarks ()
const std::string	name () const
const std::string	type () const
unsigned int	n_input_ports () const
unsigned int	n_output_ports () const
const std::set< std::string >	input_port_names () const
const std::set< std::string >	output_port_names () const
bool	has_input_port (const std::string &port)
bool	has_output_port (const std::string &port)
virtual bool	issource () const
virtual bool	issink () const
virtual bool	isfilter () const
virtual bool	isautonomous () const
ThreadPriority	thread_priority () const
ThreadCore	thread_core () const
bool	running () const
YAML::Node	ExportYAML ()
void	checkNonvoluntaryContextSwitches ()

Protected Attributes
PortIn< TimeSeriesType< double > > *	data_in_port_
PortOut< TimeSeriesType< double > > *	data_out_port_
options::Measurement< double, false >	integration_time_
options::Bool	outlier_protection_ {false}
options::Double	outlier_zscore_
options::Double	outlier_half_life_ {2.0}
std::unique_ptr< dsp::algorithms::RunningMeanMAD >	stats_
Protected Attributes inherited from IProcessor
std::map< std::string, std::shared_ptr< std::ostream > >	streams_
std::vector< TimePoint >	test_source_timestamps_
options::OptionList	options_
options::OptionList	advanced_options_

Additional Inherited Members
Static Public Attributes inherited from IProcessor
static std::vector< TimingEntry > *	t_metrics = nullptr
static constexpr size_t	MAX_SAMPLES = 100000
Protected Member Functions inherited from IProcessor
void	create_file (const std::string &prefix, const std::string &variable_name, const std::string &extension="bin")
void	prepare_latency_test (ProcessingContext &context)
void	save_source_timestamps_to_disk (std::uint64_t n_timestamps)
template<typename TValue>
void	add_option (std::string name, TValue &value, std::string description="", bool required=false)
void	remove_option (const std::string &name)
template<typename DATATYPE>
PortOut< DATATYPE > *	create_output_port (std::string name, const typename DATATYPE::Parameters &parameters, const PortOutPolicy &policy)
template<typename DATATYPE>
PortOut< DATATYPE > *	create_output_port (const typename DATATYPE::Parameters &parameters, const PortOutPolicy &policy)
template<typename DATATYPE>
PortIn< DATATYPE > *	create_input_port (std::string name, const typename DATATYPE::Capabilities &capabilities, const PortInPolicy &policy)
template<typename DATATYPE>
PortIn< DATATYPE > *	create_input_port (const typename DATATYPE::Capabilities &capabilities, const PortInPolicy &policy)
IPortIn *	input_port (const std::string &port)
IPortOut *	output_port (const std::string &port)
IPortIn *	input_port (const PortAddress &address)
IPortOut *	output_port (const PortAddress &address)
ISlotIn *	input_slot (const SlotAddress &address)
ISlotOut *	output_slot (const SlotAddress &address)
template<typename T>
StaticState< T > *	create_static_state (std::string state, T default_value, bool shared=true, Permission external=Permission::WRITE, std::string description="")
template<typename T>
ProducerState< T > *	create_producer_state (std::string state, T default_value, bool cooperative=false, Permission external=Permission::READ, std::string description="")
template<typename T>
BroadcasterState< T > *	create_broadcaster_state (std::string state, T default_value, Permission external=Permission::NONE, std::string description="")
template<typename T>
FollowerState< T > *	create_follower_state (std::string state, T default_value, Permission external=Permission::NONE, std::string description="")
template<typename T>
ReadableState< T > *	create_readable_shared_state (const std::string &state, T default_value, Permission peers=Permission::WRITE, Permission external=Permission::NONE, std::string description="")
template<typename T>
WritableState< T > *	create_writable_shared_state (const std::string &state, T default_value, Permission peers=Permission::READ, Permission external=Permission::NONE, std::string description="")
std::shared_ptr< IState >	shared_state (const std::string &state)
template<class T>
void	expose_method (const std::string &methodname, YAML::Node(T::*method)(const YAML::Node &))
std::function< YAML::Node(const YAML::Node &)> &	exposed_method (const std::string &method)
virtual std::string	default_input_port () const
virtual std::string	default_output_port () const

Member Function Documentation

CompleteStreamInfo()

void RunningStats::CompleteStreamInfo ( )

overridevirtual

Reimplemented from IProcessor.

CreatePorts()

void RunningStats::CreatePorts ( )

overridevirtual

Implements IProcessor.

Preprocess()

void RunningStats::Preprocess ( ProcessingContext & context )

overridevirtual

Reimplemented from IProcessor.

Process()

void RunningStats::Process ( ProcessingContext & context )

overridevirtual

Implements IProcessor.

Member Data Documentation

integration_time_

options::Measurement<double, false> RunningStats::integration_time_

protected

Initial value:

{1., "second",
                                                          options::positive<double>(true)}

outlier_zscore_

options::Double RunningStats::outlier_zscore_

protected

Initial value:

{
        6.0,
    }

---

The documentation for this class was generated from the following files:

• extensions/falcon-fklab-extensions/processors/runningstats/runningstats.hpp
• extensions/falcon-fklab-extensions/processors/runningstats/runningstats.cpp