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

Detailed Description

Generated by subsetsprocessor, carries a histogram.

Definition at line 2 of file log_hist.m.

+ Inheritance diagram for log_hist:
+ Collaboration diagram for log_hist:

Public Member Functions

function log_hist ()
 
function draw_hists (in o, in idxs, in data_hint, in flag_group)
 Draws histograms. More...
 
function draw_stackedhists (in o, in data_hint, in colors, in peakdetector, in flag_trace_minalt)
 Draws histograms Using stacked bars. More...
 
function draw_as_lines (in o)
 Draws each per-feature-position histogram as a line. More...
 
function get nf (in o)
 
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 hitss
 [number of selected features]x[nf (total number of features dataset)]. Individual hits. More...
 
Property nf4grades
 Number of selected features used to compose grades. More...
 
Property grades
 Grades vector. More...
 
Property fea_x
 Extracted from data. More...
 
Property xname
 Extracted from data. More...
 
Property xunit
 Extracted from data. More...
 
Property yname
 Describes what the "grades" represent. More...
 
Property yunit
 Describes what the "grades" represent. More...
 
Property nf
 
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_hist::log_hist ( )

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 log_hist::draw_as_lines ( in  o)

Draws each per-feature-position histogram as a line.

function log_hist::draw_hists ( in  o,
in  idxs,
in  data_hint,
in  flag_group 
)

Draws histograms.

Will generate subplots if idxs has more than one element

Parameters
idxs=allIndexes of feature orders to plot
function log_hist::draw_stackedhists ( in  o,
in  data_hint,
in  colors,
in  peakdetector,
in  flag_trace_minalt 
)

Draws histograms Using stacked bars.

Note that this will work for Forward Feature Selection only

Parameters
data_hintHint dataset
no_insideNumber of histograms that are considered "informative"
colors=(default colors). Either a cell of 2 elements or 4 elements. If it is a cell of two elements, the non-informative and informative histograms will have gradients
peakdetectorUse it to mark peaks in the histogram
flag_trace_minalt=~isempty(peakd) Whether to draw the threshold line. Only works if the peak detector is passed.
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 get log_grades::nf ( in  o)
inherited
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 log_grades::fea_x
inherited

Extracted from data.

Definition at line 12 of file log_grades.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_grades::grades
inherited

Grades vector.

Definition at line 8 of file log_grades.m.

Property log_hist::hitss

[number of selected features]x[nf (total number of features dataset)]. Individual hits.

Definition at line 8 of file log_hist.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_grades::nf
inherited

Definition at line 29 of file log_grades.m.

Property log_hist::nf4grades

Number of selected features used to compose grades.

Definition at line 11 of file log_hist.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.

Property log_grades::xname
inherited

Extracted from data.

Definition at line 15 of file log_grades.m.

Property log_grades::xunit
inherited

Extracted from data.

Definition at line 18 of file log_grades.m.

Property log_grades::yname
inherited

Describes what the "grades" represent.

Definition at line 21 of file log_grades.m.

Property log_grades::yunit
inherited

Describes what the "grades" represent.

Definition at line 24 of file log_grades.m.


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