pyspc.core.ratingcurve.RatingCurve

class pyspc.core.ratingcurve.RatingCurve(code=None, num=None, provider=None, valid_dt=None, valid_interval=None, update_dt=None, levelcor=None, flowmes=None, hq=None)[source]

Bases : object

Courbe de tarage

code

Code de la station

Type:

str

num

Code de la courbe de tarage

Type:

str

valid_dt

Période de validité

Type:

2-tuple de datetime

valid_interval

Intervalle de validité

Type:

2-tuple

update_dt

Date de mise à jour

Type:

datetime

levelcor

Courbe de correction

Type:

Series

flowmes

Jaugeages

Type:

Series

hq

Liste des couples

Type:

list

__init__(code=None, num=None, provider=None, valid_dt=None, valid_interval=None, update_dt=None, levelcor=None, flowmes=None, hq=None)[source]

Courbe de tarage

Paramètres:
  • code (str) – Code de la station

  • num (str) – Code de la courbe de tarage

  • source (str) – Fournisseur de la courbe parmi [“PHyC”, “Bareme”]

  • valid_dt (2-tuple de datetime) – Période de validité

  • valid_interval (2-tuple) – Intervalle de validité

  • update_dt (datetime) – Date de mise à jour

  • levelcor (Series) – Courbe de correction

  • flowmes (Series) – Jaugeages

  • hq (list) – Couples (h, q)

Methods

__init__([code, num, provider, valid_dt, ...])

Courbe de tarage

check_flowmes(flowmes)

Contrôle des jaugeages

check_hq(hq)

Contrôle des couples hq

check_levelcor(levelcor)

Contrôle de la courbe de correction

check_update_dt(update_dt)

Contrôle de la date de mise à jour

check_valid_dt(valid_dt)

Contrôle de la période de validité

check_valid_interval(valid_interval)

Contrôle de l'intervalle de validité

convert([values, col, extrapolation])

Convertir une variable vers une autre grandeur

interpolate_levelcor(index)

Interpoler les courbes de correction

Attributes

code

Code de la station

flowmes

Jaugeages

h

Liste des hauteurs

hq

Tableau des couples (h, q)

levelcor

Courbe de correction

num

Code de la courbe de tarage

provider

Fournisseur de la courbe parmi ['PHyC', 'Bareme']

q

Liste des débits

timeinterval

Période de validité.

update_dt

Date de mise à jour

valid_dt

Période de validité

valid_interval

Intervalle de validité

static check_flowmes(flowmes)[source]

Contrôle des jaugeages

static check_hq(hq)[source]

Contrôle des couples hq

static check_levelcor(levelcor)[source]

Contrôle de la courbe de correction

static check_update_dt(update_dt)[source]

Contrôle de la date de mise à jour

static check_valid_dt(valid_dt)[source]

Contrôle de la période de validité

static check_valid_interval(valid_interval)[source]

Contrôle de l’intervalle de validité

property code

Code de la station

convert(values=None, col=None, extrapolation=False)[source]

Convertir une variable vers une autre grandeur

Paramètres:
  • values (list) – Valeurs à convertir

  • col (str) – Nom de la colonne associée aux valeurs

  • extrapolation (bool) – Autoriser les conversions hors plage de validité des courbes de tarage. Défaut: False

Renvoie:

Valeurs converties

Type renvoyé:

list

property flowmes

Jaugeages

property h

Liste des hauteurs

property hq

Tableau des couples (h, q)

interpolate_levelcor(index)[source]

Interpoler les courbes de correction

Paramètres:

index (list) – Liste des instantes d’interpolation

Renvoie:

values – Tableau des valeurs interpolées

Type renvoyé:

pnd.DataFrame

property levelcor

Courbe de correction

property num

Code de la courbe de tarage

property provider

Fournisseur de la courbe parmi [“PHyC”, “Bareme”]

property q

Liste des débits

property timeinterval

Période de validité. Objet pandas.Interval

property update_dt

Date de mise à jour

property valid_dt

Période de validité

property valid_interval

Intervalle de validité