schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
calqulus-pipeline.schema.json
acceleration
Derives the input signal to the second order. Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._ Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1. Only the first and second order is supported. Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._ Note: _This operation will split the series on gaps ...
{"type": "object", "properties": {"derivative": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["derivative"]}
calqulus-pipeline.schema.json
derivative
Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1. Only the first and second order is supported. Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._ Note: _This operation will split the series on gaps ...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Derives the input signal to the first order. Note: _Due to the temporal nature of this operation, the resulting first and last frame will be null._ Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._
{"type": "object", "properties": {"velocity": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["velocity"]}
calqulus-pipeline.schema.json
velocity
Derives the input signal to the first order. Note: _Due to the temporal nature of this operation, the resulting first and last frame will be null._ Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Runs a Butterworth IIR high-pass filter over the input data.
{"type": "object", "properties": {"highpass": {"additionalProperties": false, "type": ["string", "array", "null"]}, "extrapolate": {"additionalProperties": false, "type": ["string", "number"]}, "iterations": {"additionalProperties": false, "type": ["string", "number"]}, "cutoff": {"additionalProperties": false, "type":...
calqulus-pipeline.schema.json
highpass
Runs a Butterworth IIR high-pass filter over the input data.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
extrapolate
Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely. Leading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the orig...
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
iterations
Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
cutoff
Defines around what frequency to limit the filter. The filter will attenuate frequencies below this value.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
order
Defines the filter order. The higher the order, the steeper the attenuation slope will be.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
items
Runs a Butterworth IIR low-pass filter over the input data.
{"type": "object", "properties": {"lowpass": {"additionalProperties": false, "type": ["string", "array", "null"]}, "extrapolate": {"additionalProperties": false, "type": ["string", "number"]}, "iterations": {"additionalProperties": false, "type": ["string", "number"]}, "cutoff": {"additionalProperties": false, "type": ...
calqulus-pipeline.schema.json
lowpass
Runs a Butterworth IIR low-pass filter over the input data.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
extrapolate
Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely. Leading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the orig...
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
iterations
Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
cutoff
Defines around what frequency to limit the filter. The filter will attenuate frequencies above this value.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
order
Defines the filter order. The higher the order, the steeper the attenuation slope will be.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
items
Outputs the arc cosine (or inverse cosine) for each value in the input signal.
{"type": "object", "properties": {"acos": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["acos"]}
calqulus-pipeline.schema.json
acos
Outputs the arc cosine (or inverse cosine) for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the arcsine (or inverse sine) for each value in the input signal.
{"type": "object", "properties": {"asin": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["asin"]}
calqulus-pipeline.schema.json
asin
Outputs the arcsine (or inverse sine) for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the arctangent (or inverse sine) for each value in the input signal.
{"type": "object", "properties": {"atan": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["atan"]}
calqulus-pipeline.schema.json
atan
Outputs the arctangent (or inverse sine) for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.
{"type": "object", "properties": {"atan2": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["atan2"]}
calqulus-pipeline.schema.json
atan2
Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the cosine for each value in the input signal.
{"type": "object", "properties": {"cos": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["cos"]}
calqulus-pipeline.schema.json
cos
Outputs the cosine for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the hyperbolic cosine for each value in the input signal.
{"type": "object", "properties": {"cosh": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["cosh"]}
calqulus-pipeline.schema.json
cosh
Outputs the hyperbolic cosine for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the cotangent for each value in the input signal.
{"type": "object", "properties": {"cotan": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["cotan"]}
calqulus-pipeline.schema.json
cotan
Outputs the cotangent for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the sine for each value in the input signal.
{"type": "object", "properties": {"sin": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["sin"]}
calqulus-pipeline.schema.json
sin
Outputs the sine for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the hyperbolic sine for each value in the input signal.
{"type": "object", "properties": {"sinh": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["sinh"]}
calqulus-pipeline.schema.json
sinh
Outputs the hyperbolic sine for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the tangent for each value in the input signal.
{"type": "object", "properties": {"tan": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["tan"]}
calqulus-pipeline.schema.json
tan
Outputs the tangent for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Outputs the hyperbolic tangent for each value in the input signal.
{"type": "object", "properties": {"tanh": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["tanh"]}
calqulus-pipeline.schema.json
tanh
Outputs the hyperbolic tangent for each value in the input signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Runs a logical expression. The return value is determined by the result of the expression, and the then and else options. The following operators are supported: >= Parentheses can be used to influence the order of evaluation. Only numbers and single-element arrays can be part of the expression.
{"type": "object", "properties": {"if": {"additionalProperties": false, "type": ["string", "array", "null"]}, "then": {"additionalProperties": false}, "else": {"additionalProperties": false}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["if", "then", "else"]}
calqulus-pipeline.schema.json
if
Runs a logical expression. The return value is determined by the result of the expression, and the then and else options. The following operators are supported: >= Parentheses can be used to influence the order of evaluation. Only numbers and single-element arrays can be part of the expression.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
then
{"additionalProperties": false}
calqulus-pipeline.schema.json
else
{"additionalProperties": false}
calqulus-pipeline.schema.json
items
Imports an event by name.
{"type": "object", "properties": {"event": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["event"]}
calqulus-pipeline.schema.json
event
Imports an event by name.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Generic import of any input by name.
{"type": "object", "properties": {"import": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["import"]}
calqulus-pipeline.schema.json
import
Generic import of any input by name.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
Imports a marker series by name or creates a new signal with a custom origin.
{"type": "object", "properties": {"marker": {"additionalProperties": false, "type": ["string", "array", "null"]}, "origin": {"additionalProperties": false, "type": ["string", "array"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["marker"]}
calqulus-pipeline.schema.json
marker
Imports a marker series by name or creates a new signal with a custom origin.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
origin
This option can be used to create a new marker signal, with a custom x, y and z coordinate.
{"additionalProperties": false, "type": ["string", "array"]}
calqulus-pipeline.schema.json
items
Imports a segment series by name.
{"type": "object", "properties": {"segment": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["segment"]}
calqulus-pipeline.schema.json
segment
Imports a segment series by name.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
This step takes 2 event inputs and outputs an array of durations (in seconds). Inputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2. The duration is calculated using the frame rate from either the "from", or "to" input event.
{"type": "object", "properties": {"eventDuration": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["eventDuration"]}
calqulus-pipeline.schema.json
eventDuration
This step takes 2 event inputs and outputs an array of durations (in seconds). Inputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2. The duration is calculated using the frame rate from either the "from", or "to" input event.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events. Inputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3. These pairs can be used to filter the values in input 1. These event pairs, or cycles are also...
{"type": "object", "properties": {"eventMask": {"additionalProperties": false, "type": ["string", "array", "null"]}, "keep": {"additionalProperties": false, "type": ["string", "number", "array"]}, "replacement": {"additionalProperties": false, "type": ["string", "number"]}, "truncate": {"additionalProperties": false, "...
calqulus-pipeline.schema.json
eventMask
This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events. Inputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3. These pairs can be used to filter the values in input 1. These event pairs, or cycles are also...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
keep
An index or an array of indices of events in each cycle to keep. This allows you to keep only a subset of event instances in each cycle. Negative numbers can be used to count from the end of the cycle, e.g. -1 is the last event in the cycle. Note: This only applies to event inputs.
{"additionalProperties": false, "type": ["string", "number", "array"]}
calqulus-pipeline.schema.json
replacement
Replacement value to use for masked values. If not set, masked values will be removed from the output signal. The replacement property has no effect when the signal input is an event.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
truncate
Whether or not the signal should be truncated, i.e., if values that were not within an "event pair" should be removed or not. This will only apply if replacement does not have a value.
{"additionalProperties": false, "type": ["string", "boolean"]}
calqulus-pipeline.schema.json
items
This step takes an event input and converts each frame value to a time value (in seconds). The time is calculated using the frame rate from the signal.
{"type": "object", "properties": {"eventTime": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["eventTime"]}
calqulus-pipeline.schema.json
eventTime
This step takes an event input and converts each frame value to a time value (in seconds). The time is calculated using the frame rate from the signal.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events. The main input of this step is the event you want to select frames from. The required option sequence defines a sequence of events to happen in order. This option requires at least one instance o...
{"type": "object", "properties": {"refineEvent": {"additionalProperties": false, "type": ["string", "array", "null"]}, "sequence": {"additionalProperties": false, "type": ["string", "array"]}, "exclude": {"additionalProperties": false, "type": ["string", "array"]}, "cyclic": {"additionalProperties": false, "type": ["st...
calqulus-pipeline.schema.json
refineEvent
This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events. The main input of this step is the event you want to select frames from. The required option sequence defines a sequence of events to happen in order. This option requires at least one instance o...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
sequence
A sequence of events. This must include at least one instance of the main input event.
{"additionalProperties": false, "type": ["string", "array"]}
calqulus-pipeline.schema.json
exclude
Event(s) that will invalidate an event sequence if found within it.
{"additionalProperties": false, "type": ["string", "array"]}
calqulus-pipeline.schema.json
cyclic
Whether or not to treat sequences as cyclic (true as default).
{"additionalProperties": false, "type": ["string", "boolean"]}
calqulus-pipeline.schema.json
items
Find peaks inside a signal based on peak properties. At first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria. As a last step, if the sequence option is used, it will...
{"type": "object", "properties": {"peakFinder": {"additionalProperties": false, "type": ["string", "array", "null"]}, "distance": {"additionalProperties": false, "type": ["string", "number", "array"]}, "height": {"additionalProperties": false, "type": ["string", "number", "array"]}, "prominence": {"additionalProperties...
calqulus-pipeline.schema.json
peakFinder
Find peaks inside a signal based on peak properties. At first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria. As a last step, if the sequence option is used, it will...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
distance
Required minimal horizontal distance (>= 1) in samples between neighbouring peaks. Smaller peaks are removed first until the condition is fulfilled for all remaining peaks.
{"additionalProperties": false, "type": ["string", "number", "array"]}
calqulus-pipeline.schema.json
height
Required height of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required height.
{"additionalProperties": false, "type": ["string", "number", "array"]}
calqulus-pipeline.schema.json
prominence
Required prominence of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required prominence.
{"additionalProperties": false, "type": ["string", "number", "array"]}
calqulus-pipeline.schema.json
relHeight
Used for calculation of the peaks width, thus it is only used if width is given. Chooses the relative height at which the peak width is measured as a percentage of its prominence. 1.0 calculates the width of the peak at its lowest contour line while 0.5 evaluates at half the prominence height. Must be at least 0.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
sequence
Allows to classify peaks using a pattern and select peaks from the pattern to use as the output. See below for further information.
{"additionalProperties": false, "type": ["object"], "properties": {"ranges": {"additionalProperties": false, "type": ["string"]}, "pattern": {"additionalProperties": false, "type": ["string"]}, "keep": {"additionalProperties": false, "type": ["string", "array"]}}}
calqulus-pipeline.schema.json
ranges
Classification of the peak heights. This option expects a string consisting of 1-character labels separated by a boundary value. The boundary values represent a percentage between 0 – 100 which defined the end of the previous label's range and the beginning of the next label's range. The entire range 0 – 100 represen...
{"additionalProperties": false, "type": ["string"]}
calqulus-pipeline.schema.json
pattern
A pattern describing a sequence of classified peak heights using the labels defined in the ranges option. If you have supplied the ranges string L 50 H, and you want to find the following sequence of peaks: "a low peak followed by a low peak followed by a high peak, you can define the pattern as LLH. Each matching pa...
{"additionalProperties": false, "type": ["string"]}
calqulus-pipeline.schema.json
keep
An array of indices from the pattern labels to keep in the output. The index is zero-based, i.e., the first item in the sequence pattern is 0, the last in the sequence is the (length of the pattern) - 1. If the pattern was defined as LLH and we wanted to keep only the first (low) peak in each matching sequence, we wou...
{"additionalProperties": false, "type": ["string", "array"]}
calqulus-pipeline.schema.json
width
Required width of peaks in samples. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required width.
{"additionalProperties": false, "type": ["string", "number", "array"]}
calqulus-pipeline.schema.json
window
Used for calculation of the peaks prominences, thus it is only used if one of the arguments prominence or width is given. A window length in samples that optionally limits the evaluated area for each peak to a subset of x. The peak is always placed in the middle of the window therefore the given length is rounded up t...
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
items
This step will register an event for every frame where the signal passes the specified threshold value. By default, an event is registered when the signal crosses the threshold in either an ascending or descending direction. By configuring the direction option, you can specify a certain direction that will trigger th...
{"type": "object", "properties": {"threshold": {"additionalProperties": false, "type": ["string", "array", "null"]}, "value": {"additionalProperties": false, "type": ["string", "number"]}, "direction": {"additionalProperties": false, "type": ["string"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ...
calqulus-pipeline.schema.json
threshold
This step will register an event for every frame where the signal passes the specified threshold value. By default, an event is registered when the signal crosses the threshold in either an ascending or descending direction. By configuring the direction option, you can specify a certain direction that will trigger th...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
value
The threshold value to use.
{"additionalProperties": false, "type": ["string", "number"]}
calqulus-pipeline.schema.json
direction
The direction of crossing the threshold to record.
{"additionalProperties": false, "type": ["string"]}
calqulus-pipeline.schema.json
items
The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.
{"type": "object", "properties": {"concatenate": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["concatenate"]}
calqulus-pipeline.schema.json
concatenate
The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
items
The vector step takes one or three inputs and outputs a vector sequence signal. If given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively. Alternatively, if only one input is given and it contains at least three components, the first three component...
{"type": "object", "properties": {"vector": {"additionalProperties": false, "type": ["string", "array", "null"]}, "export": {}, "output": {}, "set": {}, "space": {}}, "required": ["vector"]}
calqulus-pipeline.schema.json
vector
The vector step takes one or three inputs and outputs a vector sequence signal. If given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively. Alternatively, if only one input is given and it contains at least three components, the first three component...
{"additionalProperties": false, "type": ["string", "array", "null"]}
calqulus-pipeline.schema.json
where
When importing a signal or defining an output node, you can specify a measurement from which the signal should be imported – or for which measurement an output node should run. You can filter measurements by name and by field values and you can use wildcard characters `*` to formulate patterns to match partial values....
{"type": "object", "properties": {"name": {"type": "string"}, "index": {"type": ["integer", "string"], "if": {"type": "string"}, "then": {"enum": ["first", "last"]}}, "fields": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}
calqulus-pipeline.schema.json
name
Target a measurement by name
{"type": "string"}
calqulus-pipeline.schema.json
index
Out of a number of matching measurements, pick the nth match. Either a 1-based index, or the values `first` or `last` to select the first or last match, respectively.
{"type": ["integer", "string"], "if": {"type": "string"}, "then": {"enum": ["first", "last"]}}
calqulus-pipeline.schema.json
fields
Target a measurement by a field value.
{"type": "object", "additionalProperties": {"type": "string"}}
calqulus-pipeline.schema.json
set
Used to specify which _set_ the exported parameter will use. In most cases, this will be either `left` or `right`. If not set, the JSON output will use set: null.
{"type": "string"}
calqulus-pipeline.schema.json
spaceOrigin
Sets the origin of a custom coordinate system.
{"type": ["string", "array"]}
calqulus-pipeline.schema.json
spacePrimaryAxis
Sets the primary axis of a custom coordinate system. The primary axis of the custom coordinate system will always be a unit vector with the same direction as this vector. If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the primar...
{"type": ["string", "array"]}
calqulus-pipeline.schema.json
spaceSecondaryAxis
Sets the secondary axis of a custom coordinate system. The actual secondary axis of the custom coordinate system might differ from the vector specified, since the secondary axis must be a unit vector perpendicular to the primary axis. If more than one vectors is given, for example [myMarker1, myMarker2], the vecto...
{"type": ["string", "array"]}
calqulus-pipeline.schema.json
spaceOrder
Defines what axis the primary and secondary axis corresponds to. The first letter defines the name of the primary axis, and the second letter defines the name of the secondary axis. Possible values: xy - Primary axis: x, secondary axis: y yx - Primary axis: y, secondary axis: x xz - Primary axis: x, secondary axis...
{"type": "string", "enum": ["xy", "yx", "xz", "yz", "zy"]}
calqulus-pipeline.schema.json
spaceAlignWithSegment
Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space. The rotation is based on the average orientation of the segment during a measurement.
{"type": ["object"], "properties": {"segment": {"type": "string"}}, "required": ["segment"]}
calqulus-pipeline.schema.json
segment
Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space. The rotation is based on the average orientation of the segment during a measurement.
{"type": "string"}
calqulus-pipeline.schema.json
Parameter Node
A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.
{"type": "object", "properties": {"parameter": {}, "steps": {}, "where": {}, "set": {}}, "required": ["parameter", "steps"], "additionalProperties": false}
calqulus-pipeline.schema.json
globalOption export
If this option is set, the result of this step will be exposed on the global scope, as well as being exported to the resulting JSON file. The value of this option will be the name of the exported data and can be used to load the resulting data in other steps.
{"additionalProperties": false, "type": ["string"], "name": "export"}
calqulus-pipeline.schema.json
globalOption output
If this option is set, the result of this step will be exposed on the local scope. The value of this option will be the name of the output data and can be used to load the resulting data in other steps within the same output node. You can also use the short-form "arrow syntax" to define an output.
{"additionalProperties": false, "type": ["string"], "name": "output"}