IRootLab
An Open-Source MATLAB toolbox for vibrational biospectroscopy
log_fselrepeater Class Reference

Detailed Description

Generated by fselrepeater, carries subsets of features.

Definition at line 2 of file log_fselrepeater.m.

+ Inheritance diagram for log_fselrepeater:
+ Collaboration diagram for log_fselrepeater:

Public Member Functions

function log_fselrepeater ()
 
function get nfmax (in o)
 
function get subsets (in o)
 
function get nfxgrade (in o)
 
function get_stabilities (in o, in type, in type2)
 
function extract_dataset_nfxgrade (in o)
 
function extract_dataset_stabilities (in o, in type, in type2)
 
function draw_stackedhist_for_legend (in o)
 Draws stacked histogram for legend purpose only. More...
 
function calculate_stabilities (in o, in type, in type2)
 Stores stabilities vector to prevent frequent recalculation. 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)
 

Public Attributes

Property fea_x
 Extracted from data. More...
 
Property xname
 Extracted from data. More...
 
Property xunit
 Extracted from data. More...
 
Property logs
 Array of log_as_fsel objects. More...
 
Property subsets
 
Property nfxgrade
 
Property nfmax
 Maximum number of features selected. More...
 
Property title
 
Property color
 

Protected Member Functions

function do_get_report (in o)
 Default report. More...
 
function do_get_html (in o)
 Abstract. HTML inner body. More...
 

Protected Attributes

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...
 

Constructor & Destructor Documentation

function log_fselrepeater::log_fselrepeater ( )

Member Function Documentation

function log_fselrepeater::calculate_stabilities ( in  o,
in  type,
in  type2 
)

Stores stabilities vector to prevent frequent recalculation.

function irobj::do_get_html ( in  o)
protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in  o)
protectedinherited

Default report.

function log_fselrepeater::draw_stackedhist_for_legend ( in  o)

Draws stacked histogram for legend purpose only.

function log_fselrepeater::extract_dataset_nfxgrade ( in  o)

Extract dataset to visualize FFS progress

Each row of the dataset shows the performance progression of a Forward Feature Selection (FFS) run.

function log_fselrepeater::extract_dataset_stabilities ( in  o,
in  type,
in  type2 
)

Extract dataset with one row containing stability measures

Parameters
typeType of stability measure (e.g. 'kun'). See featurestability.m
type2'uni' or 'mul'. See featurestability.m
See also
featurestability.m
function irobj::extract_log ( in  o)
inherited
Parameters
o
Returns
[o, log]
function irobj::get_ancestry ( in  o,
in  flag_title 
)
inherited
Parameters
o
flag_title=1
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=0I am sealing this to make sure that no class will try to improvise on this function.
function irobj::get_html ( in  o,
in  flag_stylesheet 
)
inherited
Parameters
flag_stylesheet=1Whether 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
flag_short=0
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 log_fselrepeater::get_stabilities ( in  o,
in  type,
in  type2 
)

Returns a (feature position)x(stability curve)

Parameters
typeType of stability measure (e.g., 'kun')
type2'uni' or 'mul'
See also
featurestability.m
function get log_fselrepeater::nfmax ( in  o)
function get log_fselrepeater::nfxgrade ( in  o)
Returns
A matrix [number of repetitions]x[number of features selected]
function irobj::setbatch ( in  o,
in  params 
)
inherited

Sets several properties of an object at once.

Parameters
o
paramsCell followint the pattern
{'property1', value1, 'property2', value2, ...} 
function get log_fselrepeater::subsets ( in  o)
Returns
A cell of vectors

Member Data Documentation

Property irobj::classtitle
protectedinherited

Class Title. Should have a descriptive name, as short as possible.

Definition at line 50 of file irobj.m.

Property irobj::color
inherited

=[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 log_fselrepeater::fea_x

Extracted from data.

Definition at line 8 of file log_fselrepeater.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 irobj::flag_ui
protectedinherited

(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 log_fselrepeater::logs

Array of log_as_fsel objects.

Definition at line 17 of file log_fselrepeater.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.

Property log_fselrepeater::nfmax

Maximum number of features selected.

Definition at line 35 of file log_fselrepeater.m.

Property log_fselrepeater::nfxgrade

Meaning (Number of features)x(rate); Dimensions [number of repetitions]x[o.as_fsel.nf_select] The numbers are the calculated "grades"

Definition at line 32 of file log_fselrepeater.m.

Property irobj::short
protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property log_fselrepeater::subsets

(Read-only) Cell containing the features selected at each repetition. This will be the base to build a histogram.

Note
This has to be a cell because the number of selected features may not be fixed at each repetition. For example, feature selection methods that pick peaks of the grades curve may find the grades curve to have eventually more or less peaks.

Dimensions [number of repetitions]; each element is a vector of dimension [o.as_fsel.nf_select (maximum)]

Definition at line 27 of file log_fselrepeater.m.

Property irobj::title
inherited

Definition at line 38 of file irobj.m.

Property log_fselrepeater::xname

Extracted from data.

Definition at line 11 of file log_fselrepeater.m.

Property log_fselrepeater::xunit

Extracted from data.

Definition at line 14 of file log_fselrepeater.m.


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