meridian.data.time_coordinates.TimeCoordinates

Wrapper autour des coordonnées temporelles dans les données d'entrée de Meridian.

meridian.data.time_coordinates.TimeCoordinates(
    datetime_index: pd.DatetimeIndex
)

Les modèles Meridian stockent les coordonnées temporelles sous forme de chaînes non typées. Ils les traitent comme des libellés, et elles n'ont pas de signification intrinsèque pour le modèle, si ce n'est l'hypothèse selon laquelle elles représentent des coordonnées temporelles qui augmentent linéairement.

Cet objet wrapper effectue des validations et des méthodes supplémentaires pour extraire des valeurs de ces coordonnées temporelles, qui sont traitées comme des valeurs numériques de type "date".

datetime_index Coordonnées temporelles données, analysées en tant que DatetimeIndex indexable.
all_dates Coordonnées temporelles données, sous la forme d'une liste d'objets datetime.date Python.
all_dates_str Coordonnées temporelles données, sous la forme d'une liste de chaînes de date au format Meridian. Celle-ci peut être utilisée pour les composants internes des modèles, qui traitent les coordonnées temporelles comme des libellés simples.
interval_days Renvoie l'intervalle entre deux dates voisines dans all_dates.

Méthodes

expand_selected_time_dims

Afficher la source

expand_selected_time_dims(
    start_date: (Date | None) = None, end_date: (Date | None) = None
) -> (list[datetime.date] | None)

Valide et renvoie les valeurs de dimension temporelle en fonction des heures sélectionnées.

Si start_date et end_date sont définies sur "None", renvoie "None". Si elles sont spécifiées, start_date et end_date sont inclusives et doivent figurer dans les coordonnées temporelles des données d'entrée.

Args
start_date Date de début de la période sélectionnée. None implique la valeur de dimension temporelle la plus ancienne dans les données d'entrée.
end_date Date de fin de la période sélectionnée. None implique la valeur de dimension temporelle la plus récente dans les données d'entrée.

Renvoie
Une liste de valeurs de dimension temporelle (en tant qu'objets datetime.date) dans les données d'entrée au cours de la période sélectionnée, ou n'effectue aucune action et transmet None si les deux arguments sont définis sur None, ou si start_date et end_date correspondent à la période complète dans les données d'entrée.

Génère
ValueError si start_date ou end_date ne figurent pas dans les coordonnées de la dimension temporelle des données d'entrée.

from_dates

Afficher la source

@classmethod
from_dates(
    dates: _TimeCoordinateValues
) -> 'TimeCoordinates'

Crée un TimeCoordinates à partir d'une série polymorphe de dates.

Args
dates une série polymorphe de dates (il peut s'agir d'un DatetimeIndex Pandas ou d'un DataArray Xarray avec des libellés de chaîne "AAAA-mm-jj").

Renvoie
Une classe de données TimeCoordinates normalisée.

get_selected_dates

Afficher la source

get_selected_dates(
    selected_interval: (meridian.data.time_coordinates.DateInterval | None) = None
) -> list[datetime.date]

Crée une séquence de dates contenant tous les points de l'intervalle sélectionné.

Args
selected_interval Tuple des heures de début et de fin, ou proto DateInterval. Si la valeur est None, all_dates est renvoyé.

Renvoie
Séquence de dates représentant le sous-ensemble de all_dates entre les dates de début et de fin données, en tant qu'objets datetime.date intégrés de Python.

Génère
ValueError Si selected_interval n'est pas un sous-ensemble de all_dates.

__eq__

__eq__(
    other
)

Return self==value.