Main Content

set

Set WPTREE field contents

collapse all in page

    Syntax

    T= set(T,Name=Value)

    Description

    T= set(T,Name=Value) sets the contents of the fields for the wavelet packet tree T using one or more name-value arguments. For the fields that are objects or structures, you can also set the subfield contents.

    Caution

    The set function should only be used to set the field ud.

    example

    Examples

    collapse all

    Open Live Script

    Load a signal. Decompose the signal at level 3 with db1 wavelet packets. The decomposition is a wptree object.

    load noisdopp
wpt = wpdec(noisdopp,3,"db1");
whos wpt
      Name      Size            Bytes  Class     Attributes

  wpt       1x1             12239  wptree

    Save the name of the signal in the user data field of the wavelet packet tree.

    wpt = set(wpt,ud="Signal name: noisdopp");

    Confirm the user data field contains the name.

    get(wpt,"ud")
    ans = 
'Signal name: noisdopp'

    Input Arguments

    collapse all

    Wavelet packet tree, specified as a wptree object.

    Name-Value Arguments

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: T = set(T,ud="helloWorld")

    Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

    Example: T = set(T,"ud","helloWorld")

    Parent Fields

    collapse all

    Parent object, specified as a dtree object.

    Wavelet information, specified as a structure array.

    Data Types: struct

    wavInfo Fields

    collapse all

    Wavelet name, specified as a character vector or string scalar.

    Data Types: char | string

    Lowpass decomposition filter, specified as a vector.

    Data Types: double

    Highpass decomposition filter, specified as a vector.

    Data Types: double

    Lowpass reconstruction filter, specified as a vector.

    Data Types: double

    Highpass reconstruction filter, specified as a vector.

    Data Types: double

    Entropy information, specified as a structure array.

    Data Types: struct

    entInfo Fields

    collapse all

    Entropy name, specified as a character vector or string scalar

    Data Types: char | string

    Entropy parameter, specified as a scalar, character vector, or string scalar

    Data Types: double | char | string

    dtree Fields

    collapse all

    Parent object of dtree, specified as a ntree object.

    All nodes information, specified as a matrix.

    Data Types: double

    Terminal nodes information, specified as a cell array.

    Data Types: cell

    ntree Fields

    collapse all

    Parent object of ntree, specified as a wtbo object.

    Order of the tree, specified as an integer.

    Data Types: double

    Depth of the tree, specified as an integer.

    Data Types: double

    Split scheme for the nodes, specified as a vector of logical values.

    Data Types: logical

    Array of terminal nodes of the tree, specified as a vector of node indices.

    Data Types: double

    wtbo Fields

    collapse all

    Object information, specified as a character vector or string scalar.

    Data Types: char | string

    User data, specified as an array, cell array, or structure array.

    Data Types: double | struct | cell

    Version History

    Introduced before R2006a

    See Also

    | | |