Skip to content

phyllotaxis_analysis

phyllotaxis_analysis Link

get_sample_sequence Link

get_sample_sequence(idx=None)

Get a sample sequence for testing and examples.

Parameters:

Name Type Description Default
idx int | None

If an integer, the index of the sequence. Else a sequence is returned at random.

 None

Returns:

Type Description
tuple[float, ...]

A sample sequence as a tuple of float values.

Examples:

>>> from phyllotaxis_analysis import get_sample_sequence
>>> sample_seq = get_sample_sequence(1)
>>> print(sample_seq)
(120.0, 123.0, 150.0, 275.0, 220.0, 290.0, 140.0, 143.0, 125.0, 130.0)
Source code in src/phyllotaxis_analysis/__init__.py 
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
def get_sample_sequence(idx=None) -> tuple[float, ...]:
    """
    Get a sample sequence for testing and examples.

    Parameters
    ----------
    idx : int | None
        If an integer, the index of the sequence.
        Else a sequence is returned at random.

    Returns
    -------
    tuple[float, ...]
        A sample sequence as a tuple of float values.

    Examples
    --------
    >>> from phyllotaxis_analysis import get_sample_sequence
    >>> sample_seq = get_sample_sequence(1)
    >>> print(sample_seq)
    (120.0, 123.0, 150.0, 275.0, 220.0, 290.0, 140.0, 143.0, 125.0, 130.0)
    """
    with resources.open_text('phyllotaxis_analysis.data', 'sequence_sample.txt') as f:
        lines = f.readlines()

    n_seq = len(lines)
    if idx:
        idx = idx % n_seq
    else:
        idx = int(np.random.default_rng().integers(0, n_seq))

    return _read_sequence(lines[idx])

get_sample_sequences Link

get_sample_sequences()

Get sample sequences for testing and examples.

Returns:

Type Description
list[tuple[float, ...]]

List of sample sequences as tuples of float values.

Examples:

>>> from phyllotaxis_analysis import get_sample_sequences
>>> sample_seq = get_sample_sequences()
>>> print(sample_seq[0])
(120.0, 123.0, 275.0, 220.0, 290.0, 140.0, 143.0, 125.0)
Source code in src/phyllotaxis_analysis/__init__.py 
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
def get_sample_sequences() -> list[tuple[float, ...]]:
    """
    Get sample sequences for testing and examples.

    Returns
    -------
    list[tuple[float, ...]]
        List of sample sequences as tuples of float values.

    Examples
    --------
    >>> from phyllotaxis_analysis import get_sample_sequences
    >>> sample_seq = get_sample_sequences()
    >>> print(sample_seq[0])
    (120.0, 123.0, 275.0, 220.0, 290.0, 140.0, 143.0, 125.0)
    """
    with resources.open_text('phyllotaxis_analysis.data', 'sequence_sample.txt') as f:
        lines = f.readlines()

    sequences = []
    for line in lines:
        numbers = _read_sequence(line)
        sequences.append(numbers)

    return sequences