pyspc.core.samples.Samples

class pyspc.core.samples.Samples(datatype=None, name='samples')[source]

Bases : BasicDict

Structure d’une collection d’échantillons statistiques.

datatype

Type de la collection

Type:

str

name

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

Type:

str

Voir aussi

pyspc.core.samples.Sample, pyspc.core.common.BasicDict

__init__(datatype=None, name='samples')[source]

Initialise l’instance de la classe Samples.

Paramètres:

  • datatype (str) – Type de la collection

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

Voir aussi

pyspc.core.samples.Sample, pyspc.core.common.BasicDict

Methods

__init__([datatype, name])

Initialise l'instance de la classe Samples.

add([sample, key, overwrite])

Ajouter un échantillon dans la collection.

clear()

copy()

extend([samples, overwrite])

Alimenter la collection à partir d'une autre collection.

from_dve([dve, name, datatype])

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

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.

infer([params])

Trier les échantillons par ordre chronologique, ou valeurs.

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, dirname])

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.

sort([by, reverse])

Trier les échantillons par ordre chronologique, ou valeurs.

to_Hydroportail([dirname])

Export au format Hydroportail.

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(sample=None, key=None, overwrite=False)[source]

Ajouter un échantillon dans la collection.

Paramètres:

  • sample (pyspc.core.samples.Sample) – Échantillon statistique.

  • key (str, None) – Clé d’identification de l’échantillon. Si non défini, la clé sera sample.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(samples=None, overwrite=False)[source]

Alimenter la collection à partir d’une autre collection.

Paramètres:

  • samples (pyspc.core.samples.Samples) – Collection d’échantillons statistiques

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

classmethod from_dve(dve=None, name='samples', datatype=None)[source]

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

Paramètres:

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

  • datatype (str) – Type de la collection

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

Renvoie:

samples – Échantillons

Type renvoyé:

pyspc.core.samples.Samples

Notes

dve est un dictionnaire où la clé sera la clé de l’échantillon dans la collection créée et où la valeur est elle-même un dictionnaire : - “dates” : liste des dates - “values” : liste des valeurs - “exclusions” : liste des exclusions - “name” : nom de l’échantillon - “code” : identifiant du lieu - “varname” : grandeur physique - “provider” : fournisseur de la donnée

Voir aussi

pyspc.core.samples.Sample.from_dve

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.

infer(params=None)[source]

Trier les échantillons par ordre chronologique, ou valeurs.

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.

Voir aussi

pyspc.core.samples.Sample.infer

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)[source]

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

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.

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

Trier les échantillons 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.

Voir aussi

pyspc.core.samples.Sample.sort

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

>>> samples
*************************************
********** SAMPLES ******************
*************************************
*  NOM DE LA COLLECTION = test_sort
*  TYPE DE COLLECTION   = None
*  NOMBRE DE SERIES     = 1
*  ----------------------------------
*  SAMPLE #1 : Bas
*************************************

>>> filenames = samples.to_Hydroportail(dirname='data')
>>> filenames
{'Bas': 'data/Q-X_None_K0550010_Bas_Echantillon.csv'}
update(other, overwrite=True)[source]

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

Paramètres:

  • other (pyspc.core.samples.Samples) – Collection d’échantillons statistiques

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

values()

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