Get processed sample (from features array)

Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.

POST /api/{projectId}/dsp/{dspId}/run

Try it

Get processed sample (from features array)

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "features": [
    123
  ],
  "params": {
    "scale-axes": "10"
  },
  "drawGraphs": true,
  "requestPerformance": true
}
'

200

{
  "success": true,
  "features": [
    123
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "type": "<string>",
      "image": "<string>",
      "imageMimeType": "<string>",
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "y": [
        0,
        0.5,
        1
      ],
      "suggestedXMin": 123,
      "suggestedXMax": 123,
      "suggestedYMin": 123,
      "suggestedYMax": 123,
      "lineWidth": 123,
      "smoothing": true,
      "axisLabels": {
        "X": "<string>",
        "y": "<string>"
      },
      "highlights": {}
    }
  ],
  "error": "<string>",
  "labels": [
    "<string>"
  ],
  "state_string": "<string>",
  "performance": {
    "latency": 123,
    "ram": 123,
    "customDspString": "<string>"
  }
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

dspId · integer · required

DSP Block ID, use the impulse functions to retrieve the ID

Body

application/json

features · integer[] · required

Array of features. If you have multiple axes the data should be interleaved (e.g. [ax0_val0, ax1_val0, ax2_val0, ax0_val1, ax1_val1, ax2_val1]).

params · object · required

DSP parameters with values

Show child attributes

params. {key} · string | null

Example:

{ "scale-axes": "10" }

drawGraphs · boolean · required

Whether to generate graphs (will take longer)

requestPerformance · boolean · required

Whether to request performance info (will take longer unless cached)

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

features · number[] · required

Array of processed features. Laid out according to the names in 'labels'

graphs · object[] · required

Graphs to plot to give an insight in how the DSP process ran

Show child attributes

graphs. name · string · required

Name of the graph

Example:

"Frequency domain"

graphs. type · string · required

Type of graph (either logarithmic, linear or image)

graphs. image · string

Base64 encoded image, only present if type is 'image'

graphs. imageMimeType · string

Mime type of the Base64 encoded image, only present if type is 'image'

graphs. X · object

Values on the x-axis per plot. Key is the name of the raw feature. Present if type is 'logarithmic' or 'linear'.

Show child attributes

graphs.X. {key} · number[]

Example:

{ "accX": [3, 5, 7], "accY": [2, 1, 5] }

graphs. y · number[]

Values of the y-axis. Present if type is 'logarithmic' or 'linear'.

Example:

[0, 0.5, 1]

graphs. suggestedXMin · number

Suggested minimum value of x-axis

graphs. suggestedXMax · number

Suggested maxium value of x-axis

graphs. suggestedYMin · number

Suggested minimum value of y-axis

graphs. suggestedYMax · number

Suggested maximum value of y-axis

graphs. lineWidth · number

Width of the graph line (if type is logarithmic or linear). Default 3.

graphs. smoothing · boolean

Whether to apply smoothing to the graph.

graphs. axisLabels · object

Labels for the graph x and y axes.

Show child attributes

graphs.axisLabels. X · string · required

graphs.axisLabels. y · string · required

graphs. highlights · object

Indices of points to highlight, per axis.

Show child attributes

graphs.highlights. {key} · number[]

error · string

Optional error description (set if 'success' was false)

labels · string[]

Labels of the feature axes

state_string · string

String representation of the DSP state returned

performance · object

Show child attributes

performance. latency · integer · required

performance. ram · integer · required

performance. customDspString · string

If the project latencyDevice has custom DSP hardware, this value contains a device specific latency metric (eg. cycles)