KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
data.selection.EpsSelector Class Reference

EpsSelector: Selects as many points from the data that any trajectory point lies within an epsilon radius of a training point. More...

Detailed Description

EpsSelector: Selects as many points from the data that any trajectory point lies within an epsilon radius of a training point.

This selection strategy is applied in the TPWLApprox-Setting, but may also be used elsewhere.

Author
Daniel Wirtz
Date
2011-05-05
Change in 0.5:
(Daniel Wirtz, 2011-08-04) Adopted this selector class to the new data.ATrajectoryData structure. For now it only works on models that sample a single trajectory, as originally proposed by the TPWL guys.
New in 0.4:
(Daniel Wirtz, 2011-05-06) Implemented the ICloneable interface.
New in 0.4:
(Daniel Wirtz, 2011-05-05) Added this class and included it into the DPCS.
New in 0.4:
(Daniel Wirtz, 2011-05-04) Integrated this class to the property default value changed supervision system Property classes and levels. This class now inherits from KerMorObject and has an extended constructor registering any user-relevant properties using KerMorObject.registerProps.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 19 of file EpsSelector.m.

Public Member Functions

 EpsSelector ()
 
function copy = clone ()
 
- Public Member Functions inherited from data.selection.ASelector
 ASelector ()
 
function data.ApproxTrainData atd = selectTrainingData (model)
 Performs the selection procedure. More...
 
- Public Member Functions inherited from KerMorObject
 KerMorObject ()
 Constructs a new KerMor object. More...
 
function  display ()
 disp(object2str(this)); More...
 
function bool = eq (B)
 Checks equality of two KerMor objects. More...
 
function bool = ne (B)
 Checks if two KerMorObjects are different. More...
 
function cn = getClassName ()
 Returns the simple class name of this object without packages. More...
 
- Public Member Functions inherited from DPCMObject
 DPCMObject ()
 Creates a new DPCM object. More...
 
 DPCMObject ()
 
- Public Member Functions inherited from ICloneable
virtual function copy = clone (target)
 The interface method with returns a copy of the current class instance. More...
 

Public Attributes

 EpsRad = 5
 The distance within there has to be an expansion point for each x. Gets multiplied by \(\sqrt{d}\), where \(d\) denotes the spatial dimension of the snapshots (projection training data) More...
 
 SubspaceProject = true
 
- Public Attributes inherited from data.selection.ASelector
logical EnsureUniqueData = true
 Flag to enable automatic "uniqueification" if selected training data. Uniqueness is determined by the state space samples xi; if any xi is included twice or more, it is discarded along with the fxi, ti, mui data of the replicates (independent of whether they are equal, too) More...
 
- Public Attributes inherited from DPCMObject
 WorkspaceVariableName = ""
 The workspace variable name of this class. Optional. More...
 
 ID = "[]"
 An ID that allows to uniquely identify this DPCMObject (at least within the current MatLab session/context). More...
 
 PropertiesChanged = "[]"
 The Dictionary containing all the property settings as key/value pairs. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Protected Member Functions

function [ matrix xi , rowvec ti , matrix mui ,
fxi ] = 
select (models.BaseFullModel model)
 Selects training points with distance EpsSelector.EpsRad, starting from the initial values for each trajectory. More...
 
- Protected Member Functions inherited from KerMorObject
function  checkType (obj, type)
 Object typechecker. More...
 
- Protected Member Functions inherited from DPCMObject
function  registerProps (varargin)
 Call this method at any class that defines DPCM observed properties. More...
 
function  registerProps (varargin)
 

Additional Inherited Members

- Static Protected Member Functions inherited from DPCMObject
static function obj = loadobj (obj, from)
 Re-register any registered change listeners! More...
 
static function obj = loadobj (obj, from)
 

Constructor & Destructor Documentation

data.selection.EpsSelector.EpsSelector ( )

Definition at line 84 of file EpsSelector.m.

References EpsRad, and DPCMObject.registerProps().

Here is the call graph for this function:

Member Function Documentation

function copy = data.selection.EpsSelector.clone ( )

Definition at line 91 of file EpsSelector.m.

References EpsRad, and SubspaceProject.

function [ matrix xi , rowvec ti , matrix mui , fxi ] = data.selection.EpsSelector.select ( models.BaseFullModel  model)
protectedvirtual

Selects training points with distance EpsSelector.EpsRad, starting from the initial values for each trajectory.

Parameters
modelThe full model with the training data
Return values
xiThe selected \(x_i = x(t_i)\) training data
tiThe selected training times \(t_i\)
muiThe selected parameter samples \(\mu_i\) with which the states \(x_i\) have been reached
Required fields of model:

Implements data.selection.ASelector.

Definition at line 113 of file EpsSelector.m.

References models.BaseFullModel.assembleProjectionMatrices(), models.BaseFullModel.Data, EpsRad, data.ATrajectoryData.getNumTrajectories(), models.BaseFullModel.SpaceReducer, SubspaceProject, t, models.BaseModel.Times, and data.ModelData.TrajectoryData.

Here is the call graph for this function:

Member Data Documentation

data.selection.EpsSelector.EpsRad = 5

The distance within there has to be an expansion point for each x. Gets multiplied by \(\sqrt{d}\), where \(d\) denotes the spatial dimension of the snapshots (projection training data)

Property class critical:
Determines how many training samples are taken. Value MUST be set taking into account the full system's dimension or at least the bounding box of the samples!
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Default: 5
This property has custom functionality when its value is changed.

Definition at line 53 of file EpsSelector.m.

Referenced by clone(), EpsSelector(), and select().

data.selection.EpsSelector.SubspaceProject = true
Property class experimental:
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Default: true

Definition at line 70 of file EpsSelector.m.

Referenced by clone(), and select().


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