pyspc.statistics.period.asstr

pyspc.statistics.period.asstr(qmax, info=None, prefix=None)[source]

Déterminer le temps de retour de la crue comme chaine de caractères

Paramètres:
  • qmax (float) – Valeur du débit statistique

  • info (dict) – Correspondance entre libellé d’un temps de retour et sa valeur (grandeur)

  • prefix – Préfixe du libellé

Renvoie:

tag – Temps de retour sous forme de texte

Type renvoyé:

str

Notes

Le code ne considère que les temps de retour suivants:

[2, 5, 10, 20, 50, 100]

Exemples

>>> from pyspc.statistics.period import asstr
>>> qmax = [1, 2, 3, 5, 8, 10, 15, 20, 30, 50, 70, 100, 1000]

CAS STATISTIQUES COMPLETES

>>> info = {'2': 2, '5': 5, '10': 10, '20': 20, '50': 50, '100': 100}
>>> trs = [asstr(q, info) for q in qmax]
>>> for q, t in zip(qmax, trs):
...     print(q, t)
1 < 2 ans
2 2 ans
3 entre 2 et 5 ans
5 5 ans
8 entre 5 et 10 ans
10 10 ans
15 entre 10 et 20 ans
20 20 ans
30 entre 20 et 50 ans
50 50 ans
70 entre 50 et 100 ans
100 100 ans
1000 > 100 ans

CAS STATISTIQUES INCOMPLETES

>>> info = {'2': 2, '5': 5, '10': 10, '20': 20}
>>> trs = [asstr(q, info) for q in qmax]
>>> for q, t in zip(qmax, trs):
...     print(q, t)
1 < 2 ans
2 2 ans
3 entre 2 et 5 ans
5 5 ans
8 entre 5 et 10 ans
10 10 ans
15 entre 10 et 20 ans
20 20 ans
30 > 20 ans
50 > 20 ans
70 > 20 ans
100 > 20 ans
1000 > 20 ans

CAS STATISTIQUES COMPLETES AVEC PREFIXE (“t)

>>> info = {'t2': 2, 't5': 5, 't10': 10, 't20': 20, 't50': 50, 't100': 100}
>>> trs = [asstr(q, info, 't') for q in qmax]
>>> for q, t in zip(qmax, trs):
...     print(q, t)
1 < 2 ans
2 2 ans
3 entre 2 et 5 ans
5 5 ans
8 entre 5 et 10 ans
10 10 ans
15 entre 10 et 20 ans
20 20 ans
30 entre 20 et 50 ans
50 50 ans
70 entre 50 et 100 ans
100 100 ans
1000 > 100 ans