Configuration

Configuration
This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates this Agent to a specific Collection and defaults to that of the current Data Stream.
Visit Collections and Stream Hosts to understand more about Collections.
Attributes
Property
Description
Signal
The field in the input payload containing the signal value.
Identifier
The field to use as an identifier for the signal data.
Optional.

Note: the first value in a batch will be used as the identifier for all values in the batch, so the identifier should be consistent throughout the batch of values.
Settings
Filter
The type of filter to apply:
High Pass, Low Pass or Band Pass
Sampling Frequency
The frequency in Hz of the signal values.
For example, if the signal is sampled 100 times per second (i.e. every 0.01 seconds) the sampling frequency is 100Hz.
Cutoff Frequency (Low)
All frequencies below this value will be allowed to pass through.
Only visible if Low Pass or Band Pass is selected for Filter.
Cutoff Frequency (High)
All frequencies above this value will be allowed to pass through.
Only visible if High Pass or Band Pass is selected for Filter.
Order
The number of previous points of data to use when calculating the current output.
The default is zero, meaning no previous points are used, only the current point is taken into account.
Before configuring the Transformation, please ensure that its Input Endpoint is connected to a parent Agent which will be sending data to it.
Endpoints
Name
Description
Input
The input signal to be filtered.
Output
Events received from the parent Agent which match the filter are made available to this endpoint with a Filtered Signal attribute and an optional Identifier attribute. 
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
Collection	This associates this Agent to a specific Collection and defaults to that of the current Data Stream.

Property	Description
Signal	The field in the input payload containing the signal value.
Identifier	The field to use as an identifier for the signal data. Optional. Note: the first value in a batch will be used as the identifier for all values in the batch, so the identifier should be consistent throughout the batch of values.

Name	Description
Input	The input signal to be filtered.
Output	Events received from the parent Agent which match the filter are made available to this endpoint with a Filtered Signal attribute and an optional Identifier attribute.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

Last modified 1yr ago

Filter	The type of filter to apply: High Pass, Low Pass or Band Pass
Sampling Frequency	The frequency in Hz of the signal values. For example, if the signal is sampled 100 times per second (i.e. every 0.01 seconds) the sampling frequency is 100Hz.
Cutoff Frequency (Low)	All frequencies below this value will be allowed to pass through. Only visible if Low Pass or Band Pass is selected for Filter.
Cutoff Frequency (High)	All frequencies above this value will be allowed to pass through. Only visible if High Pass or Band Pass is selected for Filter.
Order	The number of previous points of data to use when calculating the current output. The default is zero, meaning no previous points are used, only the current point is taken into account.