Gravity Observations

Gravity Observations#

A class for handling gravity observation data, including methods for data manipulation, correction.

`GravityObservations`(site_id, datetime, meter_id)	Class to store and process gravity observations.
`GravityObservations.from_dataframe`(df[, ...])	Create object from a pandas DataFrame.
`GravityObservations.from_excel`(excel_file[, ...])	Create a object from an Excel file.
`GravityObservations.from_csv`(csv_file[, ...])	Create object from a CSV file.

`GravityObservations.known_fields`()	Return a list of known fields in the object.
`GravityObservations.required_fields`()	Return a list of required fields in the object.
`GravityObservations.set_column`(label[, ...])	Set a column in the `obj.data` attribute.
`GravityObservations.set_obs_id`([idx, ...])	Set obs_id as the index of the data DataFrame attribute.
`GravityObservations.loop_ids`	Return unique survey loop id's sorted by loop start time.
`GravityObservations.loop_summary`()	Return a summary of the observations by loop.
`GravityObservations.site_summary`([data_col])	Return summary statistics of observations by site.
`GravityObservations.params`()	Return parameters as a `GravityObservationsParameters` object.
`GravityObservations.activate`([obs_id, ...])	Set the "active" flag/field to True for specified observations.
`GravityObservations.deactivate`([obs_id, ...])	Set the "active" flag/field to False for specified observations.
`GravityObservations.check_data`([warn])	Check the data for errors.

`GravityObservations.starttime`	Earliest observation datetime.
`GravityObservations.endtime`	Latest observation datetime.
`GravityObservations.timedelta_unit`()	Time interval unit used for calculating survey timedelta.
`GravityObservations.set_timedelta_unit`(unit)	Set time interval unit used for calculating survey timedelta.
`GravityObservations.fixed_time_datum`()	Return time datum used for calculating timedelta.
`GravityObservations.set_fixed_time_datum`(t)	Set time datum used for calculating loop and survey timedelta.
`GravityObservations.set_tdelta`()	Calculate time delta for survey and loop observations.

`GravityObservations.apply_dial_to_mgal`(converter)	Apply dial to mgal conversion to observed "meter_reading".
`GravityObservations.set_calibration_factor`([...])	Set gravity meter calibration factor.
`GravityObservations.apply_earth_tide_correction`(sites)	Compute earth tide correction and store in column `column_name`.
`GravityObservations.apply_ocean_load_correction`(...)	Get ocean loading corrections and store in column `column_name`.
`GravityObservations.calculate_tide_corrected_gravity`()	Calculate corrected gravity values and assign to column 'gravity_corr'.

`GravityObservations.write_to_csv`(fname[, ...])	Write data to a csv file.
`GravityObservations.to_excel`(fname[, ...])	Write data to an excel file.

`GravityObservations.plot_observed_data`(loop)	Plot observed data.
`GravityObservations.plot_network_map`(sites)	Plot network map showing connections between stations.
`GravityObservations.plot_site_visits`(loop)	Plot the order of station visits for each loop.

A class for storing parameters and metadata related to reductions of data in a GravityObservations object.

`GravityObservationsParameters`([...])	Dataclass to hold parameters for pre-processing gravity observations.
`GravityObservationsParameters.from_series`(ds)	Generate a GsolveParameters object from a pandas.Series.
`GravityObservationsParameters.copy`()	Return a deep copy of object.
`GravityObservationsParameters.default_values`()	Return dict of default parameter values.
`GravityObservationsParameters.non_default_values`()	Return dict of non-default parameter values.
`GravityObservationsParameters.summary`([...])	Return parameters as strings in the form 'param: value'.
`GravityObservationsParameters.to_dict`()	Return parameters as a dict.
`GravityObservationsParameters.to_excel`(fname)	Write parameters to an Excel file.
`GravityObservationsParameters.to_series`([...])	Return parameters as a Series with parameter names as the index.

Merge 2 or more GravityObservations objects.