Detailed Description

Base Sub-dataset Generation Specification (SGS) class.

This class generates index maps to sub-datasets, formulating these maps according to various criteria, including cross-validation, random sub-sampling, and weighted sub-sampling.

Definition at line 6 of file sgs.m.

Inheritance diagram for sgs:

Collaboration diagram for sgs:

Public Member Functions
function	sgs (in o)

function get	no_pieces (in o)
	If hasn't been setup yet, will return a NaN. More...

function	setup (in o, in data)

function	get_obsidxs (in o, in data)
	Solves o.no_unitss. More...

function	assert (in o)
	Data-independent validation. Can be used at the GUI to check for parameter inconsistencies. More...

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	flag_group
	=0. Whether items from the same group (group) are to always remain together. More...

Property	flag_perclass
	=0. Whether to perform on each class separately. More...

Property	randomseed

Property	no_pieces
	read-only More...

Property	title

Property	color

Protected Member Functions
function	get_repidxs (in o)
	keyboard; More...

function	do_setup (in o)
	Must be implemented at the descendants. More...

function	do_assert (in o)
	Data-independent validation. More...

function	do_get_report (in o)
	Default report. More...

function	do_get_html (in o)
	Abstract. HTML inner body. More...

Protected Attributes
Property	flag_setup

Property	data

Property	pieces

Property	no_unitss

Property	maps

Property	pr_flag_group
	Calculated upon setup, will be zero if flag_group but dataset has no groups. More...

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

Member Function Documentation

function sgs::assert ( in o )

Data-independent validation. Can be used at the GUI to check for parameter inconsistencies.

function sgs::do_assert ( in o )

protected

Data-independent validation.

function irobj::do_get_html ( in o )

protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in o )

protectedinherited

Default report.

function sgs::do_setup ( in o )

protected

Must be implemented at the descendants.

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 sgs::get_obsidxs	(	in	o,
		in	data
	)

Solves o.no_unitss.

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 sgs::get_repidxs ( in o )

protected

keyboard;

In the grouped, per-class case, converts to per-piece observation to later use the common fragment belowMust be implemented at the descendants, this is essentially what is different for every different sgs method This function is group-or-observation-unaware Returns a 1D cell array or 2D cell arrays. Each element/2D cell array contains one row per piece and one column per bite. This function does not know if it is working with groups or observations

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 sgs::no_pieces ( in o )

If hasn't been setup yet, will return a NaN.

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 sgs::setup	(	in	o,
		in	data
	)

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 sgs::data

protected

Definition at line 32 of file sgs.m.

Property sgs::flag_group

=0. Whether items from the same group (group) are to always remain together.

Definition at line 12 of file sgs.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 sgs::flag_perclass

=0. Whether to perform on each class separately.

Definition at line 15 of file sgs.m.

Property sgs::flag_setup

protected

Definition at line 30 of file sgs.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 sgs::maps

protected

Definition at line 42 of file sgs.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 sgs::no_pieces

read-only

Definition at line 23 of file sgs.m.

Property sgs::no_unitss

protected

Number of "units" in dataset. This may be a single value containing the number of observations or groups, depending on .flag_group, or a vector containing that information for each class, if .flag_perclass is True.

Definition at line 40 of file sgs.m.

Property sgs::pieces

protected

Definition at line 34 of file sgs.m.

Property sgs::pr_flag_group

protected

Calculated upon setup, will be zero if flag_group but dataset has no groups.

Definition at line 46 of file sgs.m.

Property sgs::randomseed

=0. Random seed. Only used if > 0. if > 0, MATLAB's rand('twister', o.randseed) will be called before. This can be used to repeat sequences.

Definition at line 19 of file sgs.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:

sgs.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation