meridian.data.time_coordinates.TimeCoordinates

Un wrapper per le coordinate temporali nei dati di input di Meridian.

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

I modelli Meridian memorizzano le coordinate temporali come stringhe non tipizzate. Il modello li tratta come etichette e non hanno un significato intrinseco per il modello, a parte l'ipotesi che rappresentino alcune coordinate temporali in aumento lineare.

Questo oggetto wrapper esegue alcune verifiche aggiuntive e metodi per estrarre valori da queste coordinate temporali, che vengono trattate come valori numerici "data".

datetime_index Le coordinate temporali fornite, analizzate come indicizzate DatetimeIndex.
all_dates Le coordinate temporali specificate, come elenco di oggetti datetime.date in Python.
all_dates_str Le coordinate temporali specificate, come elenco di stringhe di data in formato Meridian. Questo può essere utilizzato per gli elementi interni del modello, che trattano le coordinate del tempo come semplici etichette.
interval_days Restituisce l'intervallo tra due date adiacenti in all_dates.

Metodi

expand_selected_time_dims

Visualizza codice sorgente

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

Convalida e restituisce i valori della dimensione temporale in base agli orari selezionati.

Se sia start_date sia end_date sono None, restituisce None. Se specificati, start_date e end_date sono inclusi e devono essere presenti nelle coordinate temporali dei dati di input.

Args
start_date Data di inizio del periodo di tempo selezionato. Se None, implica il valore della dimensione temporale più antico nei dati di input.
end_date Data di fine del periodo di tempo selezionato. Se None, implica il valore della dimensione temporale più recente nei dati di input.

Resi
Un elenco di valori della dimensione temporale (come oggetti datetime.date) nei dati di input all'interno del periodo di tempo selezionato oppure non fare nulla e passare None se entrambi gli argomenti sono None oppure se start_date e end_date corrispondono all'intero intervallo di tempo nei dati di input.

Aumenti
ValueError se start_date o end_date non è presente nelle coordinate della dimensione temporale dei dati di input.

from_dates

Visualizza codice sorgente

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

Crea un TimeCoordinates da una serie polimorfa di date.

Args
dates Una serie polimorfa di date; può essere un array PandasDatetimeIndex o Xarray DataArray con etichette di stringa "GG-MM-AA".

Resi
Un dataclass TimeCoordinates normalizzato.

get_selected_dates

Visualizza codice sorgente

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

Crea una sequenza di date contenente tutti i punti nell'intervallo selezionato.

Args
selected_interval Tupla delle ore di inizio e di fine o un proto DateInterval. Se None, viene restituito all_dates.

Resi
Una sequenza di date che rappresenta il sottoinsieme di all_dates tra le date di inizio e di fine specificate, come gli oggetti datetime.date incorporati di Python.

Aumenti
ValueError Se selected_interval non è un sottoinsieme di all_dates.

__eq__

__eq__(
    other
)

Restituisce self==value.