meridian.data.time_coordinates.TimeCoordinates

Um wrapper de coordenadas de tempo nos dados de entrada do Meridian.

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

Os modelos do Meridian armazenam coordenadas de tempo como strings sem tipo. Elas são tratadas como rótulos e não têm significado intrínseco para o modelo, exceto a proposição de que representam algumas coordenadas de tempo linearmente crescentes.

Esse objeto wrapper executa alguns outros métodos e validações para coletar valores dessas coordenadas de tempo, que são tratados como valores numéricos de "data".

Atributos
datetime_index	As coordenadas de tempo informadas, que são analisadas como objetos DatetimeIndex indexáveis.
all_dates	As coordenadas de tempo informadas, como uma lista de objetos datetime.date de Python.
all_dates_str	As coordenadas de tempo informadas, como uma lista de strings de data formatadas pelo Meridian. Isso pode ser usado para os elementos internos do modelo, que tratam as coordenadas de tempo como rótulos simples.
interval_days	Retorna o intervalo entre duas datas vizinhas em all_dates.

Métodos

expand_selected_time_dims

Ver código-fonte

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

Valida e retorna valores de dimensão de tempo com base nos períodos selecionados.

Se start_date e end_date forem "None", vai retornar "None". Se houver especificação, start_date e end_date são inclusivos e precisam estar presentes nas coordenadas de tempo dos dados de entrada.

Args
start_date	Data de início do período selecionado. Se for None, indica o valor da dimensão de tempo mais antiga nos dados de entrada.
end_date	Data de término do período selecionado. Se for None, indica o valor da dimensão de tempo mais recente nos dados de entrada.

Retorna
Uma lista de valores de dimensão (como objetos datetime.date) nos dados de entrada no período selecionado. Ou não faz nada e transmite None caso None seja o valor dos dois argumentos ou se start_date e end_date corresponderem a todo o período nos dados de entrada.

Gera
ValueError se start_date ou end_date não estiver nas coordenadas de dimensões de tempo dos dados de entrada.

from_dates

Ver código-fonte

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

Cria uma classe TimeCoordinates com base em uma série polimórfica de datas.

Args
dates	Uma série polimórfica de datas, que pode ser um Pandas DatetimeIndex ou um Xarray DataArray com rótulos de string "AAAA-mm-dd".

Retorna
Uma classe de dados TimeCoordinates normalizada.

get_selected_dates

Ver código-fonte

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

Cria uma sequência de datas que contém todos os pontos no intervalo selecionado.

Args
selected_interval	Ênuplo dos horários de início e término ou um proto de DateInterval. Se for None, all_dates será retornado.

Retorna
Uma sequência de datas que representa o subconjunto de all_dates entre as datas de início e término informadas, como objetos datetime.date integrados do Python.

Gera
ValueError	Se selected_interval não for um subconjunto de all_dates.

__eq__

__eq__(
    other
)

Retorna self==value.