get

Get WPTREE contents

collapse all in page

    Syntax

    [FieldValue1,FieldValue2,…] = get(T,FieldName1,FieldName2,…)
    [___] = get(T)

    Description

    [FieldValue1,FieldValue2,…] = get(T,FieldName1,FieldName2,…) returns the contents of the specified fields for the wavelet packet tree T.

    For the fields that are objects or structures, you can also get the subfield contents.

    example

    [___] = get(T) returns all the field contents of the tree T.

    Examples

    collapse all

    Open Live Script

    Create a wavelet packet tree.

    x = rand(1,1000);
t = wpdec(x,2,"db2");

    Obtain the order of the NTREE parent.

    o = get(t,'order')
    o = 
2

    Obtain the order and the terminal nodes of the NTREE parent

    [o,tn] = get(t,'order','tn')
    o = 
2

    tn = 4×1

     3
     4
     5
     6

    Obtain the order of the NTREE parent, all nodes information from the DTREE parent, and the terminal nodes of the NTREE parent.

    [o,allNI,tn] = get(t,'order','allNI','tn');

    Obtain the order of the NTREE parent, the wavelet information structure of the wavelet packet tree, all nodes information from the DTREE parent, and the terminal nodes of the NTREE parent.

    [o,wavInfo,allNI,tn] = get(t,'order','wavInfo','allNI','tn');

    Obtain the order and the terminal nodes of the NTREE parent, the lowpass decomposition filter from the wavelet information structure, and all nodes information from the DTREE parent.

    [o,tn,Lo_D,EntName] = get(t,'order','tn','Lo_D','EntName');

    Obtain the WBTO parent, NTREE parent, and DTREE parent.

    [wo,nt,dt] = get(t,'wtbo','ntree','dtree');

    Input Arguments

    collapse all

    Wavelet packet tree, specified as a wptree object.

    Names of fields and subfields of the wavelet packet tree T, specified as character vectors or string scalars.

    Valid field names of the wavelet packet tree T are:

    'dtree'

    DTREE parent object

    'wavInfo'

    Structure (wavelet information)

    'entInfo'

    Structure (entropy information)

    The fields of the wavelet information structure, 'wavInfo', are also valid:

    'wavName'

    Wavelet name

    'Lo_D'

    Lowpass decomposition filter

    'Hi_D'

    Highpass decomposition filter

    'Lo_R'

    Lowpass reconstruction filter

    'Hi_R'

    Highpass reconstruction filter

    The fields of the entropy information structure, 'entInfo', are also valid:

    'entName'

    Entropy name

    'entPar'

    Entropy parameter

    Or fields of the DTREE parent object:

    'ntree'

    NTREE parent object

    'allNI'

    All nodes information

    'terNI'

    Terminal nodes information

    Or fields of the NTREE parent object:

    'wtbo'

    WTBO parent object

    'order'

    Order of the tree

    'depth'

    Depth of the tree

    'spsch'

    Split scheme for nodes

    'tn'

    Array of terminal nodes of the tree

    Or fields of the WTBO parent object:

    'wtboInfo'

    Object information

    'ud'

    Userdata field

    Example: [a,b] = get(t,"wavInfo","depth") returns the wavelet information structure of the wavelet packet tree t and the depth of the NTREE parent object.

    Data Types: char | string

    Version History

    Introduced before R2006a

    See Also

    | | | |