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

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]).

itemsinteger

params*object

DSP parameters with values

Other propertiesnullable string

drawGraphs*boolean

Whether to generate graphs (will take longer)

requestPerformance*boolean

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

Response

Body

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'

itemsnumber

graphs*array of DspRunGraph (object)

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

name*string

Name of the graph

Example: "Frequency domain"

imagestring

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

imageMimeTypestring

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

Xobject

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

Other propertiesarray of number

itemsnumber

yarray of number

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

itemsnumber

suggestedXMinnumber

Suggested minimum value of x-axis

suggestedXMaxnumber

Suggested maxium value of x-axis

suggestedYMinnumber

Suggested minimum value of y-axis

suggestedYMaxnumber

Suggested maximum value of y-axis

type*string

Type of graph (either logarithmic, linear or image)

lineWidthnumber

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

smoothingboolean

Whether to apply smoothing to the graph.

axisLabelsobject

Labels for the graph x and y axes.

X*string

y*string

highlightsobject

Indices of points to highlight, per axis.

Other propertiesarray of number

itemsnumber

labelsarray of string

Labels of the feature axes

itemsstring

state_stringstring

String representation of the DSP state returned

performanceobject

latency*integer

ram*integer

Request

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": [],
      "params": {
        "scale-axes": "10"
      },
      "drawGraphs": false,
      "requestPerformance": false
    }),
});
const data = await response.json();

Response

{
  "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": {}
}