Least-squares classifier.
Definition at line 5 of file clssr_ls.m.
|
| function | clssr_ls () |
| |
| function get | no_outputs (in o) |
| |
| function | boot (in o) |
| | Resets classlabels and calls clssr::boot() More...
|
| |
| function | get_classes (in o, in data) |
| |
| function | draw_domain (in o, in parameters) |
| |
| 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 | 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) |
| |
| function clssr_ls::clssr_ls |
( |
| ) |
|
| function clssr::boot |
( |
in |
o | ) |
|
|
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 clssr::do_draw_domain |
( |
in |
o, |
|
|
in |
params |
|
) |
| |
|
protectedinherited |
| function irobj::do_get_html |
( |
in |
o | ) |
|
|
protectedinherited |
Abstract. HTML inner body.
| function irobj::do_get_report |
( |
in |
o | ) |
|
|
protectedinherited |
| function clssr_ls::do_train |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protected |
| function clssr_ls::do_train |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protected |
| function clssr_ls::do_use |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protected |
With bits from MATLAB classify()
| function clssr_ls::do_use |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
protected |
| function clssr::draw_domain |
( |
in |
o, |
|
|
in |
parameters |
|
) |
| |
|
inherited |
| function irobj::extract_log |
( |
in |
o | ) |
|
|
inherited |
- Parameters
-
- Returns
- [o, log]
| function irobj::get_ancestry |
( |
in |
o, |
|
|
in |
flag_title |
|
) |
| |
|
inherited |
| function clssr::get_classes |
( |
in |
o, |
|
|
in |
data |
|
) |
| |
|
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 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 irobj::get_methodname |
( |
in |
o, |
|
|
in |
flag_short |
|
) |
| |
|
inherited |
This is used only to compose sequence string e.g. xxx->yyy->zzz
- Parameters
-
| function clssr::get_no_outputs |
( |
in |
o | ) |
|
|
protectedinherited |
| 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.
| static function clssr_ls::get_weights |
( |
in |
data | ) |
|
|
static |
Returns weights that are inversely propoertional to the number of observations in each class
Weights are scaled so that sum(w_c*N_c) = N,
where w_c is the weight for class c, N_c is the number of observations in class c, and N is the total number of observations.
| function get clssr::no_outputs |
( |
in |
o | ) |
|
|
inherited |
| 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 clssr::classlabels |
|
protectedinherited |
| 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 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 clssr::flag_datay |
|
inherited |
| 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 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.
(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 clssr_ls::flag_use_priors |
=1. Whether or not to use priors. If set, will calculate the prior class-conditional probabilities based on the amount of training data for each class.
Definition at line 12 of file clssr_ls.m.
| Property clssr_ls::flag_weighted |
Whether to weight the observations (for unbalanced classes)
Definition at line 15 of file clssr_ls.m.
| 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 clssr_ls::intercepts |
|
protected |
"Intercepts" (account for features whose mean is not zero
Definition at line 25 of file clssr_ls.m.
"Loadings matrix" [nf]x[nc]
Definition at line 28 of file clssr_ls.m.
| 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.
| Property clssr_ls::nf_select |
[]. Number of features. If specified, will find a threshold to trim the coefficients
Definition at line 18 of file clssr_ls.m.
=-1. Number of observations.
Definition at line 63 of file block.m.
| Property clssr::no_outputs |
|
protectedinherited |
Recording of each stage of the feature reduction.
Definition at line 31 of file clssr_ls.m.
Short for the method name.
Definition at line 53 of file irobj.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 clssr_ls:
1.8.9.1 
