nwdata class
Data object that stores the measured excitation and node signals of a networked system, and their properties. These signals may be obtained from a subset of the nodes and/or excitation signals of the full network.
Construction
data = nwdata(r,w)
creates a network data object with excitation datar
and node dataw
.data = nwdata(r,w,Ts)
creates a network data object with defined time step.data = nwdata(iddata)
creates a network data object from aniddata
object (from the System Identification toolbox). Input data, names and units are mapped to excitation properties and output data, names and units are mapped to node properties. Other properties that exist in bothnwdata
andiddata
are mapped to the new object.data = nwdata(path)
creates a network data object from file, previously stored using thesave
method.data = nwdata(__,Name=Value)
creates a network data object with additional properties set according to the provided values. All (non-dependent) properties can be set in this way.
Properties
Name
character array string Name of data set. Empty by default.
SystemName
character array string Name of the system. Empty by default.
ExperimentName
character array string Name of the experiment. Empty by default.
ExcitationData
double array Excitation signals. Cannot be modified after construction
ExcitationNames
string array Physical names of excitation signals. Array of empty strings by default.
ExcitationLabelNrs
integer array Network label numbers of excitation signals. In identification, these are matched to the network label numbers of a
LabelledAdjStruct
object. By default, these labels are[1, 2, ...]
. The labels must be unique.ExcitationLabels
string array Network labels of excitation signals. Based on the
ExcitationLabelNrs
property.ExcitationUnits
string array Units of excitation signals. Array of empty strings by default.
NodeData
double array Node signals. Cannot be modified after construction.
NodeNames
string array Physical names of node signals. Array of empty strings by default.
NodeLabelNrs
integer array Network label numbers of node signals. In identification, these are matched to the network label numbers of a
LabelledAdjStruct
object. By default, these labels are[1, 2, ...]
. The labels must be unique.NodeLabels
string array Network labels of node signals. Based on the
NodeLabelNrs
property.NodeUnits
string array Units of node signals. Array of empty strings by default.
Domain
Domains
enumeration objectDomain of the data set. Can be either 'Time' or 'Frequency'. 'Time' by default.
Ts
positive scalar Sample time. Defaults to 1.
N
positive scalar Number of samples, determined from
NodeData
.r
double array Shorthand for
ExcitationData
w
double array Shorthand for
NodeData
Methods
save
Save properties of the object.
Syntax
save(data,path)
stores astruct
containing the properties of the data object at the location specified bypath
.
Input arguments
data
nwdata
objectpath
character array string Path to folder in which the data should be stored.
get
Displays the properties of the object.
Syntax
get(data)
displays astruct
containing the properties of thenwdata
object.
Input arguments
data
nwdata
object
iddata
Convert to
iddata
object.Syntax
iddata(data)
converts thenwdata
object to aiddata
object with analogous properties.
Input arguments
Network data
nwdata
object
Output arguments
Input-output data
iddata
object
disp
Display information about the data.
Syntax
data
prints information about the data to the output.disp(data)
Input arguments
data
nwdata
object
wIndexFromLabelNrs
Get indices of nodes based on node label numbers.
Syntax
wIndexFromLabelNrs(data,labelNrs)
retrieves node indices from label numbers.
Input arguments
data
nwdata
objectlabelNrs
integer array Label numbers
rIndexFromLabelNrs
Get indices of excitations based on excitation label numbers.
Syntax
rIndexFromLabelNrs(data,labelNrs)
retrieves excitation indices from label numbers.
Input arguments
data
nwdata
objectlabelNrs
integer array Label numbers