pyspc.core.statistics.Stats

class pyspc.core.statistics.Stats(datatype=None, name='stats')

Bases : BasicDict

Structure d’une collection d’ajustements statistiques.

datatype

Type de la collection

Type:

str

name

Nom de la collection. Par défaut: “stats”

Type:

str

Voir aussi

pyspc.core.statistics.Stat, pyspc.core.common.BasicDict

__init__(datatype=None, name='stats')

Initialise l’instance de la classe Stats.

Paramètres:

• datatype (str) – Type de la collection

• name (str) – Nom de la collection. Par défaut: “stats”

Voir aussi

pyspc.core.statistics.Sample, pyspc.core.common.BasicDict

Methods

__init__([datatype, name])	Initialise l'instance de la classe Stats.
add([stat, key, overwrite])	Ajouter un ajustement dans la collection.
clear()
copy()
extend([stats, overwrite])	Alimenter la collection à partir d'une autre collection.
from_records([records, name, datatype])	Créer un ajustement à partir de valeurs, périodes de retour.
fromkeys(iterable[, value])	Create a new ordered dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
move_to_end(key[, last])	Move an existing element to the end (or beginning if last is false).
plot_gumbel_paper([config, filename, ...])	Tracer une figure similaire à un papier de Gumbel.
pop(key[,default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem([last])	Remove and return a (key, value) pair from the dictionary.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update(other[, overwrite])	Ajouter des éléments d'une autre instance.
values()	Return an object providing a view on the dict's values.

Attributes

datatype	Type de la collection.
name	Nom de la collection.

add(stat=None, key=None, overwrite=False)

Ajouter un ajustement dans la collection.

Paramètres:

• stat (pyspc.core.statistics.Stat) – Ajustement statistique.

• key (str, None) – Clé d’identification de l’ajustement. Si non défini, la clé sera stat.name.

• overwrite (bool) – Écraser la donnée existante ? défaut: False

clear() → None.  Remove all items from od.

copy() → a shallow copy of od

property datatype

Type de la collection.

extend(stats=None, overwrite=False)

Alimenter la collection à partir d’une autre collection.

Paramètres:

• stats (pyspc.core.statistics.Stats) – Collection d’échantillons statistiques

• overwrite (bool) – Écraser la donnée existante ? défaut: False

classmethod from_records(records=None, name='stats', datatype=None)

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

Paramètres:

• records (dict) – Données à insérer en tant qu’ajustements statistiques.

• datatype (str) – Type de la collection

• name (str) – Nom de la collection. Par défaut: “stats”

Renvoie:

samples – Échantillons

Type renvoyé:

pyspc.core.statistics.Stats

Notes

records est un dictionnaire où la clé sera la clé de l’ajustement dans la collection créée et où la valeur est elle-même un dictionnaire:

• “values” : liste des valeurs

• “return_periods” : liste des périodes de retour

• “values_low” : liste des valeurs basses

• “values_high” : liste des valeurs hautes

• “name” : nom de l’échantillon

• “code” : identifiant du lieu

• “varname” : grandeur physique

• “provider” : fournisseur de la donnée

• “method” : méthode

• “length” : taille de l’échantillon d’origine

• “date_range” : période temporelle de l’échantillon d’origine

• “gradex” : GradexItem

• “coverage” : Taux de couverture de l’intervalle d’incertitude

• “sample” : échantillon d’origine

Voir aussi

pyspc.core.samples.Sample.from_records

classmethod fromkeys(iterable, value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

property name

Nom de la collection.

plot_gumbel_paper(config=None, filename=None, dirname=None, ignore_sample=True, ignore_errorbar=True)

Tracer une figure similaire à un papier de Gumbel.

Paramètres:

• dirname (str) – Répertoire d’enregistrement de la figure.

• filename (str) – Nom du fichier à enregister. Si non défini, le nom de fichier est la concaténation de dirname et de l’attribut name de la collection.

• config (Config, dict, filename) – Configuration de la figure et des courbes. Les clés des options des courbes correspondent au keyseries. Voir aussi pyspc.core.keyseries Les valeurs correspondent aux éléments à définir: - color - marker - markersize - linestyle

• ignore_sample (bool) – Ne pas tracer les échantillons, même si ceux-ci sont disponibles. Par défaut: True

• ignore_errorbar (bool) – Ne pas tracer les intervalles d’incertitudes, même si ceux-ci sont disponibles. Par défaut: True

Renvoie:

filename – Nom du fichier image

Type renvoyé:

str

pop(key[, default]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update(other, overwrite=True)

Ajouter des éléments d’une autre instance.

Paramètres:

• other (pyspc.core.statistics.Stats) – Collection d’ajustements statistiques

• overwrite (bool) – Écraser la donnée existante ? défaut: False

values()

Return an object providing a view on the dict’s values.