 |
IRootLab
An Open-Source MATLAB toolbox for vibrational biospectroscopy
|
|
IRootLab
An Open-Source MATLAB toolbox for vibrational biospectroscopy
|
FSG - Feature Subset Grader.
FSG is always equipped with cross-validation capability. Descendant classes must always implement the cross-validation and no cross-validation cases. Whether there is cross-validation is determining by the sgs property being set or not.
Inheritance diagram for fsg: Collaboration diagram for fsg:Public Member Functions | |
| function | get_yname (in o) |
| function | get_yunit (in o) |
| function set | data (in o, in data) |
| function | fsg (in o) |
| function | boot (in o) |
| Assigns the subddd property. More... | |
| function | calculate_grades (in o, in idxs) |
| 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) |
Public Attributes | |
| Property | f_aggr |
| =. Function pointer to aggregate a vector of pairwise grades. As seen, the default behaviour is taking the least grade obtained among all pairwise gradings. More... | |
| Property | sgs |
| SGS object. If set,. More... | |
| Property | fext |
| Property | data |
| Property | title |
| Property | color |
Protected Member Functions | |
| function | do_calculate_pairgrades (in o, in idxs) |
| Abstract. Must return a column vector with as elements as number of datasets. More... | |
| function | reset (in o) |
| function | do_get_report (in o) |
| Default report. More... | |
| function | do_get_html (in o) |
| Abstract. HTML inner body. More... | |
Protected Attributes | |
| Property | flag_pairwise |
| =0; More... | |
| Property | flag_univariate |
| =0; More... | |
| Property | grade |
| Property | subddd |
Assigned by prepare(). This is a cell vector of Cell of matrices of irdata datasets. More... | |
| Property | flag_sgs |
| Prepared. More... | |
| Property | flag_booted |
| Property | pvt_flag_pairwise |
| The algorithm is clever enough to go non-pairwise mode if flag_pairwise is TRUE but the dataset has less than three classes. More... | |
| Property | datasets |
| Property | classtitle |
| Class Title. Should have a descriptive name, as short as possible. More... | |
| Property | short |
| Short for the method name. More... | |
| Property | flag_params |
| Property | flag_ui |
| (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). More... | |
| Property | moreactions |
| (GUI setting) String cell containing names of methods that may be called from the GUIs More... | |
| function fsg::fsg | ( | in | o | ) |
| function fsg::boot | ( | in | o | ) |
Assigns the subddd property.
| function fsg::calculate_grades | ( | in | o, |
| in | idxs | ||
| ) |
May return one grade or a vector thereof
| idxs | May be either: a cell of feature subsets; or a vector of feature indexes. Developers please note that it is the end class responsibility to give proper treatment to this. The option is left open for speed, as there is no point in using a cell in univariate cases. |
| function set fsg::data | ( | in | o, |
| in | data | ||
| ) |
|
protected |
Abstract. Must return a column vector with as elements as number of datasets.
|
protectedinherited |
Abstract. HTML inner body.
|
protectedinherited |
Default report.
|
inherited |
| o |
|
inherited |
| o | |
| flag_title=1 |
|
inherited |
Returns description string
Precedence according with flag_short:
| flag_short=0 | I am sealing this to make sure that no class will try to improvise on this function. |
|
inherited |
| flag_stylesheet=1 | Whether to include the stylesheet in the HTML |
|
inherited |
This is used only to compose sequence string e.g. xxx->yyy->zzz
| flag_short=0 |
|
inherited |
Calls Parameters GUI.
If flag_params, tries uip_<class>.m. If fails, tries uip_<ancestor>.m and so on
|
inherited |
Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication.
| function fsg::get_yname | ( | in | o | ) |
| function fsg::get_yunit | ( | in | o | ) |
|
protected |
|
inherited |
Sets several properties of an object at once.
| o | |
| params | Cell followint the pattern{'property1', value1, 'property2', value2, ...} |
|
protectedinherited |
|
inherited |
|
protected |
Assigned by set_data()
If not pairwise (see flag_pairwise), data will be assigned to datasets.
If pairwise, datasets will be a matrix of dimensions (number of pairs)x(numel(data))
Why one would pass a more-than-one-element dataset through data depends on the behaviour of a particular fsg descendant. For instance a two-element vector could be a train-test pair.
Please note that
| Property fsg::f_aggr |
| Property fsg::fext |
Some trainable block for convenience. This can be used to pass a pre_std so that it doesn't have to be part of the classifier itself. This block typically is trainable and treats the features independently. Having it as part of the classifier would result in unnecessary repetition of the same operation.
|
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.
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protected |
1.8.9.1 
