Get processed sample (slice)

Get slice of sample data, and run it through the DSP block. This 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.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice/run/readonly

Path parameters

projectId*integer

Project ID

dspId*integer

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

sampleId*integer

Sample ID

Query parameters

sliceStart*integer

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.

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

labelAtEndOfWindowstring

Label for the window (only present for time-series data)

sample*RawSampleData (object)

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

performanceobject

latency*integer

ram*integer

canProfilePerformance*boolean

Request

Response