The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
OutputFilterWrapper Class Reference

This class wraps another model, hiding one or more outputs. More...

Inheritance diagram for OutputFilterWrapper:
Inheritance graph
[legend]

Public Member Functions

function OutputFilterWrapper (var model, var outputs)
 
function getFilters ()
 
function evaluate (var points)
 Evaluation at a set of points. More...
 
function evaluateInModelSpace (var points)
 Evaluation at a set of points, return only the filtered outputs. More...
 
function evaluateBatch (var points, var batchSize)
 Evaluation at a set of points. More...
 
function evaluateInModelSpaceBatch (var points, var batchSize)
 Evaluation at a set of points, return only the filtered outputs. More...
 
function getDimensions ()
 Return the input and output dimensions of the model. More...
 
function getExpression (var outputIndex)
 Wrapper method. More...
 
function getExpressionInModelSpace (var outputIndex)
 Wrapper method. More...
 
function getGrid ()
 Returns a set of samples evaluated on a dense grid to be used for evaluation of the model. More...
 
function getOutputNames ()
 Returns the output names. More...
 
function getValues ()
 Returns the set of values in the samples on which this model was built, filtering out those dimensions that are not returned by evaluate. More...
 
function getNestedModel ()
 Return the model that is wrapped. More...
 
function plotModel ()
 Forwarded to nested model. More...
 
function complexity ()
 Returns the number of free variables in the model. More...
 
function getId ()
 Returns the id of this model. More...
 
function equals (var m, var threshold)
 Simply call the base class method. More...
 
function evaluateDerivative (var points, var outputIndex)
 Approximate the derivative at the given points in simulator space. More...
 
function evaluateDerivativeInModelSpace (var points, var outputIndex)
 Approximate the derivative at the given points in model space. More...
 
function getTransformationFunctions ()
 Get the simulator to model and model to simulator transformation functions for this model. More...
 
function getMeasureScores ()
 Gets score of this model. More...
 
function getTransformationValues ()
 
function getSamples ()
 Returns the set of samples on which this model was built. More...
 
function getSamplesInModelSpace ()
 Returns the set of samples on which this model was built (in model space! so in [-1 1]) More...
 
function getBounds ()
 
function getScore ()
 Return the global score of the model. More...
 
function getInputNames ()
 Returns the input names. More...
 
function constructInModelSpace (var samples, var values)
 Call construct on the nested model. More...
 
function getType ()
 Return the type of the nested model. More...
 
function saveobj ()
 Called whenever a wrapped model is saved to disk, make sure we remove the wrapper. More...
 
function getDescription ()
 Returns the description of the nested model. More...
 
function updateInModelSpace (var samples, var values)
 
function update (var samples, var values)
 

Detailed Description

This class wraps another model, hiding one or more outputs.

Constructor & Destructor Documentation

function OutputFilterWrapper ( var  model,
var  outputs 
)
inline

Member Function Documentation

function complexity ( )
inherited

Returns the number of free variables in the model.

function constructInModelSpace ( var  samples,
var  values 
)
inherited

Call construct on the nested model.

function equals ( var  m,
var  threshold 
)
inherited

Simply call the base class method.

function evaluate ( var  points)

Evaluation at a set of points.

function evaluateBatch ( var  points,
var  batchSize 
)

Evaluation at a set of points.

function evaluateDerivative ( var  points,
var  outputIndex 
)
inherited

Approximate the derivative at the given points in simulator space.

function evaluateDerivativeInModelSpace ( var  points,
var  outputIndex 
)
inherited

Approximate the derivative at the given points in model space.

function evaluateInModelSpace ( var  points)

Evaluation at a set of points, return only the filtered outputs.

function evaluateInModelSpaceBatch ( var  points,
var  batchSize 
)

Evaluation at a set of points, return only the filtered outputs.

function getBounds ( )
inlineinherited
function getDescription ( )
inherited

Returns the description of the nested model.

function getDimensions ( )

Return the input and output dimensions of the model.

function getExpression ( var  outputIndex)

Wrapper method.

function getExpressionInModelSpace ( var  outputIndex)

Wrapper method.

function getFilters ( )
inline
function getGrid ( )

Returns a set of samples evaluated on a dense grid to be used for evaluation of the model.

Recycles previously evaluated grids.

function getId ( )
inherited

Returns the id of this model.

Id's are defined in the construct function, so that a model that is reconstructed gets a new unique id.

function getInputNames ( )
inherited

Returns the input names.

function getMeasureScores ( )
inherited

Gets score of this model.

function getNestedModel ( )
inlineinherited

Return the model that is wrapped.

function getOutputNames ( )

Returns the output names.

function getSamples ( )
inherited

Returns the set of samples on which this model was built.

function getSamplesInModelSpace ( )
inherited

Returns the set of samples on which this model was built (in model space! so in [-1 1])

function getScore ( )
inherited

Return the global score of the model.

function getTransformationFunctions ( )
inherited

Get the simulator to model and model to simulator transformation functions for this model.

function getTransformationValues ( )
inlineinherited
function getType ( )
inherited

Return the type of the nested model.

function getValues ( )

Returns the set of values in the samples on which this model was built, filtering out those dimensions that are not returned by evaluate.

function plotModel ( )
inherited

Forwarded to nested model.

function saveobj ( )
inherited

Called whenever a wrapped model is saved to disk, make sure we remove the wrapper.

function update ( var  samples,
var  values 
)
inlineinherited
function updateInModelSpace ( var  samples,
var  values 
)
inlineinherited

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