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

Detailed Description

Paired Vector Comparer base class.

Compares two vectors. Number of elements must be the same in both vector. This is applied to:

  • comparing two classifiers (see reptt_sgs, which has a reptt_sgs::vectorcomp property)
  • measusing the diversity of two classifiers (example: reptt_xornorm)

Depending on the case (i.e., the vectorcomp descendant considered), the vectors must be classification rates or the class predictions themselves. See the descendant classes (i.e., classes vectorcomp_*)

Definition at line 9 of file vectorcomp.m.

+ Inheritance diagram for vectorcomp:
+ Collaboration diagram for vectorcomp:

Public Member Functions

function vectorcomp (in o)
 
function test (in o, in v1, in v2)
 
function crosstest (in o, in R)
 
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 title
 
Property color
 

Protected Member Functions

function do_test (in o, in vv)
 
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 vectorcomp::vectorcomp ( in  o)

Member Function Documentation

function vectorcomp::crosstest ( in  o,
in  R 
)

Cross-test of many vectors

Performs the test with all combinations of the columns of R

The resulting table should be read as: the row represents the first variable and the column represents the second variable.

Examples:

  • for a 2-sided t-test: H0: mean_row_i - mean_col_j = 0
  • for a right-tail t-test: H0: mean_row_i - mean_col_j < 0
Parameters
o
Ra matrix of shape [v1, v2, v3, v4, ...]
Returns
a matrix [number of v's]x[number of v's]
function irobj::do_get_html ( in  o)
protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in  o)
protectedinherited

Default report.

function vectorcomp::do_test ( in  o,
in  vv 
)
protected
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 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 vectorcomp::test ( in  o,
in  v1,
in  v2 
)

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 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 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 irobj::short
protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property irobj::title
inherited

Definition at line 38 of file irobj.m.


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