Get processed sample (from features array)

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.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/run

Path parameters

projectId*integer

Project ID

dspId*integer

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

Body

application/json

features*array of integer

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

DSP parameters with values

drawGraphs*boolean

Whether to generate graphs (will take longer)

requestPerformance*boolean

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

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

features*array of number

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

graphs*array of DspRunGraph (object)

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

labelsarray of string

Labels of the feature axes

state_stringstring

String representation of the DSP state returned

performanceDspPerformance (object)

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "features": [
        0
      ],
      "params": {
        "scale-axes": "10"
      },
      "drawGraphs": false,
      "requestPerformance": false
    }),
});
const data = await response.json();

Response

200

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