Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Static Public Attributes
SanitySimpleFilter Class Reference

SanitySimpleFilter helps making sanity tests on input data

The basic tests optional are:
(1) test that the signal actually exist in name (in the signals list in the repository)
(2) within a given window: minimal number of tests
(3) within a given window: maximal number of outliers
(4) count outliers within a given window
More...

#include <SampleFilter.h>

Inheritance diagram for SanitySimpleFilter:
SerializableObject

Public Member Functions

int init_from_string (const string &init_str)
 test the min number of instances left that are not outliers
 
int test_filter (MedSample &sample, MedRepository &rep)
 summary> Test filtering criteria
 
int test_filter (MedSample &sample, MedRepository &rep, int &nvals, int &noutliers)
 
- Public Member Functions inherited from SerializableObject
virtual int version () const
 Relevant for serializations.
 
virtual string my_class_name () const
 For better handling of serializations it is highly recommended that each SerializableObject inheriting class will implement the next method.
 
virtual void serialized_fields_name (vector< string > &field_names) const
 The names of the serialized fields.
 
virtual void * new_polymorphic (string derived_name)
 for polymorphic classes that want to be able to serialize/deserialize a pointer * to the derived class given its type one needs to implement this function to return a new to the derived class given its type (as in my_type)
 
virtual void pre_serialization ()
 
virtual void post_deserialization ()
 
virtual size_t get_size ()
 Gets bytes sizes for serializations.
 
virtual size_t serialize (unsigned char *blob)
 Serialiazing object to blob memory. return number ob bytes wrote to memory.
 
virtual size_t deserialize (unsigned char *blob)
 Deserialiazing blob to object. returns number of bytes read.
 
size_t serialize_vec (vector< unsigned char > &blob)
 
size_t deserialize_vec (vector< unsigned char > &blob)
 
virtual size_t serialize (vector< unsigned char > &blob)
 
virtual size_t deserialize (vector< unsigned char > &blob)
 
virtual int read_from_file (const string &fname)
 read and deserialize model
 
virtual int write_to_file (const string &fname)
 serialize model and write to file
 
virtual int read_from_file_unsafe (const string &fname)
 read and deserialize model without checking version number - unsafe read
 
int init_from_string (string init_string)
 Init from string.
 
int init_params_from_file (string init_file)
 
int init_param_from_file (string file_str, string &param)
 
virtual int init (map< string, string > &map)
 Virtual to init object from parsed fields.
 
int update_from_string (const string &init_string)
 
virtual int update (map< string, string > &map)
 Virtual to update object from parsed fields.
 
virtual string object_json () const
 

Data Fields

string sig_name
 Name of signal to filter by.
 
int win_from = 0
 Time window for deciding on filtering - start.
 
int win_to = (int)(1 << 30)
 Time window for deciding on filtering - end.
 
float min_val = -1e10
 Allowed values range for signal - minimum.
 
float max_val = 1e10
 Allowed values range for signal - maximum.
 
int min_Nvals = -1
 
int max_Nvals = -1
 Required number of instances of signal within time window.
 
int time_channel = 0
 Maximal allowed number of instances of signal within time window.
 
int val_channel = 0
 signal value channel to consider
 
int max_outliers = -1
 maximla allowed number of outliers. -1 means don't do the max_outliers test
 
int win_time_unit = MedTime::Days
 time unit to be used
 
int samples_time_unit = MedTime::Date
 time unit to be used
 
unordered_set< float > allowed_values
 
int values_in_dictionary = 0
 list of allowed values for the signal
 
int min_left = -1
 flag: if 1: make sure all given values are valid - that is are in the signal dictionary.
 

Static Public Attributes

static const int Passed = 0
 
static const int Failed = 1
 
static const int Signal_Not_Valid = 2
 
static const int Failed_Min_Nvals = 3
 
static const int Failed_Max_Nvals = 4
 
static const int Failed_Outliers = 5
 
static const int Failed_Age = 6
 
static const int Failed_Age_No_Byear = 7
 
static const int Failed_Allowed_Values = 8
 
static const int Failed_Dictionary_Test = 9
 
static const int Failed_Not_Enough_Non_Outliers_Left = 10
 

Detailed Description

SanitySimpleFilter helps making sanity tests on input data

The basic tests optional are:
(1) test that the signal actually exist in name (in the signals list in the repository)
(2) within a given window: minimal number of tests
(3) within a given window: maximal number of outliers
(4) count outliers within a given window

Member Function Documentation

◆ init_from_string()

int SanitySimpleFilter::init_from_string ( const string &  init_str)

test the min number of instances left that are not outliers

init from mapped string summary> Test filtering criteria returns> 1 if passing and 0 otherwise

◆ test_filter()

int SanitySimpleFilter::test_filter ( MedSample sample,
MedRepository rep 
)
inline

summary> Test filtering criteria

returns> 1 if passing and 0 otherwise

Field Documentation

◆ time_channel

int SanitySimpleFilter::time_channel = 0

Maximal allowed number of instances of signal within time window.

signal time-channel to consider


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