iode.Sample

class iode.Sample

A sample represents the series of sub periods attached to the IODE variables or to the estimation process.

Examples

>>> from iode import variables, SAMPLE_DATA_DIR
>>> variables.load(f"{SAMPLE_DATA_DIR}/fun.var")
>>> variables.sample
'1960Y1:2015Y1'

Attributes:

start: str

First period of the sample.

end: str

Last period of the sample.

nb_periods: int

Total number of sub periods in the sample.

Methods

get_period_list(self[, astype])	List of all periods of the sample.
index(self, period)	Position of the 'period' in the sample.
intersection(self, other_sample)	Compute the intersection between two samples.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
get_period_list(self[, astype])	List of all periods of the sample.
index(self, period)	Position of the 'period' in the sample.
intersection(self, other_sample)	Compute the intersection between two samples.

Attributes

end	end: Period
nb_periods	nb_periods: int
start	start: Period