CSM Wrapper


Base class for CSM Wrappers. ie. PCA, OPLS etc.

The base class for the CSM wrappers. These wrappers are the standardised access points to the underlying CSM functions.

In order to create a new wrapper, you must implement the following methods:

assignDefaults( obj );

parseInput( obj );

callBaseTool( obj );

parseOutput( obj );

Your constructor should look similar to this:

function [obj] = csm_example_wrapper( arg1, arg2, arg3 )

% Allows creation of empty objects for cloning

if nargin == 0

return

end

obj = obj @ csm_wrapper( varargin{:} );

assignDefaults( obj, arg1, arg2, arg3 );

parseInput( obj );

callBaseTool( obj );

runAuditInfoMethods( obj );

parseOutput( obj );

end

Have a look at the code for any of the existing wrappers for examples

of building your own, eg csm_opls()

Usage

model = csm_wrapper( );

Arguments (* = required)

VariableTypeDefault ValueDescription
no_auditboolfalse;Set to true to not run the audit_info methods

Returns

VariableTypeDescription
csm_wrapper.audit_infocsm_audit_infoThe audit info for audit trails.
csm_wrapper.class_namestrThe name of the child class.
csm_wrapper.inputstructThe inputs of the object.
csm_wrapper.outputstructThe outputs of the base methods
csm_wrapper.csm_data_hashescellThe csm_data_hash of the data used in the object

Copyright Imperial College London 2019