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

BasicSimpleFilter is a general filter to allow the following basics:
(1) min and max time of outcomeTime
(2) option to allow for a signal to be in some given range (if there is a sample in some given window)
(3) option to force N samples of a specific signal within the given range (in the given time window)
More...

#include <SampleFilter.h>

Inheritance diagram for BasicSampleFilter:
SampleFilter SerializableObject

Public Member Functions

int init (map< string, string > &mapper)
 initialize from a map : Should be implemented for inheriting classes that have parameters
 
void get_required_signals (vector< string > &req_sigs)
 Get all signals required for filtering.
 
int _filter (MedRepository &rep, MedSamples &inSamples, MedSamples &outSamples)
 Filter with repository.
 
int _filter (MedSamples &inSamples, MedSamples &outSamples)
 Filter without repository.
 
- Public Member Functions inherited from SampleFilter
virtual int init (void *params)
 initialize from a params object : Should be implemented for inheriting classes that have parameters
 
virtual void init_defaults ()
 initialize to default values : Should be implemented for inheriting classes that have parameters
 
virtual int _learn (MedRepository &rep, MedSamples &samples)
 learn with repository : Should be implemented for inheriting classes that learn parameters using Repository information
 
virtual int _learn (MedSamples &samples)
 learn without repository : Should be implemented for inheriting classes that learn parameters
 
virtual int learn (MedRepository &rep, MedSamples &samples)
 learn with repository
 
virtual int learn (MedSamples &samples)
 learn without repository
 
virtual int filter (MedRepository &rep, MedSamples &inSamples, MedSamples &outSamples)
 filter with repository
 
int filter (MedRepository &rep, MedSamples &samples)
 in-place filtering with repository
 
virtual int filter (MedSamples &inSamples, MedSamples &outSamples)
 filter without repository : Should be implemented for all inheriting classes
 
int filter (MedSamples &samples)
 in-place filtering without repository
 
virtual void * new_polymorphic (string derived_class_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)
 
size_t get_filter_size ()
 get size of filter + filter_type
 
size_t filter_serialize (unsigned char *blob)
 seialize filter + filter_type
 
- 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 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)
 
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

int min_sample_time = 0
 minimal allowed time (should always be given in the samples' time-unit)
 
int max_sample_time = (int)(1<<30)
 maximal allowed time (should always be given in the samples' time-unit)
 
vector< BasicFilteringParamsbfilters
 vector of filters to apply
 
int min_bfilter = -1
 -1: force each bfilter to pass , other n : at least n bfilters must pass
 
int winsTimeUnit = MedTime::Days
 time unit to be used
 
vector< string > req_sigs
 useful to load the repository needed for this filter
 
- Data Fields inherited from SampleFilter
SampleFilterTypes filter_type
 The type of the filter.
 

Additional Inherited Members

- Static Public Member Functions inherited from SampleFilter
static SampleFiltermake_filter (string name)
 create a new sample filter from name
 
static SampleFiltermake_filter (SampleFilterTypes type)
 create a new sample filter from type
 
static SampleFiltermake_filter (string name, string params)
 create a new sample filter from name and a parameters string
 
static SampleFiltermake_filter (SampleFilterTypes type, string params)
 create a new sample filter from type and a parameters string
 

Detailed Description

BasicSimpleFilter is a general filter to allow the following basics:
(1) min and max time of outcomeTime
(2) option to allow for a signal to be in some given range (if there is a sample in some given window)
(3) option to force N samples of a specific signal within the given range (in the given time window)

Member Function Documentation

◆ _filter() [1/2]

int BasicSampleFilter::_filter ( MedRepository rep,
MedSamples inSamples,
MedSamples outSamples 
)
virtual

Filter with repository.

Reimplemented from SampleFilter.

◆ _filter() [2/2]

int BasicSampleFilter::_filter ( MedSamples inSamples,
MedSamples outSamples 
)
virtual

Filter without repository.

Returns
-1 if repository is required, 0 othereise (when bfilters is empty)

Implements SampleFilter.

◆ get_required_signals()

void BasicSampleFilter::get_required_signals ( vector< string > &  req_sigs)
virtual

Get all signals required for filtering.

Reimplemented from SampleFilter.

◆ init()

int BasicSampleFilter::init ( map< string, string > &  mapper)
virtual

initialize from a map : Should be implemented for inheriting classes that have parameters

Reimplemented from SampleFilter.

Field Documentation

◆ req_sigs

vector<string> BasicSampleFilter::req_sigs

useful to load the repository needed for this filter

summary> init from mapped string


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