pyspc.core.statistics.Stat

class pyspc.core.statistics.Stat(items=None, name='stat', method=None, length=None, date_range=None, gradex=None, coverage=None, sample=None, code=None, provider=None, varname=None)[source]

Bases : BasicSerie

Structure d’un résultat d’un ajustement 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

name

Libellé de l’échantillon

Type:

str

method

Méthode d’ajustement

Type:

str

size

Taille de l’échantillon

Type:

int

date_range

Période temporelle de l’échantillon

Type:

tuple

gradex

Informations du gradex sur la pluviométrie

Type:

GradexItem

coverage

Couverture de l’intervalle d’incertitude, entre 0 et 100.

Type:

int

sample

Echantillon à l’origine de l’ajustement

Type:

Sample

items

Valeurs de l’ajustement

Type:

list of StatItem

__init__(items=None, name='stat', method=None, length=None, date_range=None, gradex=None, coverage=None, sample=None, code=None, provider=None, varname=None)[source]

Initialise l’instance de la classe Sample.

Paramètres:
  • name (str) – Libellé de l’échantillon

  • method (str) – Méthode d’ajustement

  • length (int) – Taille de l’échantillon

  • date_range (tuple) – Période temporelle de l’échantillon

  • gradex (GradexItem) – Informations du gradex sur la pluviométrie

  • coverage (int) – Couverture de l’intervalle d’incertitude, entre 0 et 100.

  • sample (Sample) – Echantillon à l’origine de l’ajustement. Si fourni, les valeurs de length et date_range proviennent de sample.

  • items (list of StatItem) – Valeurs de l’ajustement

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

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

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

Methods

__init__([items, name, method, length, ...])

Initialise l'instance de la classe Sample.

append([item])

Ajouter un élément dans l'ajustement.

df_view()

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

extend([items])

Ajouter plusieurs éléments dans l'ajustement.

from_records([values, return_periods, ...])

Créer un ajustements à partir de valeurs, périodes de retour.

Attributes

code

Identifiant de la série.

coverage

Couverture de l'intervalle d'incertitude.

date_range

Période temporelle de l'échantillon.

df

Contenu de l'échantillon.

dtfmt

Format du datetime.

gradex

Gradex.

items

Liste des items de l'échantillon.

length

Profondeur temporelle de l'échantillon.

location

Lieu de la série.

long_varname

Intitulé de la grandeur.

method

Nom de la méthode d'ajustement.

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.

sample

Echantillon.

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’ajustement.

Paramètres:

item (pyspc.core.statistics.StatItem) – Item à ajouter

property code

Identifiant de la série.

property coverage

Couverture de l’intervalle d’incertitude.

property date_range

Période temporelle de l’échantillon.

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’ajustement.

Paramètres:

item (list of pyspc.core.statistics.StatItem) – Item à ajouter

classmethod from_records(values=None, return_periods=None, values_low=None, values_high=None, name=None, method=None, length=None, date_range=None, gradex=None, coverage=None, sample=None, code=None, varname=None, provider=None)[source]

Créer un ajustements à partir de valeurs, périodes de retour.

Paramètres:
  • values (list) – Valeurs des éléments de l’ajustement

  • return_periods (list) – Temps de retour des éléments de l’ajustement

  • values_low (list) – Valeurs basses des éléments de l’ajustement

  • values_high (list) – Valeurs hautes des éléments de l’ajustement

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

  • method (str) – Méthode d’ajustement

  • length (int) – Taille de l’échantillon

  • date_range (tuple) – Période temporelle de l’échantillon

  • gradex (GradexItem) – Informations du gradex sur la pluviométrie

  • coverage (int) – Couverture de l’intervalle d’incertitude, entre 0 et 100.

  • sample (Sample) – Echantillon à l’origine de l’ajustement. Si fourni, les valeurs de length et date_range proviennent de sample.

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

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

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

Renvoie:

sample – Résultat d’ajustement

Type renvoyé:

pyspc.core.statistics.Stat

property gradex

Gradex.

property items

Liste des items 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 method

Nom de la méthode d’ajustement.

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.

property sample

Echantillon.

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.

property units

Unité de la variable.

property varname

Grandeur de la série.