ChunkedData¶

class paleokalmag.ChunkedData(fname, delta_t, start=None, end=None, rejection_lists=None)[source]¶

Bases: object

Represents data in chunks. This class is used as an input to the Kalman-filter. It can be iterated over and returns a time-increment and data in every iteration step.

Parameters:

fname (str or DataFrame) – Either a path to or a DataFrame containing paleomagnetic data. If str is passed, it will be assumed to point to a file from GEOMAGIA.
delta_t (float, optional) – The time increment between the chunks in years. If None is passed (default) one chunk per year in the data will be generated and delta_t inferred accordingly.
start (float, optional) – The initial year of the chunks. If None (default) use the latest year in the data.
end (float, optional) – The final year of the chunks. If None (default) use the earliest year in the data.
rejection_lists (array or list of arrays, optional) – An array (or list of arrays) of types {‘D’, ‘I’, ‘F’}, indices, and file hashes, which uniquely identify records to be dropped from the data. (Outlier rejection). Default is None.