Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | List of all members
ska::cheetah::rfim::Metrics Class Reference

A class for analysing and storing the results of the difference between two sets of flags representing RFI detection. More...

#include <cheetah/rfim/Metrics.h>

Collaboration diagram for ska::cheetah::rfim::Metrics:
Collaboration graph

Public Types

typedef data::TimeFrequencyFlags TimeFrequencyFlagsType
 

Public Member Functions

 Metrics (TimeFrequencyFlagsType const &expected, TimeFrequencyFlagsType const &actual)
 
std::size_t compare (TimeFrequencyFlagsType const &expected, TimeFrequencyFlagsType const &actual)
 calculate the metrics by comparing the two sets of flags
 
std::size_t num_correct () const
 return the total of any correctly identified flags found
 
std::size_t num_rfi () const
 return the number of rfi flags in the expected data
 
float rfi_detected_percentage () const
 return the total of any correct flags as a percentage
 
float correct_percentage () const
 return the total of any correct flags as a percentage
 
TimeFrequencyFlagsType const & false_positives () const
 returnn a set of flags indicating each false positive fopund
 
std::size_t num_false_positives () const
 return the total of any false positives detected
 
float false_positives_percentage () const
 
TimeFrequencyFlagsType const & false_negatives () const
 returnn a set of flags indicating each false negative found
 
std::size_t num_false_negatives () const
 return the number of any false negatives detected
 
float false_negatives_percentage () const
 

Detailed Description

A class for analysing and storing the results of the difference between two sets of flags representing RFI detection.

Definition at line 39 of file Metrics.h.


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