Tilt
Functions for processing an AQG tilt offset calibration measurement
AQGTiltAnalysis
dataclass
Summary of an AQG tilt offset analysis
fit(datapoints, datasets=None, name=None)
classmethod
Fit the tilt offset from a list of data points
plot_datasets(indices=None, ylim=None)
Plot individual measurements
plot_residuals(ax=None)
Plot residuals against effective angle
plot_tilt_distribution(ax=None)
Plot 2D distribution of tilt angles
plot_tilt_offset(label=None, **kwargs)
Plot tilt offset result
TiltOffset
dataclass
AQG tilt offset fit result
plot(**kwargs)
Plot as a 2D tilt graph with a circle for 1 µGal
analyze_aqg_tilt_calibration(rawdata_paths, config=None, name=None)
Perform an AQG tilt offset calibration from a list of rawdata files
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rawdata_paths
|
list[str | Path | Path]
|
List of file paths to AQG raw datasets |
required |
config
|
dict
|
Processing configuration parameters. |
None
|
name
|
str
|
Identifier name for this calibration measurement. If unspecified, the date of the first dataset is chosen. |
None
|
Returns:
| Type | Description |
|---|---|
AQGTiltAnalysis
|
Summary of this analysis results |
calculate_tilt_dataset_means(datasets)
Calculate mean values of an AQG tilt offset calibration dataset
draw_circle(x, y, radius, ax=None, n=100, **kwargs)
Draw a circle in a Matplotlib graph
fit_model(tilt_xy, offset_x, offset_y, g_true)
Model used to fit tilt calibration measurements
See also tilt_correction().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tilt_xy
|
ndarray
|
2D array of X and Y tilt angles, in radian. |
required |
offset_x
|
ndarray
|
Tilt offset in X direction, in radian. |
required |
offset_y
|
ndarray
|
Tilt offset in X direction, in radian. |
required |
g_true
|
ndarray
|
Gravity value at verticality, in nm/s². |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
Absolute gravity value reduced due to instrument tilt. |
perform_tilt_offset_fit(tilt_x, tilt_y, g, g_err)
Fit tilt offset values from set of calibration datapoints
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tilt_x
|
ndarray
|
Instrument tilt in X direction, in radian. |
required |
tilt_y
|
ndarray
|
Instrument tilt in Y direction, in radian. |
required |
g
|
ndarray
|
Measured absolute gravity, in nm/s². |
required |
g_err
|
ndarray
|
Standard uncertainty of measured gravity, in nm/s². |
required |
Returns:
| Type | Description |
|---|---|
TiltOffset
|
Tilt offset fit results. |
plot_tilt_analyses(tilt_analyses, origin=None, **kwargs)
Plot multiple tilt analyis results
plot_tilt_offset(x, y, origin=(0, 0), *, circle=True, ax=None, **kwargs)
Draw tilt offset position on a Matplotlib graph
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
float
|
Tilt offset in X axis. |
required |
y
|
float
|
Tilt offset in Y axis. |
required |
origin
|
tuple(float, float)
|
Plot origin coordinate. |
(0, 0)
|
circle
|
bool
|
Draw a circle around the position indicating a 10 nm/s² uncertainty. |
True
|
ax
|
Axis on which to draw the plot. |
None
|
|
**kwargs
|
dict
|
Arguments to pass on to |
{}
|