Distribution-Based Outlier Removal.
- See also
- uip_blmisc_rowsout_distr.m
Definition at line 4 of file blmisc_rowsout_distr.m.
|
| function | blmisc_rowsout_distr (in o) |
| |
| function | draw_histogram (in o) |
| |
| function | get_distrboolmap (in o, in x) |
| | Returns a vector that flags whether each bin goes or not. More...
|
| |
| function | get_idx_50plus (in o, in x) |
| |
| function | calculate_map (in o, in data) |
| |
| function | calculate_distances (in o, in data) |
| |
| function | calculate_ranges (in o, in data) |
| | Abstract. More...
|
| |
| function | calculate_hits (in o) |
| | Calculates edges and hist properties. Dependant on calling calculate_distances() first. More...
|
| |
| function | get_grades (in o, in params) |
| | Abstract. Method to get the per-feature grades. BMTool stuff. More...
|
| |
| function | get_gradeslegend (in o, in params) |
| | Abstract. Method to get block title based on passed parameters. BMTool stuff. More...
|
| |
| function | use (in o, in data) |
| | Applies block to data. More...
|
| |
| function | train (in o, in data, in varargin) |
| | Trains block. More...
|
| |
| function | boot (in o) |
| | Configures the structure to deal with new type of data. More...
|
| |
| function | get_description (in o, in flag_short) |
| |
| function | setbatch (in o, in params) |
| | Sets several properties of an object at once. More...
|
| |
| function | get_methodname (in o, in flag_short) |
| |
| function | get_report (in o) |
| | Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication. More...
|
| |
| function | get_html (in o, in flag_stylesheet) |
| |
| function | get_params (in o, in data) |
| | Calls Parameters GUI. More...
|
| |
| function | extract_log (in o) |
| |
| function | get_ancestry (in o, in flag_title) |
| |
|
| Property | threshold |
| |
| Property | quantile |
| | =0. Range filter: 0-none; 1-left quantile; 2-right quantile More...
|
| |
| Property | flag_trim_tail |
| |
| Property | idx_fea |
| | =1. Index of feature to consider More...
|
| |
| Property | no_bins |
| | Number of bins for histogram calculation. More...
|
| |
| Property | ranges |
| | [no_ranges][2] matrix. Univariate outlier removal is range-based. Descendants may have different ways to fill in this property. More...
|
| |
| Property | flag_mark_only |
| | =1. Whether to mark outliers class as -2, or else to generate two datasets in the output. More...
|
| |
| Property | title |
| |
| Property | color |
| |
| function blmisc_rowsout_distr::blmisc_rowsout_distr |
( |
in |
o | ) |
|
| function block::boot |
( |
in |
o | ) |
|
|
inherited |
Configures the structure to deal with new type of data.
Booting accounts for clearing any recordings; model structure; stored data etc from the object so that it can be re-used anew.
| function blmisc_rowsout_uni::calculate_distances |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
inherited |
| function blmisc_rowsout_uni::calculate_hits |
( |
in |
o | ) |
|
|
inherited |
| function blmisc_rowsout_uni::calculate_map |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
inherited |
| function blmisc_rowsout_uni::calculate_ranges |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
inherited |
| function block::do_boot |
( |
in |
o | ) |
|
|
protectedinherited |
Boots the block.
Abstract. Booting accounts for clearing any recordings; model structure; stored data etc from the object so that it can be re-used anew.
| function irobj::do_get_html |
( |
in |
o | ) |
|
|
protectedinherited |
Abstract. HTML inner body.
| function irobj::do_get_report |
( |
in |
o | ) |
|
|
protectedinherited |
| function blmisc_rowsout::do_train |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protectedinherited |
| function blmisc_rowsout::do_use |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protectedinherited |
| function blmisc_rowsout_distr::draw_histogram |
( |
in |
o | ) |
|
| function blmisc_rowsout_distr::draw_thresholds |
( |
in |
o | ) |
|
|
protected |
| function irobj::extract_log |
( |
in |
o | ) |
|
|
inherited |
- Parameters
-
- Returns
- [o, log]
| function irobj::get_ancestry |
( |
in |
o, |
|
|
in |
flag_title |
|
) |
| |
|
inherited |
| function irobj::get_description |
( |
in |
o, |
|
|
in |
flag_short |
|
) |
| |
|
inherited |
Returns description string
Precedence according with flag_short:
- 0: title > short > classtitle
- 1: short > title > classtitle
- Parameters
-
| flag_short=0 | I am sealing this to make sure that no class will try to improvise on this function. |
| function blmisc_rowsout_distr::get_distrboolmap |
( |
in |
o, |
|
|
in |
x |
|
) |
| |
Returns a vector that flags whether each bin goes or not.
| function block::get_grades |
( |
in |
o, |
|
|
in |
params |
|
) |
| |
|
inherited |
Abstract. Method to get the per-feature grades. BMTool stuff.
| function block::get_gradeslegend |
( |
in |
o, |
|
|
in |
params |
|
) |
| |
|
inherited |
Abstract. Method to get block title based on passed parameters. BMTool stuff.
| function irobj::get_html |
( |
in |
o, |
|
|
in |
flag_stylesheet |
|
) |
| |
|
inherited |
- Parameters
-
| flag_stylesheet=1 | Whether to include the stylesheet in the HTML |
| function blmisc_rowsout_uni::get_idx_50plus |
( |
in |
o, |
|
|
in |
x |
|
) |
| |
|
inherited |
| function irobj::get_methodname |
( |
in |
o, |
|
|
in |
flag_short |
|
) |
| |
|
inherited |
This is used only to compose sequence string e.g. xxx->yyy->zzz
- Parameters
-
| function irobj::get_params |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
inherited |
Calls Parameters GUI.
If flag_params, tries uip_<class>.m. If fails, tries uip_<ancestor>.m and so on
| function irobj::get_report |
( |
in |
o | ) |
|
|
inherited |
Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication.
| function irobj::setbatch |
( |
in |
o, |
|
|
in |
params |
|
) |
| |
|
inherited |
Sets several properties of an object at once.
- Parameters
-
| o | |
| params | Cell followint the pattern{'property1', value1, 'property2', value2, ...} |
| function block::train |
( |
in |
o, |
|
|
in |
data, |
|
|
in |
varargin |
|
) |
| |
|
inherited |
| function block::use |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
inherited |
| Property irobj::classtitle |
|
protectedinherited |
Class Title. Should have a descriptive name, as short as possible.
Definition at line 50 of file irobj.m.
=[0, .8, 0]. multipurpose feature, routines may use it for different things. Major use is to change the background of objtool and blockmenu. See also classes_html.m
Definition at line 42 of file irobj.m.
| Property blmisc_rowsout_uni::distances |
|
protectedinherited |
| Property blmisc_rowsout_uni::edges |
|
protectedinherited |
| Property block::flag_bootable |
|
protectedinherited |
=0. (High-Level setting and internal function) Whether or not the block is bootable.
Definition at line 14 of file block.m.
| Property block::flag_booted |
|
protectedinherited |
=0. Set to 1 by boot() after booting the block
Definition at line 69 of file block.m.
| Property block::flag_fixednf |
|
protectedinherited |
=1. (internal function) If true, dataset number of features will be checked upon training and using. Ignored if o.flag_trainable is 0.
Definition at line 28 of file block.m.
| Property block::flag_fixedno |
|
protectedinherited |
=0. (internal function) If true, dataset number of observations will be checked upon training and using. Ignored if o.flag_trainable is 0.
Definition at line 31 of file block.m.
| Property block::flag_incrtrain |
|
protectedinherited |
=0. (internal function). Whether or not the block accepts incremental training. The meaning is:
- If YES, it means that the block can adapt/evolve everytime its train() method is called
- If NO, the block can be trained only once, and calling its train() method many times can lead to unpredictable results
Definition at line 23 of file block.m.
| Property blmisc_rowsout::flag_mark_only |
|
inherited |
=1. Whether to mark outliers class as -2, or else to generate two datasets in the output.
Definition at line 25 of file blmisc_rowsout.m.
| Property block::flag_multiin |
|
protectedinherited |
=0. (High-Level setting (gencode)) Whether block allows/expects multiple objects as input.
Definition at line 35 of file block.m.
=1. (High-Level setting (gencode)) Whether the block generates any output at all (counterexample: vis blocks)
Definition at line 38 of file block.m.
| Property irobj::flag_params |
|
protectedinherited |
=1. (GUI setting) Whether to call a GUI when the block is selected in blockmenu.m . If true, a routine called "uip_"<class name> will be called.
Definition at line 57 of file irobj.m.
| Property block::flag_train_inliers_only |
|
protectedinherited |
| Property block::flag_train_require_inliers |
|
protectedinherited |
=1. If true, train() will give an error if the dataset has outliers. This is true by default, because the developer should be aware of outliers being inputted into a training algorithm.
Definition at line 51 of file block.m.
| Property block::flag_trainable |
|
protectedinherited |
=0. (High-Level + internal function). Whether or not the block can be trained, or completely non-data-based.
Definition at line 17 of file block.m.
| Property block::flag_trained |
|
protectedinherited |
=0. Set to 1 by train() if training is successful; set back to 0 after booting.
Definition at line 66 of file block.m.
| Property blmisc_rowsout_distr::flag_trim_tail |
=0. Activates "tail trimming mode". In this mode, tails are trimmed starting at the first bin below the threshold. This can happen either/both at the first or/and second quantile, depending on the value of the quantile property.
Definition at line 19 of file blmisc_rowsout_distr.m.
(GUI setting) Whether to "publish" in blockmenu and datatool. Note that a class can be "published" without a GUI (set flag_params=0 in this case, at the class constructor).
Definition at line 60 of file irobj.m.
| Property blmisc_rowsout_uni::hits |
|
protectedinherited |
| Property blmisc_rowsout_uni::idx_fea |
|
inherited |
| Property block::inputclass |
|
protectedinherited |
='irdata'. (High-Level setting) Class or classes (can be string or cell of strings) that the block can deal with. Allows for objtool and datatool to know (when appropriate) which blocks are applicable to the selected object(s).
Definition at line 11 of file block.m.
| Property blmisc_rowsout::map |
|
protectedinherited |
| Property irobj::moreactions |
|
protectedinherited |
(GUI setting) String cell containing names of methods that may be called from the GUIs
Definition at line 63 of file irobj.m.
=-1. Number of features. Cleared at boot(), assigned or reinforced at train().
Definition at line 60 of file block.m.
=-1. Number of observations.
Definition at line 63 of file block.m.
| Property blmisc_rowsout_uni::no_bins |
|
inherited |
| Property blmisc_rowsout_distr::quantile |
| Property blmisc_rowsout_uni::ranges |
|
inherited |
[no_ranges][2] matrix. Univariate outlier removal is range-based. Descendants may have different ways to fill in this property.
Definition at line 27 of file blmisc_rowsout_uni.m.
Short for the method name.
Definition at line 53 of file irobj.m.
| Property blmisc_rowsout_distr::threshold |
=0.01. Value to be used if type is 'threshold'. This is a fraction of the maximum value in the histogram
Definition at line 11 of file blmisc_rowsout_distr.m.
| Property block::time_train |
|
protectedinherited |
Trainings time.
Definition at line 73 of file block.m.
Use time.
Definition at line 76 of file block.m.
The documentation for this class was generated from the following file:
Inheritance diagram for blmisc_rowsout_distr:
1.8.9.1 
