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

Detailed Description

Biomarkers comparer class

References

Trevisan et al 2012. Submitted to AC.

See also
sigfun.m

Definition at line 7 of file biocomparer.m.

+ Inheritance diagram for biocomparer:
+ Collaboration diagram for biocomparer:

Public Member Functions

function go (in o, in A, in B, in WA, in WB)
 
function biocomparer ()
 
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 halfheight
 
Property flag_use_weights
 =1. Whether to use the weights that are passed to go() 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...
 

Static Protected Member Functions

static function internal_compare_biomarkers (in A, in B, in WA, in WB, in hh)
 

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 biocomparer::biocomparer ( )

Member Function Documentation

function irobj::do_get_html ( in  o)
protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in  o)
protectedinherited

Default report.

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 biocomparer::go ( in  o,
in  A,
in  B,
in  WA,
in  WB 
)
Parameters
AFirst set of wavenumbers
BSecond set of wavenumbers
WA(Optional) Weights of first set of wavenumbers. If not supplied or supplied as "[]", all weights will be considered the same. The weight scale is irrelevant.
WB(Optional) Weights of second set of wavenumbers. If not supplied or supplied as "[]", all weights will be considered the same. The weight scale is irrelevant.
Returns
[matches, finalindex] the "matches" structure has the following fields:
  • .indexes 2-element vector containing the indexes of the originals
  • .wns 2-element vector containing the x-positions (wavenumbers/"wns") of the corresponding indexes
  • .agreement Result of the agreement calculation using the sigmoit function
  • .weight Average between the (normalized) weights of the matched positions
  • .strength Just the result of agreement*weight The "agreement" will be calculated by a logistic sigmoid function (that of shape 1/(1+exp(x)))
static function biocomparer::internal_compare_biomarkers ( in  A,
in  B,
in  WA,
in  WB,
in  hh 
)
staticprotected
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, ...} 

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 biocomparer::flag_use_weights

=1. Whether to use the weights that are passed to go()

Definition at line 17 of file biocomparer.m.

Property biocomparer::halfheight

=20. "half-height" distance between biomarkers. This is the distance in x-values (wavenumbers) where the degree of agreement will be considered to be 50%

Definition at line 14 of file biocomparer.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: