Action: GEOMETRIC_PATH
| Module | mapping |
|---|---|
| Description | Usage |
| Distance along and from a path calculated using geometric formulas |   |
Output components
This action calculates the values in the following table. These values can be referenced elsewhere in the input by using this Action's label followed by a dot and the name of the value required from the list below.
| Name | Type | Description |
|---|---|---|
| s | scalar | the position on the path |
| z | scalar | the distance from the path |
Input
The arguments that serve as the input for this action are specified using one or more of the keywords in the following table.
| Keyword | Type | Description |
|---|---|---|
| ARG | matrix | the labels of the matrix that contains the vectors of displacements from each frame in the path |
| REFERENCE | vector | labels for actions that contain reference coordinates for each point on the path |
| PROPERTY | vector | the label of a value that contains the coordinates we are projecting these points onto |
Further details and examples
Text from manual goes here
Syntax
The following table describes the keywords and options that can be used with this action
| Keyword | Type | Default | Description |
|---|---|---|---|
| ARG | input | none | the labels of the matrix that contains the vectors of displacements from each frame in the path |
| REFERENCE | input | none | labels for actions that contain reference coordinates for each point on the path |
| PROPERTY | input | none | the label of a value that contains the coordinates we are projecting these points onto |
| METRIC | compulsory | none | the method to use for computing the displacement vectors between the reference frames |
| METRIC_COMPONENT | compulsory | none | if the final action in your metric contains multiple components this keyword is used to specify the component that should be used |
| SERIAL | optional | false | do the calculation in serial |