# doc-cache created by Octave 10.2.0
# name: cache
# type: cell
# rows: 3
# columns: 16
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
depthIndex2NodeNo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 454
 -- Function: depthIndex2NodeNo
     DEPTHINDEX2NODENO Get node from depth and index in the tree
        Usage: [nodeNo,nodeChildIdx] = depthIndex2NodeNo(d,k,wt)
     
        [nodeNo,nodeChildIdx] = DEPTHINDEX2NODENO(d,k,wt) returns node 
        nodeNo and an array of its children nodes nodeChildIdx positioned
        in depth g and index k in the tree wt.
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/depthIndex2NodeNo.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
DEPTHINDEX2NODENO Get node from depth and index in the tree
   Usage: [nodeNo...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
nat2freqOrder


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 992
 -- Function: nat2freqOrder
     NAT2FREQORDER Natural To Frequency Ordering
        Usage:  wt = nat2freqOrder(wt);
     
        Input parameters:
              wt    : Structure containing description of the filter tree.
     
        Output parameters:
              wt    : Structure containing description of the filter tree.
     
        NAT2FREQORDER(wt) Creates new wavelet filterbank tree definition
        with permuted order of some filters for purposes of the correct frequency
        ordering of the resultant identical filters and coefficient subbands. 
        For definition of the structure see WFBINIT and DTWFBINIT.
     
        NAT2FREQORDER(wt,nodes) does the same but works only with nodes
        listed in nodes.
     
        NAT2FREQORDER(...,'rev') changes the frequency ordering back to
        natural ordering.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nat2freqOrder.html>

     See also: wfbtinit, wfbtmultid, nodebforder.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 78
NAT2FREQORDER Natural To Frequency Ordering
   Usage:  wt = nat2freqOrder(wt);



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
nodeBForder


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 673
 -- Function: nodeBForder
     NODEBFORDER Nodes in the Breadth-First search order
       Usage:  nodesIdxs = nodeBForder(nodeNo,wt)
     
        Input parameters:
              nodeNo : Id of a node.
              wt     : Structure containing description of the filter tree.
     
        Output parameters:
              nodesIdxs   : Node indexes in the Breadth-First search order.
     
        NODEBFORDER(nodeNo,wt) For definition of the structure see
        wfbinit. nodeNo defaults to the root node if it is empty or equal
        to 0.
     
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodeBForder.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODEBFORDER Nodes in the Breadth-First search order
  Usage:  nodesIdxs = nod...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
nodeSubtreeDelete


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 437
 -- Function: nodeSubtreeDelete
     DELETESUBTREE Removes subtree with root node
        Usage:  wt = nodeSubtreeDelete(nodeNo,wt)
     
        Input parameters:
              nodeNo   : Node index.
              wt       : Structure containing description of the filter tree.
     
        Output parameters:
              wt       : Modified wt.
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodeSubtreeDelete.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
DELETESUBTREE Removes subtree with root node
   Usage:  wt = nodeSubtreeDelet...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
nodesFiltUps


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 640
 -- Function: nodesFiltUps
     NODEFILTUPS  Node upsamplig factor
        Usage:  upsNo = nodesFiltUps(nodeNo,wt)
     
        Input parameters:
              wt  : Structure containing description of the filter tree.
     
        Output parameters:
              upsNo : Accumulated upsampling factor along path to root.
     
        NODESFILTUPS(wt) Returns upsampling factor, which can be used to
        upsample the node filters using the a-trous algorithm.
        For definition of the structure see WFBINIT.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesFiltUps.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 77
NODEFILTUPS  Node upsamplig factor
   Usage:  upsNo = nodesFiltUps(nodeNo,wt)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
nodesInLen


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 784
 -- Function: nodesInLen
     NODESINLEN Length of the node input signal
        Usage:  L = nodesInLen(nodeNo,inLen,doExt,treeStruct);
     
        Input parameters:
              nodeNo     : Node index.
              inLen      : Filter thee input signal length.
              doNoExt    : Expansive representation indicator.
              wt         : Structure containing description of the filter tree.
     
        Output parameters:
              Lin        : Length of the node input signal 
     
        NODESINLEN(nodeNo,inLen,doExt,treeStruct) return length of the input
        signal of the node nodeNo. For definition of the structure see wfbinit.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesInLen.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODESINLEN Length of the node input signal
   Usage:  L = nodesInLen(nodeNo,i...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
nodesLocOutRange


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 670
 -- Function: nodesLocOutRange
     NODESLOCOUTRANGE Node output index range of the terminal outputs
        Usage:  outRange = nodesLocOutRange(nodeNo,wt);
     
        Input parameters:
              nodeNo     : Node index.
              wt : Structure containing description of the filter tree.
     
        Output parameters:
              noOut      : Index range. 
     
        NODESLOCOUTRANGE(nodeNo,wt) returns range of indexes of the
        terminal outputs of the node nodeNo. For definition of the structure
        see wfbinit.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesLocOutRange.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODESLOCOUTRANGE Node output index range of the terminal outputs
   Usage:  o...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
nodesMultid


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 719
 -- Function: nodesMultid
     NODESMULTID Filter tree multirate identity filterbank
        Usage:  [g,a]=nodesMultid(wtPath,rangeLoc,rangeOut,wt);
     
        Input parameters:
              wtPath   : Indexes of nodes to be processed in that order.
              rangeLoc : Idxs of each node terminal outputs. Length  
                         cell array of vectors.
              rangeOut : Output subband idxs of each node terminal outputs.
              wt       : Filter-Tree defining structure.
     
        Output parameters:
              g   : Cell array containing filters
              a   : Vector of subsampling factors
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesMultid.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODESMULTID Filter tree multirate identity filterbank
   Usage:  [g,a]=nodesM...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
nodesOutLen


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 881
 -- Function: nodesOutLen
     NODESOUTLEN Length of the node output
        Usage:  Lc = nodesOutLen(nodeNo,inLen,doExt,wt);
     
        Input parameters:
              nodeNo     : Node index(es).
              inLen      : Filter thee input signal length.
              outRange   : Cell array. Each element is a vector of local out.
              indexes.
              doNoExt    : Expansive representation indicator.
              wt         : Structure containing description of the filter tree.
     
        Output parameters:
              Lin        : Length of the node input signal 
     
        NODESOUTLEN(nodeNo,inLen,doExt,treeStruct) return length of the input
        signal of the node nodeNo. For definition of the structure see wfbinit.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesOutLen.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODESOUTLEN Length of the node output
   Usage:  Lc = nodesOutLen(nodeNo,inLe...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
nodesOutputsNo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 635
 -- Function: nodesOutputsNo
     NODESOUTPUTSNO Number of node Outputs
        Usage:  noOut = nodesOutputsNo(nodeNo,wt);
     
        Input parameters:
              nodeNo  : Node index.
              wt      : Structure containing description of the filter tree.
     
        Output parameters:
              noOut      : Number of node outputs. 
     
        NODESOUTPUTSNO(nodeNo,wt) Return number of the terminal 
        outputs of the node nodeNo. For definition of the structure
        see wfbinit.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/nodesOutputsNo.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
NODESOUTPUTSNO Number of node Outputs
   Usage:  noOut = nodesOutputsNo(nodeN...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
nodesSub


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 52
undocumented function: subNo = nodesSub (nodeNo, wt)


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 52
undocumented function: subNo = nodesSub (nodeNo, wt)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
treeBFranges


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1270
 -- Function: treeBFranges
     TREEBFRANGES Tree nodes output ranges in BF order
        Usage: [nodesBF, rangeLoc, rangeOut] = treeBFranges(wt);
               [nodesBF, rangeLoc, rangeOut] = treeBFranges(wt,'rev');
     
        Input parameters:
              wt       : Filterbank tree struct.
        Output parameters:
              nodesBF  : All nodes in a breadth-first order
              rangeLoc : Local ranges of unconnected (terminal) outputs
              rangeOut : Global ranges of unconnected (terminal) outputs
     
        [nodesBF, rangeLoc, rangeOut] = TREEBFRANGES(wt) is a helper function
        extracting all nodes of a tree in a BF order (root and low-pass first) 
        (numeric array of indexes nodesBF), and two cell arrays of ranges of
        outputs. Each element of rangeLoc specifies range of unconnected
        outputs of a node with at the corresponding position in nodesBF.
        Elements rangeOut specify contain the resulting global indexes 
        (in the resulting coefficient cell array) of such unconnected nodes.
     
        [nodesBF, rangeLoc, rangeOut] = TREEBFRANGES(wt,'rev') does the same 
        but the arrays are reversed.
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/treeBFranges.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
TREEBFRANGES Tree nodes output ranges in BF order
   Usage: [nodesBF, rangeLo...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
treeOutLen


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 772
 -- Function: treeOutLen
     TREEOUTLEN  Lengths of tree subbands
        Usage:  Lc = treeOutLen(L,doNoExt,wt)
     
        Input parameters:
              L       : Input signal length.
              doNoExt : Flag. Expansive = false, Nonexpansive=true  
              wt      : Structure containing description of the filter tree.
     
        Output parameters:
              Lc : Subband lengths.
     
        Lc = TREEOUTLEN(L,doNoExt,wt) returns lengths of tree subbands given
        input signal length L and flag doNoExt. When true, the transform is
        assumed to be non-expansive.
        For definition of the structure see WFBINIT.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/treeOutLen.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 77
TREEOUTLEN  Lengths of tree subbands
   Usage:  Lc = treeOutLen(L,doNoExt,wt)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
treeOutRange


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 587
 -- Function: treeOutRange
     TREEOUTRANGE Index range of the outputs
        Usage:  outRange = treeOutRange(wt);
     
        Input parameters:
              wt         : Structure containing description of the filter tree.
     
        Output parameters:
              outRange   : Subband idx range.
     
        TREEOUTRANGE(nodeNo,wt) returns index range in the global
        tree subbands associated. For definition of the
        structure see wfbinit.
     
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/treeOutRange.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 79
TREEOUTRANGE Index range of the outputs
   Usage:  outRange = treeOutRange(wt);



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
treeSub


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 530
 -- Function: treeSub
     TREESUB  Identical subsampling factors
        Usage:  a = treeSub(wt)
     
        Input parameters:
              wt  : Structure containing description of the filter tree.
     
        Output parameters:
              a : Subsampling factors.
     
        a = TREESUB(wt) returns subsampling factors asociated with the tree
        subbands. For definition of the structure see WFBINIT.
     
     
     *Url*: <http://ltfat.github.io/doc/wavelets/wfbtmanip/treeSub.html>

     See also: wfbtinit.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 65
TREESUB  Identical subsampling factors
   Usage:  a = treeSub(wt)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
treeWpBFrange


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 748
 -- Function: treeWpBFrange
     TREEWPBFRANGE Wavelet packet tree output ranges in BF order
        Usage: [pOutIdxs,chOutIdxs] = treeBFranges(wt);
     
        Input parameters:
              wt       : Filterbank tree struct.
        Output parameters:
              pOutIdxs  : Array of parent nodes in BF order
              chOutIdxs : Cell array of children nodes in BF order
     
        [pOutIdxs,chOutIdxs] = treeBFranges(wt) is a helper function
        determining direct relationship between nodes in tree wt. 
        Elements in both returned arrays are ordered according to the BF order.
        pOutIdxs is array of indices in the subbands
     
     *Url*:
     <http://ltfat.github.io/doc/wavelets/wfbtmanip/treeWpBFrange.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
TREEWPBFRANGE Wavelet packet tree output ranges in BF order
   Usage: [pOutId...





