pyspc.core.statistics.Sample

class pyspc.core.statistics.Sample(items=None, name='sample', code=None, provider=None, varname=None)[source]

Bases : BasicSerie

Structure d’un échantillon statistique.

df

Vue sous forme de tableau

Type:

pnd.DataFrame

code

Lieu de la série

Type:

str

location

Lieu de la série

Type:

Location

parameter

Grandeur de la série

Type:

Parameter

varname

Grandeur de la série

Type:

str

spc_varname

Grandeur de la série selon la convention de pyspc

Type:

str

long_varname

Intitulé de la grandeur

Type:

str

units

Unité de la grandeur

Type:

str

dtfmt

Format de la date

Type:

str

np_dtype

Type de données de la grandeur

Type:

str

firstdt

Première date de la série de données

Type:

datetime

lastdt

Dernière date de la série de données

Type:

datetime

length

Profondeur temporelle de la série de données

Type:

int

expanded_columns

Extension des colonnes demandées? (ajout: rang, fréq, temps retour)

Type:

bool

name

Libellé de l’échantillon

Type:

str

items

Valeurs de l’échantillon

Type:

list of SampleItem

Voir aussi

pyspc.core.samples.SampleItem, pyspc.core.common.BasicSerie

__init__(items=None, name='sample', code=None, provider=None, varname=None)[source]

Initialise l’instance de la classe Sample.

Paramètres:

  • items (list of SampleItem) – Items de l’échanitllon

  • name (str) – Libellé de l’échantillon. Par défaut: “sample”

  • code (str) – Lieu de l’échantillon

  • provider (str, Provider) – Producteur de l’échantillon

  • varname (str, Parameter) – Grandeur de l’échantillon

Voir aussi

pyspc.core.samples.SampleItem, pyspc.core.common.BasicSerie

Methods

__init__([items, name, code, provider, varname])

Initialise l'instance de la classe Sample.

append([item])

Ajouter un élément dans l'échantillon.

df_view()

Créer la vue sous forme de pandas.DataFrame.

extend([items])

Ajouter plusieurs éléments dans l'échantillon.

from_dve([dates, values, exclusions, name, ...])

Créer un échantillon à partir de dates, valeurs et exclusions.

infer([params])

Réaliser une inférence empirique sur les données.

sort([by, reverse])

Trier les items par ordre chronologique, ou valeurs.

to_Hydroportail([dirname])

Export au format Hydroportail.

Attributes

code

Identifiant de la série.

df

Contenu de l'échantillon.

dtfmt

Format du datetime.

firstdt

Première date de l'échantillon.

items

Liste des items de l'échantillon.

lastdt

Dernière date de l'échantillon.

length

Profondeur temporelle de l'échantillon.

location

Lieu de la série.

long_varname

Intitulé de la grandeur.

missing

Valeur manquante.

name

Nom de la collection.

np_dtype

Format des données dans les tableaux numpy et pandas.

parameter

Grandeur de la série.

provider

Nom du fournisseur de la donnée.

spc_varname

Grandeur de la série selon la convention de pyspc.

timestep

Pas de temps.

timeunits

Unité de temps.

timezone

Fuseau horaire.

units

Unité de la variable.

varname

Grandeur de la série.
append(item=None)[source]

Ajouter un élément dans l’échantillon.

Parameter

itempyspc.core.samples.SampleItem

Item à ajouter

Voir aussi

pyspc.core.samples.Sample.extend

property code

Identifiant de la série.

property df

Contenu de l’échantillon.

df_view()[source]

Créer la vue sous forme de pandas.DataFrame.

property dtfmt

Format du datetime.

extend(items=None)[source]

Ajouter plusieurs éléments dans l’échantillon.

Parameter

itemlist of pyspc.core.samples.SampleItem

Items à ajouter

Voir aussi

pyspc.core.samples.Sample.append

property firstdt

Première date de l’échantillon.

classmethod from_dve(dates=None, values=None, exclusions=None, name=None, code=None, varname=None, provider=None)[source]

Créer un échantillon à partir de dates, valeurs et exclusions.

Paramètres:

  • dates (list) – Dates des éléments de l’échantillon

  • values (list) – Valeurs des éléments de l’échantillon

  • exclusions (list) – Indication s’il faut exclure la valeur dans les analyses

  • name (str) – Libellé de l’échantillon. Par défaut: “sample”

  • code (str) – Lieu de l’échantillon

  • provider (str, Provider) – Producteur de l’échantillon

  • varname (str, Parameter) – Grandeur de l’échantillon

Renvoie:

sample – Échantillon

Type renvoyé:

pyspc.core.samples.Sample

infer(params=None)[source]

Réaliser une inférence empirique sur les données.

Paramètres:

params (dict) – Paramètres d’inférence empirique. Voir les arguments des différentes fonctions utilisées et listées ci-après.

Notes

L’inférence conduit à ajouter des informations à l’échantillon.

Exemples

>>> sample.df
                  date   value  excluded
0  1994-11-05 17:29:00  1030.0      True
1  1996-01-24 02:57:00   491.0     False
2  1996-11-13 09:05:00  2060.0     False
3  1997-12-19 22:01:00   280.0     False
4  1999-05-18 12:30:00  1010.0     False
5  1999-10-21 15:00:00   313.0     False
6  2000-10-14 09:36:00   527.0     False
7  2001-10-20 23:13:00  1010.0     False
8  2002-11-25 09:10:00   936.0     False
9  2003-12-02 15:10:00  1740.0     False
10 2004-11-04 23:40:00   367.0     False
11 2006-04-10 22:50:00   110.0     False
12 2006-11-18 10:10:00   146.0     False
13 2008-05-29 19:30:00   257.0     False
14 2008-11-02 10:40:00  2750.0     False
15 2010-06-16 19:30:00   226.0     False
16 2010-11-01 03:50:00   503.0     False
17 2011-11-05 08:10:00   557.0     False
18 2013-05-19 03:30:00   537.0     False
19 2014-01-20 05:30:00   377.0     False
20 2014-11-05 00:40:00   620.0     False
21 2016-04-07 01:30:00    88.4     False
22 2016-11-23 02:30:00  1030.0     False
23 2018-05-16 04:35:00   227.0     False
24 2018-11-10 01:05:00   293.0     False
25 2019-11-23 17:40:00  1260.0     False
26 2021-05-11 09:35:00   539.0     False
27 2021-12-29 16:20:00   117.0     False
28 2023-05-14 03:20:00   117.0     False
29 2024-03-10 08:47:30   818.0     False

>>> params = {
...     'freq': {'method': 'Hazen'},
...     'period': {'highflow': True, 'asint': False},
... }
>>> sample.infer(params=params)
>>> sample.df
                  date   value  excluded  rank   freq  period ugumbel
0  2016-04-07 01:30:00    88.4     False   1.0  0.017   1.017   1.401
1  2006-04-10 22:50:00   110.0     False   2.0  0.051   1.054   1.085
2  2021-12-29 16:20:00   117.0     False   3.0  0.086   1.094   0.896
3  2023-05-14 03:20:00   117.0     False   4.0  0.120   1.137   0.748
4  2006-11-18 10:10:00   146.0     False   5.0  0.155   1.183   0.622
5  2010-06-16 19:30:00   226.0     False   6.0  0.189   1.234   0.508
6  2018-05-16 04:35:00   227.0     False   7.0  0.224   1.288   0.402
7  2008-05-29 19:30:00   257.0     False   8.0  0.258   1.348   0.301
8  1997-12-19 22:01:00   280.0     False   9.0  0.293   1.414   0.204
9  2018-11-10 01:05:00   293.0     False  10.0  0.327   1.487   0.109
10 1999-10-21 15:00:00   313.0     False  11.0  0.362   1.567   0.015
11 2004-11-04 23:40:00   367.0     False  12.0  0.396   1.657   0.078
12 2014-01-20 05:30:00   377.0     False  13.0  0.431   1.757   0.172
13 1996-01-24 02:57:00   491.0     False  14.0  0.465   1.870   0.268
14 2010-11-01 03:50:00   503.0     False  15.0  0.500   2.000   0.366
15 2000-10-14 09:36:00   527.0     False  16.0  0.534   2.148   0.467
16 2013-05-19 03:30:00   537.0     False  17.0  0.568   2.320   0.572
17 2021-05-11 09:35:00   539.0     False  18.0  0.603   2.521   0.683
18 2011-11-05 08:10:00   557.0     False  19.0  0.637   2.761   0.799
19 2014-11-05 00:40:00   620.0     False  20.0  0.672   3.052   0.924
20 2024-03-10 08:47:30   818.0     False  21.0  0.706   3.411   1.058
21 2002-11-25 09:10:00   936.0     False  22.0  0.741   3.866   1.206
22 1999-05-18 12:30:00  1010.0     False  23.0  0.775   4.461   1.371
23 2001-10-20 23:13:00  1010.0     False  24.0  0.810   5.272   1.559
24 1994-11-05 17:29:00  1030.0      True   NaN    NaN     NaN     NaN
25 2016-11-23 02:30:00  1030.0     False  25.0  0.844   6.444   1.780
26 2019-11-23 17:40:00  1260.0     False  26.0  0.879   8.285   2.050
27 2003-12-02 15:10:00  1740.0     False  27.0  0.913  11.600   2.406
28 1996-11-13 09:05:00  2060.0     False  28.0  0.948  19.333   2.935
29 2008-11-02 10:40:00  2750.0     False  29.0  0.982  58.000   4.051

Voir aussi

pyspc.statistics.freq.RANK2FREQ, pyspc.statistics.freq.from_rank, pyspc.statistics.freq.to_period, pyspc.statistics.freq.to_ugumbel

property items

Liste des items de l’échantillon.

property lastdt

Dernière date de l’échantillon.

property length

Profondeur temporelle de l’échantillon.

property location

Lieu de la série.

property long_varname

Intitulé de la grandeur.

property missing

Valeur manquante.

property name

Nom de la collection.

property np_dtype

Format des données dans les tableaux numpy et pandas.

property parameter

Grandeur de la série.

property provider

Nom du fournisseur de la donnée.

sort(by=None, reverse=None)[source]

Trier les items par ordre chronologique, ou valeurs.

Paramètres:

  • by (str) – Choix du tri parmi [“date”, “value”].

  • reverse (bool) – Tri par ordre décroissant. Par défaut: False.

Notes

Un tri par rang revient à trier par valeur croissante.

property spc_varname

Grandeur de la série selon la convention de pyspc.

property timestep

Pas de temps.

property timeunits

Unité de temps.

property timezone

Fuseau horaire.

to_Hydroportail(dirname=None)[source]

Export au format Hydroportail.

Paramètres:

dirname (str) – Répertoire d’export

Renvoie:

filenames – Fichiers écrits renvoyés sous la forme de dictionnaire. Clé = clé de l’échantillon, valeur = nom du fichier

Type renvoyé:

dict

Exemples

>>> sample
*************************************
*********** SAMPLE ******************
*************************************
*  NOM ECHANTILLON      = test_export_hydroportail
*  NOM VARIABLE SPC     = QI
*  INTITULE VARIABLE    = Débit instantané
*  IDENTIFIANT          = K0550010
*  FOURNISSEUR          = Provider(name=None)
*  NOM VARIABLE         = QI
*  TAILLE ECHANTILLON   = 30
*  PREMIERE DATE        = 1994-11-05 17:29:00
*  DERNIERE DATE        = 2024-03-10 08:47:30
*************************************
>>> filename = sample.to_Hydroportail(dirname='data')
>>> filename
'data/Q-X_None_K0550010_test_export_hydroportail_Echantillon.csv'
property units

Unité de la variable.

property varname

Grandeur de la série.