pyspc.core.parameter.Parameter

class pyspc.core.parameter.Parameter(varname=None, provider=None)

Bases : object

Structure de données pour manipuler les grandeurs des séries.

varname

Nom de la variable

Type:

str

provider

Nom du fournisseur de la donnée

Type:

str

long_varname

Intitulé de la variable

Type:

str

spc_varname

Nom de la variable selon la convention pyspc

Type:

str

cumulable

Grandeur cumulable

Type:

bool

timestep

Pas de temps

Type:

timedelta

timeunits

Unité de temps

Type:

str

units

Unité de la variable meteo

Type:

str

dtfmt

Format de la datetime

Type:

str

np_dtype

Format des données dans les tableaux numpy et pandas

Type:

np.float32

__init__(varname=None, provider=None)

Initialise l’instance de la classe Parameter.

Structure de données pour manipuler les grandeurs des séries

Paramètres:

• varname (str) – Nom de la variable

• provider (str) – Nom du fournisseur de la donnée

Methods

__init__([varname, provider])	Initialise l'instance de la classe Parameter.
apply_RatingCurves()	Définir le paramètre à l'issue de la conversion par courbes de tarage.
apply_ReservoirTable([col])	Définir le paramètre à l'issue de la conversion par Réservoir.
apply_ReservoirZ0()	Définir le paramètre à l'issue de la conversion par un Z0 de Réservoir.
find([prefix, suffix, timedelta])	Trouver le paramètre.
get_spcvarnames()	Définir la liste des noms des variables autorisées dans pyspc.
infer_timestep([index, prefix, default])	Déduire un pas de temps autorisé selon un index et un préfixe.
isDownscalable(other)	Tester si la désagrégation est possible.
isNearlyequalscalable(other)	Tester si la mise à un pas de temps très proche est possible.
isUpscalable(other)	Tester si l'agrégation est possible.
set_missing_values([spc_varname, dtype])	Définir la liste des valeurs manquantes acceptées.
to_regularscale()	Définir le paramètre à pas de temps régulier.
to_subhourlyscale()	Définir le paramètre à pas de temps 'instantané.

Attributes

cumulable	Grandeur cumulable.
dtfmt	Format du datetime.
long_varname	Intitulé de la variable.
missing	Valeur manquante.
np_dtype	Format des données dans les tableaux numpy et pandas.
provider	Nom du fournisseur de la donnée.
spc_varname	Nom de la variable selon la convention pyspc.
timestep	Pas de temps.
timeunits	Unité de temps.
units	Unité de la variable.
varname	Nom de la variable.

apply_RatingCurves()

Définir le paramètre à l’issue de la conversion par courbes de tarage.

Renvoie:

Paramètre à l’issue de la conversion par courbes de tarage

Type renvoyé:

Parameter

apply_ReservoirTable(col=None)

Définir le paramètre à l’issue de la conversion par Réservoir.

Renvoie:

Paramètre à l’issue de la conversion par un bareme de Réservoir

Type renvoyé:

Parameter

apply_ReservoirZ0()

Définir le paramètre à l’issue de la conversion par un Z0 de Réservoir.

Renvoie:

Paramètre à l’issue de la conversion par un Z0 de Réservoir

Type renvoyé:

Parameter

property cumulable

Grandeur cumulable.

property dtfmt

Format du datetime.

static find(prefix=None, suffix=None, timedelta=None)

Trouver le paramètre.

Selon le préfixe ou le suffixe, et le pas de temps.

Paramètres:

• prefix (str) – Préfixe de la grandeur à trouver (défaut: “”)

• suffix (str) – Suffixe de la grandeur à trouver (défaut: “”)

• timedelta (timedelta) – Pas de temps de la grandeur à trouver

Renvoie:

Première grandeur respectant les critères de recherche

Type renvoyé:

Parameter

Lève:

ValueError – Si aucune grandeur ne correspond aux critères de recherche

static get_spcvarnames()

Définir la liste des noms des variables autorisées dans pyspc.

Renvoie:

noms des variables autorisées dans pyspc

Voir aussi

pyspc.SPC_VARNAMES

Type renvoyé:

list

static infer_timestep(index=None, prefix=None, default=None)

Déduire un pas de temps autorisé selon un index et un préfixe.

Paramètres:

• index (pandas.Index) – Index de la série de données

• prefix (str) – Préfixe de la grandeur cible parmi [“E”, “H”, “P”, “Q”, “T”, “V”, “Z”]

• default (timedelta) – Pas de temps par défaut

Renvoie:

• target (timedelta) – Pas de temps déduit par les informations fournies

• None – Si pas de temps variable (cas des grandeus E, H, Q, T, V, Z)

isDownscalable(other)

Tester si la désagrégation est possible.

Depuis le paramètre courant vers le paramètre “cible”.

Paramètres:

other (Parameter) – Paramètre cible de la désagrégation

Renvoie:

Agrégation possible? T/F

Type renvoyé:

bool

isNearlyequalscalable(other)

Tester si la mise à un pas de temps très proche est possible.

Depuis le paramètre courant vers le paramètre “cible”.

Paramètres:

other (Parameter) – Paramètre cible de la transformation temporelle

Renvoie:

Agrégation possible? T/F

Type renvoyé:

bool

isUpscalable(other)

Tester si l’agrégation est possible.

Depuis le paramètre courant vers le paramètre “cible”.

Paramètres:

other (Parameter) – Paramètre cible de l’agrégation

Renvoie:

Agrégation possible? T/F

Type renvoyé:

bool

property long_varname

Intitulé de la variable.

property missing

Valeur manquante.

property np_dtype

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

property provider

Nom du fournisseur de la donnée.

static set_missing_values(spc_varname=None, dtype=<class 'numpy.float32'>)

Définir la liste des valeurs manquantes acceptées.

Paramètres:

spc_varname (str, Parameter) – Paramètre au pas de temps infra-horaire

Renvoie:

Valeurs manquantes autorisées

Type renvoyé:

list

property spc_varname

Nom de la variable selon la convention pyspc.

property timestep

Pas de temps.

property timeunits

Unité de temps.

to_regularscale()

Définir le paramètre à pas de temps régulier.

Depuis le pas de temps irrégulier “instantané” du paramètre courant.

Renvoie:

param – Paramètre au pas de temps régulier

Type renvoyé:

Parameter

to_subhourlyscale()

Définir le paramètre à pas de temps “instantané.

Depuis le pas de temps horaire du paramètre courant

Renvoie:

param – Paramètre au pas de temps infra-horaire

Type renvoyé:

Parameter

property units

Unité de la variable.

property varname

Nom de la variable.