RMS2

Model ElementComputes the root mean square area difference between a measured signal and a target curve.

Class Name

RMS2

Description



is the measured signal.

is the target curve.

Attribute Summary

Name Property Modifiable by Command? Designable?
label Str ()    
targetValue Tuple () Yes  
measuredValue Function () Yes Yes

Usage

# RMS2 defined as the area between a measured expression and a target curve
RMS2 (measuredValue=expressionString, targetValue=listOfXYTuples, optional_attributes)

Attributes

Defined as squared difference between a target curve a measured value.
measuredValue
String
A MotionSolve expression that represents the required signal.
measuredValue attribute is mandatory.
targetValue
Tuple of tuples.
Format: ((x1,y1), (x2,y2)…, (xN,yN)). It represents the target curve.
targetValue is mandatory.
Optional attribute.
label
String
Specifies the name of the RMS2 object.
This attribute is optional. When not specified, MotionSolve creates a label for you.

Example

# RMS2 measure of a Marker's X displacement with time vs a target curve
targetValue = ((0.00, 400.000),
              (0.10, 382.665),
              (0.20, 312.589),
              (0.30, 211.853),
              (0.40, 115.093),
              (0.50, 53.181),
              (0.60, 46.368),
              (0.70, 113.983),
              (0.80, 275.874),
              (0.90, 369.449),
              (1.00, 400.001))
measuredValue = "DX({id})".format(id=model.coupler.cm.id)
rms2 = RMS2 (label="DX", targetValue=targetValue, measuredValue=measuredValue)

Comments

  1. See Properties for an explanation about what properties are, why they are used, and how you can extend these.