Data

class paleokalmag.Data(fname, drop_duplicates=False, rejection_lists=None)[source]

Bases: object

A class that represents paleomagnetic data.

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.

    The dataframe is supposed to have the following keys: t : the measurement dates in yrs dt : the dating uncertainties in yrs rad : the radius of the measurement location in km colat : the colatitude of the measurement location in deg lat : the latitude of the measurement location in deg lon : the longitude of the measurement location in deg D : declination measurement in deg dD : error of the declination measurement in deg I : incination measurement in deg dI : error of the inlcination measurement in deg F : intensity measurement in uT dF : error of the intensity measurement in uT UID : unique ID identifying each record in a dataset FID : sha256 hash of the file the record stems from

  • drop_duplicates (bool, optional) – Whether to drop multiple records from the same site and keep the first only. Default is False.

  • 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.

original_index[source]

An array of the original indices, i.e. wrt. to the input DataFrame/file. This is used as a reference for removing outliers.

Type:

array

data[source]

The DataFrame containing all data.

Type:

DataFrame

n_inp[source]

The number of inputs.

Type:

int

inputs[source]

The inputs.

Type:

array

idx_D[source]

The indices of declination records in the DataFrame.

Type:

index

idx_I[source]

The indices of inclination records in the DataFrame.

Type:

index

idx_F[source]

The indices of intensity records in the DataFrame.

Type:

index

n_out[source]

The number of outputs, i.e. the total number of records.

Type:

int

outputs[source]

The outputs.

Type:

array

infos[source]

An array containing the type, unique index and file ID of each record. This is mainly used for reference in outlier rejection.

Type:

array

errs[source]

The output-errors.

Type:

array

idx_NEZ_D[source]

Indices pointing to magnetic field components for all declination records. This is used for calculating predictions.

Type:

array

idx_NEZ_I[source]

Indices pointing to magnetic field components for all inclination records. This is used for calculating predictions.

Type:

array

idx_NEZ_F[source]

Indices pointing to magnetic field components for all intensity records. This is used for calculating predictions.

Type:

array

idx_NEZ_out[source]

A collection of d,i,f-indices, pointing to magnetic field components. This is used for calculating predictions.

Type:

array

errs_T[source]

The dating uncertainties/input errors ordered in a way to be used by the NIGP, i.e. these are assigned to the measured data (DIF).

Type:

array

errs_T_raw[source]

The dating uncertainties/input errors ordered as in the original file, i.e. these are assigned to the inputs so that inputs[3, ind] corresponds too errs_T_raw[ind].

Type:

array

Methods Summary

plot([show])

Plot the data.

Methods Documentation

plot(show=True)[source]

Plot the data.

Parameters:

show (bool, optional) – If show is False, return figures and axes to plot other stuff into. Default is True.