Gravity Site and Reference Gravity Classes

Gravity Site and Reference Gravity Classes#

GravitySites#

Object Creation#

GravitySites(*, site_id, latitude, ...[, ...])

Class to store gravity site/station data and metadata.

GravitySites.from_excel(excel_file[, ...])

Create a GravitySites object from an excel workbook.

GravitySites.from_dataframe(df[, use_index, ...])

Create object from a pandas DataFrame.

GravitySites.from_csv(csv_file[, ...])

Create object from a CSV file.

GravitySites.merge(other[, if_duplicate])

Merge GravitySites objects.

GravitySites.copy()

Return a deep copy of object.

Data Attributes and Methods#

GravitySites.set_column(label[, data, ...])

Set a column in the obj.data attribute.

GravitySites.known_fields()

Return a list of known fields in the object.

GravitySites.required_fields()

Return a list of required fields in the object.

GravitySites.check_data([warn])

Check the data errors.

GravitySites.set_reference_gravity(ref_sites)

Load reference gravity values into the sites table.

GravitySites.activate_ties([site_id])

Set one or more "tie" sites as active, i.e. to be used in gsolve.

GravitySites.deactivate_ties([site_id])

Set one or more "tie" sites as inactive, i.e. not used in gsolve.

GravitySites.get_points(xcol, ycol[, zcol])

Get site point coordinates as numpy arrays.

GravitySites.get_site_ids()

Return site_id's as as numpy ndarray.

GravitySites.get_ties([active_only, ...])

Return rows sites that will be used as gsolve ties.

GravitySites.sample_elevation(dem[, ...])

Get elevations at site locations from an DEM/xarray grid.

Data Export#

GravitySites.to_excel(excel_file, *[, ...])

Write data DataFrame to an excel file.

GravitySites.write_to_csv(csv_file[, ...])

Write data DataFrame to csv file.

ReferenceGravity#

ReferenceGravity(site_id, gravity[, active])

Class providing a simple mechanism for merging reference gravity data.

ReferenceGravity.from_excel(excel_file[, ...])

Create an object from an Excel file.

ReferenceGravity.from_dataframe(df[, ...])

Create object from a pandas DataFrame.

ReferenceGravity.from_csv(csv_file[, ...])

Create object from a CSV file.

ReferenceGravity.from_dict(data[, set_active])

Create a ReferenceGravity object from a dictionary.

ReferenceGravity.merge(other[, if_duplicate])

Merge ReferenceSite objects.

ReferenceGravity.copy()

Return a deep copy of object.

ReferenceGravity.known_fields()

Return a list of known fields in the object.

ReferenceGravity.required_fields()

Return a list of required fields in the object.

ReferenceGravity.set_column(label[, data, ...])

Set a column in the obj.data attribute.

ReferenceGravity.to_excel(excel_file, *[, ...])

Write data to an excel file.

ReferenceGravity.write_to_csv(csv_file[, ...])

Write data to a csv file.