From a57dc4e5774203f203ab33c1f80c67f48f350bd8 Mon Sep 17 00:00:00 2001 From: Chris Hold Date: Thu, 11 Jan 2024 13:10:29 +0200 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 3210129..415177e 100644 --- a/README.md +++ b/README.md @@ -32,4 +32,34 @@ HOAC calls `opusenc` and `opusdec`, which need to be build from https://github.c If all dependencies are met, an example [encoder](https://github.com/chris-hld/hoac/blob/main/hoac-encoder.py) and [decoder](https://github.com/chris-hld/hoac/blob/main/hoac-decoder.py) shows the basic functionality. +## Details +If you would like to explore beyond the provided interfaces please reach out! +All function docstrings can be shown e.g. with +```python +In [1]: import hoac +In [2]: hoac.grouped_sector_parameters?? +Signature: hoac.grouped_sector_parameters(x_nm, A_wxyz_c, M_grouper, TRANSPOSE=False) +Call signature: hoac.grouped_sector_parameters(*args, **kwargs) +Type: cython_function_or_method +String form: +Docstring: +Sector S parameters from SH signals L, frequency K band G grouped. + +Parameters +---------- +x_nm : np.ndarray + L x K. +A_wxyz_c : np.ndarray, complex + 4*S x L. +M_grouper : np.ndarray + K x G. +TRANSPOSE : np.ndarray, optional + The default is False. + +Returns +------- +azi_s, zen_s, dif_s, ene_s, int_s : np.ndarray + S x G, or 3*S x G, or transposed + +```