Detailed Description

FSG that uses classifier to grade the subsets.

The grades are classification rates expressed in percentages (from 0 to 100)

If not using SGS, must assign a 2-dataset vector to data

See also: uip_fsg_clssr.m, reptt

Definition at line 8 of file fsg_clssr.m.

Inheritance diagram for fsg_clssr:

Collaboration diagram for fsg_clssr:

Public Member Functions
function	get_yname (in o)

function	get_yunit (in o)

function	boot (in o)

function	fsg_clssr ()

function set	data (in o, in data)

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	clssr

Property	estlog

Property	postpr_test
	(Optional) Block to post-process the test data. For example, a grag_classes_first. More...

Property	postpr_est

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)

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

Constructor & Destructor Documentation

function fsg_clssr::fsg_clssr ( )

Member Function Documentation

function fsg_clssr::boot ( in o )

Couple of checks

Makes sure that postpr_est is able to decide Checks datasets

function fsg::calculate_grades	(	in	o,
		in	idxs
	)

inherited

May return one grade or a vector thereof

Parameters

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
	)

inherited

Assigns the datasets property.

See also: datasets

Parameters

data	Vector of datasets.

function fsg_clssr::do_calculate_pairgrades	(	in	o,
		in	idxs
	)

protected

Cross-validation is performed here. return a (no_pairs)x(no_idxs)x(no_test_sets) grades vector

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=0 I 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=1 Whether 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 fsg_clssr::get_yname ( in o )

function fsg_clssr::get_yunit ( in o )

function fsg::reset ( in o )

protectedinherited

function irobj::setbatch	(	in	o,
		in	params
	)

inherited

Sets several properties of an object at once.

Parameters

o
params	Cell 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 fsg_clssr::clssr

Definition at line 13 of file fsg_clssr.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 fsg::data

inherited

See also: datasets

Definition at line 91 of file fsg.m.

Property fsg::datasets

protectedinherited

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

Definition at line 57 of file fsg.m.

Property fsg_clssr::estlog

Definition at line 15 of file fsg_clssr.m.

Property fsg::f_aggr

inherited

=. Function pointer to aggregate a vector of pairwise grades. As seen, the default behaviour is taking the least grade obtained among all pairwise gradings.

Definition at line 12 of file fsg.m.

Property fsg::fext

inherited

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.

Definition at line 20 of file fsg.m.

Property fsg::flag_booted

protectedinherited

Definition at line 42 of file fsg.m.

Property fsg::flag_pairwise

protectedinherited

=0;

Definition at line 26 of file fsg.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 fsg::flag_sgs

protectedinherited

Prepared.

Definition at line 37 of file fsg.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 fsg::flag_univariate

protectedinherited

=0;

Definition at line 29 of file fsg.m.

Property fsg::grade

protectedinherited

Definition at line 31 of file fsg.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 fsg_clssr::postpr_est

Block to post-process the estimation issued by the classifier. Examples:

a decider
a consisting of a decider followed by a grag_classes_vote

Definition at line 23 of file fsg_clssr.m.

Property fsg_clssr::postpr_test

(Optional) Block to post-process the test data. For example, a grag_classes_first.

Definition at line 18 of file fsg_clssr.m.

Property fsg::pvt_flag_pairwise

protectedinherited

The algorithm is clever enough to go non-pairwise mode if flag_pairwise is TRUE but the dataset has less than three classes.

Definition at line 45 of file fsg.m.

Property fsg::sgs

inherited

SGS object. If set,.

Definition at line 15 of file fsg.m.

Property irobj::short

protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property fsg::subddd

protectedinherited

Assigned by prepare(). This is a cell vector of Cell of matrices of irdata datasets.

Definition at line 34 of file fsg.m.

Property irobj::title

inherited

Definition at line 38 of file irobj.m.

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

fsg_clssr.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation