DSP

Get raw sample (slice)

Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.

get/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice

Request

Path parameters

projectIdinteger required

Project ID

dspIdinteger required

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

sampleIdinteger required

Sample ID

Query parameters

sliceStartinteger required

Begin index of the slice

sliceEndinteger

End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.

truncateStructuredLabelsboolean

If true, only a slice of labels will be returned for samples with multiple labels.

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

totalPayloadLengthinteger required

Total number of payload values

Example response

{
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "datastreams": [
      {
        "sensors": [
          {
            "name": "accX"
          }
        ]
      }
    ]
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "cropEnd": 128,
    "intervalMs": 16,
    "frequencyHz": 62.5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.