1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# -*- coding: utf-8 -*-
# ######### COPYRIGHT #########
# Credits
# #######
#
# Copyright(c) 2015-2025
# ----------------------
#
# * `LabEx Archimède <http://labex-archimede.univ-amu.fr/>`_
# * `Laboratoire d'Informatique Fondamentale <http://www.lif.univ-mrs.fr/>`_
# (now `Laboratoire d'Informatique et Systèmes <http://www.lis-lab.fr/>`_)
# * `Institut de Mathématiques de Marseille <http://www.i2m.univ-amu.fr/>`_
# * `Université d'Aix-Marseille <http://www.univ-amu.fr/>`_
#
# This software is a port from LTFAT 2.1.0 :
# Copyright (C) 2005-2025 Peter L. Soendergaard <peter@sonderport.dk>.
#
# Contributors
# ------------
#
# * Denis Arrivault <contact.dev_AT_lis-lab.fr>
# * Florent Jaillet <contact.dev_AT_lis-lab.fr>
#
# Description
# -----------
#
# ltfatpy is a partial Python port of the
# `Large Time/Frequency Analysis Toolbox <http://ltfat.sourceforge.net/>`_,
# a MATLAB®/Octave toolbox for working with time-frequency analysis and
# synthesis.
#
# Version
# -------
#
# * ltfatpy version = 1.1.2
# * LTFAT version = 2.1.0
#
# Licence
# -------
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# ######### COPYRIGHT #########
"""Module that cuts long windows to fir
Ported from ltfat_2.1.0/sigproc/long2fir.m
.. moduleauthor:: Denis Arrivault
"""
from __future__ import print_function, division
import numpy as np
from ltfatpy.fourier.middlepad import middlepad
def long2fir(g, L, centering='unsymmetric'):
"""Cut LONG window to FIR
- Usage:
| ``g = long2fir(g, L)``
| ``g = long2fir(g, L, 'hp')``
- Input parameters:
:param numpy.ndarray g: long window
:param int L: length of the output FIR window
:param str centering: 'wp' or 'hp' for whole point even or half point
even input window. 'unsymmetric' makes no assumption on the symmetry
of the input data. Default is 'unsymmetric'
- Output parameters:
:returns: the FIR window
:rtype: numpy.ndarray
``long2fir(g, L)`` will cut the LONG window **g** to a length **L** FIR
window by cutting out the middle part. Note that this is a slightly
different behaviour than :func:`~ltfatpy.fourier.middlepad.middlepad`.
``long2fir(g, L, 'wp')`` or ``long2fir(g, L, 'hp')`` does the same
assuming the input window is a whole-point even or half-point even
window, respectively.
.. seealso:: :func:`~ltfatpy.sigproc.fir2long.fir2long`,
:func:`~ltfatpy.fourier.middlepad.middlepad`
"""
if not isinstance(g, np.ndarray):
raise TypeError("g must be a numpy array")
if L is None:
raise ValueError('You must specify a way to shorten the window,' +
'either by specifying the length or through a flag.')
W = len(g)
if W < L:
raise ValueError('L must be smaller than length of window.')
# Not translated from Matlab :
# if ~isempty(kv.cutrel)
# maxval=max(abs(g));
# mask=abs(g)>maxval*kv.cutrel;
# L=W-2*min(abs(find(mask)-L/2));
# end;
if centering == 'unsymmetric':
# No assumption on the symmetry of the window.
if L % 2 == 0:
# HPE middlepad works the same way as the FIR cutting (e.g. just
# removing middle points) for even values of L.
g = middlepad(g, L, centering='hp')
else:
# WPE middlepad works the same way as the FIR cutting (e.g. just
# removing middle points) for odd values of L.
g = middlepad(g, L)
elif centering == 'wp':
g = middlepad(g, L)
if L % 2 == 0:
g[L//2] = 0
elif centering == 'hp':
g = middlepad(g, L, centering='hp')
if L % 2 == 1:
g[int(np.ceil(L/2)) - 1] = 0
else:
raise ValueError("centering should take 'hp','wp' or 'unsymmetric'" +
" values.")
return g
|
