U
    HvfÆ  ã                !   @   sÚ   d Z ddlZddlmZ dgZdgdgdgdgdgd	gd
d	dgdgd
gdgdddgdddgdddgdgdddgdgdgdddgdgdgdgdgdddgdgdddgdddgdgdgdd d
gd gd!d"dgd#œZd%d$d„ZdS )&zTools for MLS generationé    Né   )Ú_max_len_seq_innerÚmax_len_seqé   é   é   é   é   é	   é   é
   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   é   )r   r   r   r   r   r	   r   r
   r   r   r   r   r   r   é   r   r   r   r   r   r   r   r   r   r   r   r   r   r!   r    é    c                 C   s„  t  ¡ jdkrt jnt j}|dkrf| tkrTt  tt ¡ ƒ¡}t	d| 
¡ | ¡ f ƒ‚t  t|  |¡}nTt  t  ||¡¡ddd… }t  |dk ¡s¨t  || k¡s¨|jdk r°t	dƒ‚t  |¡}d|  d }|dkrÔ|}nt|ƒ}|dk rìt	d	ƒ‚|dkr
t j| t jd
d}nt j|td
d t j¡}|jdks:|j| krBt	dƒ‚t  |dk¡rZt	dƒ‚t j|t jd
d}t||| ||ƒ}||fS )a}
  
    Maximum length sequence (MLS) generator.

    Parameters
    ----------
    nbits : int
        Number of bits to use. Length of the resulting sequence will
        be ``(2**nbits) - 1``. Note that generating long sequences
        (e.g., greater than ``nbits == 16``) can take a long time.
    state : array_like, optional
        If array, must be of length ``nbits``, and will be cast to binary
        (bool) representation. If None, a seed of ones will be used,
        producing a repeatable representation. If ``state`` is all
        zeros, an error is raised as this is invalid. Default: None.
    length : int, optional
        Number of samples to compute. If None, the entire length
        ``(2**nbits) - 1`` is computed.
    taps : array_like, optional
        Polynomial taps to use (e.g., ``[7, 6, 1]`` for an 8-bit sequence).
        If None, taps will be automatically selected (for up to
        ``nbits == 32``).

    Returns
    -------
    seq : array
        Resulting MLS sequence of 0's and 1's.
    state : array
        The final state of the shift register.

    Notes
    -----
    The algorithm for MLS generation is generically described in:

        https://en.wikipedia.org/wiki/Maximum_length_sequence

    The default values for taps are specifically taken from the first
    option listed for each value of ``nbits`` in:

        https://web.archive.org/web/20181001062252/http://www.newwaveinstruments.com/resources/articles/m_sequence_linear_feedback_shift_register_lfsr.htm

    .. versionadded:: 0.15.0

    Examples
    --------
    MLS uses binary convention:

    >>> from scipy.signal import max_len_seq
    >>> max_len_seq(4)[0]
    array([1, 1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0], dtype=int8)

    MLS has a white spectrum (except for DC):

    >>> import numpy as np
    >>> import matplotlib.pyplot as plt
    >>> from numpy.fft import fft, ifft, fftshift, fftfreq
    >>> seq = max_len_seq(6)[0]*2-1  # +1 and -1
    >>> spec = fft(seq)
    >>> N = len(seq)
    >>> plt.plot(fftshift(fftfreq(N)), fftshift(np.abs(spec)), '.-')
    >>> plt.margins(0.1, 0.1)
    >>> plt.grid(True)
    >>> plt.show()

    Circular autocorrelation of MLS is an impulse:

    >>> acorrcirc = ifft(spec * np.conj(spec)).real
    >>> plt.figure()
    >>> plt.plot(np.arange(-N/2+1, N/2+1), fftshift(acorrcirc), '.-')
    >>> plt.margins(0.1, 0.1)
    >>> plt.grid(True)
    >>> plt.show()

    Linear autocorrelation of MLS is approximately an impulse:

    >>> acorr = np.correlate(seq, seq, 'full')
    >>> plt.figure()
    >>> plt.plot(np.arange(-N+1, N), acorr, '.-')
    >>> plt.margins(0.1, 0.1)
    >>> plt.grid(True)
    >>> plt.show()

    r   Nz/nbits must be between %s and %s if taps is Noneéÿÿÿÿr   r   zEtaps must be non-empty with values between zero and nbits (inclusive)r   z)length must be greater than or equal to 0Úc)ZdtypeÚorderz'state must be a 1-D array of size nbitszstate must not be all zeros)ÚnpZintpÚitemsizeZint32Zint64Ú	_mls_tapsÚarrayÚlistÚkeysÚ
ValueErrorÚminÚmaxÚuniqueÚanyÚsizeÚintZonesZint8ÚboolZastypeÚndimÚallÚemptyr   )ÚnbitsÚstateÚlengthZtapsZ
taps_dtypeZ
known_tapsZn_maxÚseq© r<   ú=/tmp/pip-unpacked-wheel-96ln3f52/scipy/signal/_max_len_seq.pyr      s8    Sÿ&

)NNN)Ú__doc__Znumpyr'   r   Ú__all__r)   r   r<   r<   r<   r=   Ú<module>   s<                      ú