Main Content

read

Read next consecutive signal observation

Description

example

年代ig= read(年代ds)returns signal data extracted from the datastore. Each subsequent call toreadreturns data from the next file in the datastore (if年代dscontains file data) or the next member (if年代dscontains in-memory data).

[年代ig,info) =阅读(年代ds)also returns information about the extracted signal data.

Examples

collapse all

Specify the path to a set of audio signals included as MAT-files with MATLAB®.

folder = fullfile(matlabroot,'toolbox','matlab','audiovideo');

Create a signal datastore that points to the specified folder and set sample rate variable name toFs. List the names of the MAT-files in the datastore.

年代ds = signalDatastore(folder,'FileExtension','.mat','SampleRateVariableName','Fs'); [~,c] = fileparts(sds.Files)
c =7x1 cell{'chirp' } {'gong' } {'handel' } {'laughter'} {'mtlb' } {'splat' } {'train' }

While the signal datastore has unread files, read consecutive files from the datastore. Use theprogressfunction to monitor the fraction of files read.

whilehasdata(sds) [data,info] = read(sds); fprintf('Fraction of files read: %.2f\n',progress(sds))end
Fraction of files read: 0.14 Fraction of files read: 0.29 Fraction of files read: 0.43 Fraction of files read: 0.57 Fraction of files read: 0.71 Fraction of files read: 0.86 Fraction of files read: 1.00

Print and inspect theinfo年代tructure returned by the last call to thereadfunction.

info
info =年代truct with fields:SampleRate: 8192 TimeVariableName: "Fs" SignalVariableNames: "y" FileName: "/mathworks/devel/bat/Bdoc21b/build/matlab/toolbox/matlab/audiovideo/train.mat"

Create a signal datastore to iterate through the elements of an in-memory cell array of signal data. The data consists of a sinusoidally modulated linear chirp, a concave quadratic chirp, and a voltage controlled oscillator. The signals are sampled at 3000 Hz.

fs = 3000; t = 0:1/fs:3-1/fs; data = {chirp(t,300,t(end),800).*exp(2j*pi*10*cos(2*pi*2*t));...2*chirp(t,200,t(end),1000,'quadratic',[],'concave');...vco(sin(2*pi*t),[0.1 0.4]*fs,fs)}; sds = signalDatastore(data,'SampleRate',fs);

While the datastore has data, read each observation from the signal datastore and plot the short-time Fourier transform.

plotID = 1;whilehasdata(sds) [dataOut,info] = read(sds); subplot(3,1,plotID) stft(dataOut,info.SampleRate) plotID = plotID + 1;end

Figure contains 3 axes objects. Axes object 1 with title Short-Time Fourier Transform contains an object of type image. Axes object 2 with title Short-Time Fourier Transform contains an object of type image. Axes object 3 with title Short-Time Fourier Transform contains an object of type image.

Specify the path to four signals included with MATLAB®. The signals are recordings of a bird chirp, a gong, a train, and a splat. All signals are sampled at 8192 Hz.

folder = fullfile(matlabroot,'toolbox','matlab','audiovideo',...["chirp.mat","gong.mat","train.mat","splat.mat"]);

Create a signal datastore that points to the specified files. Each file contains the variableFsthat denotes the sample rate.

年代ds1 = signalDatastore(folder,'SampleRateVariableName','Fs');

Define a function that takes the output of thereadfunction and calculates the upper and lower envelopes of the signals using spline interpolation over local maxima separated by at least 80 samples. The function also returns the sample times for each signal.

function[dataOut,infoOut] = signalEnvelope(dataIn,info) [dataOut(:,1),dataOut(:,2)] = envelope(dataIn,80,'peak'); infoOut = info; infoOut.TimeInstants = (0:length(dataOut)-1)/info.SampleRate;end

Call thetransformfunction to create a second datastore,年代ds2, that computes the envelopes of the signals using the function you defined.

年代ds2 = transform(sds1,@signalEnvelope,"IncludeInfo",true);

Combine年代ds1and年代ds2create a third datastore. Each call to thereadfunction from the combined datastore returns a matrix with three columns:

  • The first column corresponds to the original signal.

  • The second and third columns correspond to the upper and lower envelopes, respectively.

年代dsCombined = combine(sds1,sds2);

Read and display the original data and the upper and lower envelopes from the combined datastore. Use theextractBetweenfunction to extract the file name from the file path.

tiledlayout('flow')whilehasdata(sdsCombined) [dataOut,infoOut] = read(sdsCombined); ts = infoOut{2}.TimeInstants; nexttile holdonplot(ts,dataOut(:,1),'Color','#DCDCDC','LineStyle',':') plot(ts,dataOut(:,2:3),'Linewidth',1.5) holdoffxlabel('Time (s)') ylabel('Signal') title(extractBetween(infoOut{:,2}.FileName,'audiovideo\','.mat'))end

图包含4轴对象。坐标轴对象1续ains 3 objects of type line. Axes object 2 contains 3 objects of type line. Axes object 3 contains 3 objects of type line. Axes object 4 contains 3 objects of type line.

Specify the path to four files included with Signal Processing Toolbox™. Each file contains a chirp and a random sample rate,fs, ranging from 100 to 150 Hz. Create a signal datastore that points to the specified folder.

folder = fullfile(matlabroot,'examples','signal','data','sample_chirps',...["chirp_1.mat","chirp_4.mat","chirp_9.mat","chirp_10.mat"]); sds = signalDatastore(folder,'SampleRateVariableName','fs');

Define a function that takes the output of thereadfunction and computes and returns:

  • The spectrograms of the chirps.

  • The vector of time instants corresponding to the centers of the windowed segments.

  • The frequencies corresponding to the estimates.

function[dataOut,infoOut] = extractSpectrogram(dataIn,info) [dataOut,F,T] = pspectrum(dataIn,info.SampleRate,'spectrogram',...'TimeResolution',0.25,...'OverlapPercent',40,'Leakage',0.8); infoOut = info; infoOut.CenterFrequencies = F; infoOut.TimeInstants = T;end

Call thetransformfunction to create a datastore that computes the spectrogram of each chirp using the function you defined.

年代dsNew = transform(sds,@extractSpectrogram,'IncludeInfo',true);

While the transformed datastore has unread files, read from the new datastore and visualize the spectrograms in three-dimensional space.

t = tiledlayout('flow');whilehasdata(sdsNew) nexttile [sig,infoOut] = read(sdsNew); waterfall(infoOut.TimeInstants,infoOut.CenterFrequencies,sig) xlabel('Frequency (Hz)') ylabel('Time (S)') view([30 70])end

图包含4轴对象。坐标轴对象1续ains an object of type patch. Axes object 2 contains an object of type patch. Axes object 3 contains an object of type patch. Axes object 4 contains an object of type patch.

Specify the file path to the example signals included with MATLAB®. Create a signal datastore that points to the specified folder.

folder = fullfile(matlabroot,'toolbox','matlab','audiovideo'); sds = signalDatastore(folder,'SampleRateVariableName','Fs');

Get the default number of partitions for the signal datastore.

n = numpartitions(sds)
n = 7

Partition the datastore into the default number of partitions and return the datastore corresponding to the fourth partition.

年代ubsds = partition(sds,n,4);

Use theextractAfterfunction to display the name of the file contained in the datastore corresponding to the fourth partition.

fName = extractAfter(subsds.Files,'audiovideo\')
fName =1x1 cell array{0x0 char}

Read the data and information about the signal in the datastore corresponding to the fourth partition. Extract the sample rate frominfoand resample the signal to half the original sample rate. Plot the original and resampled signals.

whilehasdata(subsds) [data,info] = read(subsds); fs = info.SampleRate; f_res = 0.5*fs; ts = (0:length(data)-1)/fs; data_res = resample(data,1,2); t_res = (0:length(data_res)-1)/f_res; plot(ts,data,t_res,data_res,':') xlabel('Time (s)') ylabel('Signal') legend('Original','Resampled','Location','NorthWest')end

Figure contains an axes object. The axes object contains 2 objects of type line. These objects represent Original, Resampled.

Input Arguments

collapse all

Signal datastore, specified as a年代ignalDatastoreobject.

Output Arguments

collapse all

Signal data, returned as an array. By default, callingreadonce returns the first variable of one file at a time. If you set theReadSizeproperty ton, such thatn> 1, each time you call thereadfunction, the function reads:

  • The first variable of the firstnfiles, if年代dscontains file data.

  • The firstnmembers, if年代dscontains in-memory data.

Note

To determine the name of the first variable in a file,readfollows these steps:

  • For MAT-files:

    年代= load(fileName); varNames = fieldnames(s); firstVar = s.(varNames{1});

  • For CSV files:

    opts = detectImportOptions(fileName,'PreserveVariableNames',true); varNames = opts.VariableNames; firstVar = string(varNames{1});

If theSignalVariableNamesproperty of the datastore contains more than one signal name, then年代igis a cell array. Use theReadOutputOrientationproperty of the datastore to control the orientation of年代igas either a column array or a row array.

Information about signal data, returned as a structure.

  • In case of file data,infocontains the time information (if specified), file names, and the variable names used to read signal and time data, if this information was specified in the年代ignalDatastore.

  • If the datastore contains in-memory data,infocontains time information (if specified) and member names.

Introduced in R2020a