Detailed Description

Class representing a Confusion matrix.

Definition at line 5 of file irconfusion.m.

Inheritance diagram for irconfusion:

Collaboration diagram for irconfusion:

Public Member Functions
function get	flag_rejected (in o)

function get	flag_show_rejected (in o)

function	irconfusion ()

function	get_flag_sortable (in o)

function	get_html_table (in o)
	Automatically detects if confusion matrix has hits or percentages. More...

function	sort (in o, in no_levels)

function	draw_balls (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	collabels

Property	rowlabels
	Grouping of rows in the confusion matrix. More...

Property	C
	The matrix itself. The first column must represent rejected items. More...

Property	flag_perc
	Whether or not the values are expressed in percentages. More...

Property	flag_force_rejected
	=0. Whether to show the "Rejected" column even if there is no rejected item More...

Property	flag_rejected
	Whether there is any rejected item, i.e. a nonzero element in the first column. This is automatically calculated. More...

Property	flag_show_rejected
	WHether to show the rejected column. Calculated based on flag_force_rejected and flag_rejected. More...

Property	title

Property	color

Protected Member Functions
function	do_get_html (in o)
	Automatically detects if confusion matrix has hits or percentages. More...

function	do_get_report (in o)
	Default report. 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 irconfusion::irconfusion ( )

Member Function Documentation

function irconfusion::do_get_html ( in o )

protected

Automatically detects if confusion matrix has hits or percentages.

function irobj::do_get_report ( in o )

protectedinherited

Default report.

function irconfusion::draw_balls ( in o )

Visualization. Draws figure with circles whose area are proportional to the percentuals of the corresponding cells of the matrix

function irobj::extract_log ( in o )

inherited

Parameters

o

Returns: [o, log]

function get irconfusion::flag_rejected ( in o )

function get irconfusion::flag_show_rejected ( in o )

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 irconfusion::get_flag_sortable ( in o )

function irobj::get_html	(	in	o,
		in	flag_stylesheet
	)

inherited

Parameters

flag_stylesheet=1 Whether to include the stylesheet in the HTML

function irconfusion::get_html_table ( in o )

Automatically detects if confusion matrix has hits or percentages.

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
params	Cell followint the pattern {'property1', value1, 'property2', value2, ...}

function irconfusion::sort	(	in	o,
		in	no_levels
	)

This sorting is made to group rows/columns. It was used in one of the presentations to Unilever

Parameters

no_levels Number of levels in index key

Member Data Documentation

Property irconfusion::C

The matrix itself. The first column must represent rejected items.

Definition at line 19 of file irconfusion.m.

Property irobj::classtitle

protectedinherited

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

Definition at line 50 of file irobj.m.

Property irconfusion::collabels

List of all class labels matching the one of the classifier used. It is always used as a reference at least to renumber the classes of the estimato dataset passed to do_record() . least

Definition at line 13 of file irconfusion.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 irconfusion::flag_force_rejected

=0. Whether to show the "Rejected" column even if there is no rejected item

Definition at line 25 of file irconfusion.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 irconfusion::flag_perc

Whether or not the values are expressed in percentages.

Definition at line 22 of file irconfusion.m.

Property irconfusion::flag_rejected

Whether there is any rejected item, i.e. a nonzero element in the first column. This is automatically calculated.

Definition at line 31 of file irconfusion.m.

Property irconfusion::flag_show_rejected

WHether to show the rejected column. Calculated based on flag_force_rejected and flag_rejected.

Definition at line 34 of file irconfusion.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 irconfusion::rowlabels

Grouping of rows in the confusion matrix.

Definition at line 16 of file irconfusion.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:

irconfusion.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation