# Constructor function for objects of class wavDictionary

### Description

Packs input information regarding a discrete wavelet transform into a dictionary list.

### Usage

1 2 3 | ```
wavDictionary(wavelet, dual, decimate, n.sample,
attr.x, n.levels, boundary, conv, filters,
fast, is.complex)
``` |

### Arguments

`wavelet` |
a character string denoting the type of wavelet used in the transform. |

`dual` |
a logical value. If |

`decimate` |
a logical value. If |

`n.sample` |
an integer representing the number of samples in the original time series. |

`attr.x` |
a list of additional (arbitrary) attributes to append onto the output object. |

`n.levels` |
an integer denoting the number of decomposition levels. |

`boundary` |
a character string denoting the boundary extension type
used in transform. Supported values are |

`conv` |
a logical value. If |

`filters` |
a list of vectors named |

`fast` |
a logical value. If |

`is.complex` |
a logical value. If |

### Details

Used internally by the `wavMODWT`

and `wavDWT`

functions
to package the transform contents into a dictionary list.

### Value

an object of class `wavDictionary`

.

### S3 METHODS

print the dictionary.

Usage: print(x)

### See Also

`wavDWT`

, `wavMODWT`

.

### Examples

1 2 3 4 5 6 7 8 | ```
## create a faux wavelet dictionary
wavelet <- "s8"
wavDictionary(wavelet=wavelet, dual=FALSE,
decimate=FALSE, n.sample=1024,
attr.x=NULL, n.levels=3,
boundary="periodic", conv=TRUE,
filters=wavDaubechies(wavelet),
fast=TRUE, is.complex=FALSE)
``` |