Types of User Objects


LTPDA has various classes of objects which the user can create and manipulate. All of these classes of object (termed 'user objects'), with the exception of the plist class, track their history through all manipulations. The following table summarizes these types.

Class Description

plist

A class of object that allows storing a set of key/value pairs. This is the equivalent to a 'dictionary' in other languages, like python or Objective-C. Since a history step must contain a plist object, this class cannot itself track history, since it would be recursive.

ao

A class of object that implements Analysis Objects. Such objects can store various types of numeric data: time-series, frequency-series , x-y data series, x-y-z data series, and arrays of numbers.

mfir

A class of object that implements Finite Impulse Response (FIR) digital filters.

miir

A class of object that implements Infinite Impulse Response (IIR) digital filters.

pzmodel

A class of object that represents transfer functions given in a pole/zero format.

rational

A class of object that represents transfer functions given in rational form.

parfrac

A class of object that represents transfer functions given as a series of partial fractions.

timespan

A class of object that represents a span of time. A timespan object has a start time and an end time.

ssm

A class of object that represents a statespace model.

smodel

A class of object that represents a parametric model of a chosen x variable. Such objects can be combined, manipulated symbolically, and then evaluated numerically.

pest

A class of object that represents the result of a fit with a chosen model. Such objects contain the estimated parameter values, the uncertainties, the covariance matrix, the estimated chi^2 and degrees of freedom. They can be evaluated to yield values predictions.

filterbank

A class of object that represents a bank of digital filters. The filter bank can be of type 'parallel' or 'serial'.

matrix

A class of object that allows storing other User Objects in a matrix-like array. There are various methods which act on the object array as if it were a matrix of the underlying data. For example, you can form a matrix of Analysis Objects, then compute the determinant of this matrix, which will yield another matrix object containing a single AO.

collection

A class of object that allows storing other User Objects in a cell-array. This is purely a convenience class, aimed at simplifying keeping a collection of different classes of user objects together. This is useful, for example, for submitting or retrieving a collection of user objects from/to an LTPDA Repository.

mfh

A class of object that allows wrapping around MATLAB function handles. They allow history tracking, and writing functions of: input (variable) parameters, constants (e.g. data) and so on.



©LTP Team