Ouranosinc / xclim / 184

pending completion

Build # 184

Build Type

Pull #62

travis-ci

Committed by

web-flow

Commit Message

Revert "Merge remote-tracking branch 'origin/scrap_decorators' into scrap_decorators"

This reverts commit 83610045c, reversing
changes made to e8836516a.

Pull Request Pull Request #62: Removed most decorators from indices.py. Added test for UnivariateInd…

Run Details

132 of 132 new or added lines in 5 files covered. (100.0%)

274 of 434 relevant lines covered (63.13%)

1.26 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

23.53

/xclim/run_length.py

import numpy as np

# Dev Notes
# ---------
# Run length algorithms
#
# Need to benchmark and adapt for xarray.


def rle(arr):
    """Return the length, starting position and value of consecutive identical values.

    Parameters
    ----------
    arr : sequence
      Array of values to be parsed.

    Returns
    -------
    (values, run lengths, start positions)
    values : np.array
      The values taken by arr over each run
    run lengths : np.array
      The length of each run
    start position : np.array
      The starting index of each run

    Examples
    --------
    >>> a = [1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3]
    >>> rle(a)
    (array([1, 2, 3]), array([2, 4, 6]), array([0, 2, 6]))

    """
    ia = np.asarray(arr)
    n = len(ia)

    if n == 0:
        return None, None, None

    y = np.array(ia[1:] != ia[:-1])         # pairwise unequal (string safe)
    i = np.append(np.where(y), n - 1)       # must include last element position
    rl = np.diff(np.append(-1, i))          # run lengths
    pos = np.cumsum(np.append(0, rl))[:-1]  # positions
    return ia[i], rl, pos


def windowed_run_count(arr, window):
    """Return the number of consecutive true values in array for runs at least as long as given duration.

    Parameters
    ----------
    arr : bool array
      Input array
    window : int
      Minimum duration of consecutive run to accumulate values.

    Returns
    -------
    int
      Total number of true values part of a consecutive run at least `window` long.
    """
    v, rl = rle(arr)[:2]
    return np.where(v * rl >= window, rl, 0).sum()


def longest_run(arr):
    """Return the length of the longest consecutive run of identical values.

    Parameters
    ----------
    arr : bool array
      Input array

    Returns
    -------
    int
      Length of longest run.
    """
    v, rl = rle(arr)[:2]
    return np.where(v, rl, 0).max()

1	import numpy as np	2✔
2
3	# Dev Notes
4	# ---------
5	# Run length algorithms
6	#
7	# Need to benchmark and adapt for xarray.
8
9
10	def rle(arr):	2✔
11	"""Return the length, starting position and value of consecutive identical values.
12
13	Parameters
14	----------
15	arr : sequence
16	Array of values to be parsed.
17
18	Returns
19	-------
20	(values, run lengths, start positions)
21	values : np.array
22	The values taken by arr over each run
23	run lengths : np.array
24	The length of each run
25	start position : np.array
26	The starting index of each run
27
28	Examples
29	--------
30	>>> a = [1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3]
31	>>> rle(a)
32	(array([1, 2, 3]), array([2, 4, 6]), array([0, 2, 6]))
33
34	"""
35	ia = np.asarray(arr)	×
36	n = len(ia)	×
37
38	if n == 0:	×
39	return None, None, None	×
40
41	y = np.array(ia[1:] != ia[:-1]) # pairwise unequal (string safe)	×
42	i = np.append(np.where(y), n - 1) # must include last element position	×
43	rl = np.diff(np.append(-1, i)) # run lengths	×
44	pos = np.cumsum(np.append(0, rl))[:-1] # positions	×
45	return ia[i], rl, pos	×
46
47
48	def windowed_run_count(arr, window):	2✔
49	"""Return the number of consecutive true values in array for runs at least as long as given duration.
50
51	Parameters
52	----------
53	arr : bool array
54	Input array
55	window : int
56	Minimum duration of consecutive run to accumulate values.
57
58	Returns
59	-------
60	int
61	Total number of true values part of a consecutive run at least `window` long.
62	"""
63	v, rl = rle(arr)[:2]	×
64	return np.where(v * rl >= window, rl, 0).sum()	×
65
66
67	def longest_run(arr):	2✔
68	"""Return the length of the longest consecutive run of identical values.
69
70	Parameters
71	----------
72	arr : bool array
73	Input array
74
75	Returns
76	-------
77	int
78	Length of longest run.
79	"""
80	v, rl = rle(arr)[:2]	×
81	return np.where(v, rl, 0).max()	×

Ouranosinc / xclim / 184

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous