This object can be used to store tipper (ZTEM) surveys - a natural-source geophysical method. Data are provided in the frequency-domain as point source measurements of tipper data.

The following example shows how to generate a tipper survey with associated data stored in geoh5 format and accessible from Geoscience ANALYST.


import numpy as np
from geoh5py.workspace import Workspace
from geoh5py.objects import TipperReceivers, TipperBaseStations

# Create a new project
workspace = Workspace("my_project.geoh5")

# Define the pole locations
n_stations = 64
n_lines = 2
x_loc, y_loc = np.meshgrid(np.linspace(0, 60, n_stations), np.linspace(-20, 20., n_lines))
vertices = np.c_[x_loc.ravel(), y_loc.ravel(), np.zeros_like(x_loc).ravel()]

# Assign a line ID to the poles (vertices)
parts = np.kron(np.arange(n_lines), np.ones(n_stations)).astype('int')

# Create the survey from vertices
receivers = TipperReceivers.create(workspace, vertices=vertices, parts=parts)
base = TipperBaseStations.create(workspace, vertices=vertices)

We have so far created two seperate entities, one for the receiver locations and another for the base station(s). In order to finalize the survey, the association must be made between the two entities:

receivers.base_station = base

or equivalently

base.receivers = receivers

Only one of the two options above is needed.


Along with the TipperReceivers, the metadata contains all the necessary information to define the geophysical experiment.

{'EM Dataset': {'Base stations': UUID('91f1c114-2296-4ea4-be4d-7a48c30dbec9'),
  'Channels': [],
  'Input type': 'Rx and base stations',
  'Property groups': [],
  'Receivers': UUID('0858caad-579f-4985-b88e-bd66038ec0f2'),
  'Survey type': 'ZTEM',
  'Unit': 'Hertz (Hz)'}}


List of frequencies at which the data are provided.

receivers.channels = [30., 45., 90., 180., 360., 720.]

Input type

Generic label used in the geoh5 standard for all EM survey entities. Restricted to Rx and base station in the case of a tipper survey.

Property groups

List of PropertyGroups defining the various data components (e.g. Txz (real), Tyz (imag), …). It is not required to supply all components of the impedence tensor, but it is expected that each component contains a list of data channels of length and in the same order as the Channels (one Data per frequency).

The class method add_components_data can help users add data from nested dictionaries. Below is an example using four components:

# Arbitrary data generator using sine functions
data_fun = lambda c, f: (c+1.) * (f+1.) * np.sin(f * np.pi * (x_loc * y_loc).ravel() / 400.)

# Create a nested dictionary of component and frequency data.
data = {
    component : {
        f"{component}_{freq}": {"values": data_fun(cc, ff)} for ff, freq in enumerate(receivers.channels)
    } for cc, component in enumerate([
        "Txz (real)", "Txz (imaginary)",
        "Tyz (real)", "Tyz (imaginary)",

[<geoh5py.groups.property_group.PropertyGroup at 0x7f0b667f45d0>,
 <geoh5py.groups.property_group.PropertyGroup at 0x7f0b6674b6d0>,
 <geoh5py.groups.property_group.PropertyGroup at 0x7f0b66759b10>,
 <geoh5py.groups.property_group.PropertyGroup at 0x7f0b6675da90>]

Metadata are updated immediately to reflect the addition of components:

{'EM Dataset': {'Base stations': UUID('91f1c114-2296-4ea4-be4d-7a48c30dbec9'),
  'Channels': [30.0, 45.0, 90.0, 180.0, 360.0, 720.0],
  'Input type': 'Rx and base stations',
  'Property groups': ['Txz (real)',
   'Txz (imaginary)',
   'Tyz (real)',
   'Tyz (imaginary)'],
  'Receivers': UUID('0858caad-579f-4985-b88e-bd66038ec0f2'),
  'Survey type': 'ZTEM',
  'Unit': 'Hertz (Hz)'}}

Data channels associated with each component can be quickly accessed through the BaseEMSurvey.components property:

{'Txz (real)': [<geoh5py.data.float_data.FloatData at 0x7f0b667c5d10>,
  <geoh5py.data.float_data.FloatData at 0x7f0b66874350>,
  <geoh5py.data.float_data.FloatData at 0x7f0b66874650>,
  <geoh5py.data.float_data.FloatData at 0x7f0b668744d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b667bc950>,
  <geoh5py.data.float_data.FloatData at 0x7f0b667f4ed0>],
 'Txz (imaginary)': [<geoh5py.data.float_data.FloatData at 0x7f0b9077f1d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b667f4210>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6674b2d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6674b4d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6674b110>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6674b550>],
 'Tyz (real)': [<geoh5py.data.float_data.FloatData at 0x7f0b66757f10>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6674b7d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b667596d0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b66759850>,
  <geoh5py.data.float_data.FloatData at 0x7f0b66759650>,
  <geoh5py.data.float_data.FloatData at 0x7f0b66759990>],
 'Tyz (imaginary)': [<geoh5py.data.float_data.FloatData at 0x7f0b66759c10>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6675ddd0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6675dfd0>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6675d910>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6675d790>,
  <geoh5py.data.float_data.FloatData at 0x7f0b6675d8d0>]}


Generic label used in the geoh5 standard for EM survey to identify the TipperReceivers entity.

Base stations

Generic label used in the geoh5 standard for EM survey to identify the TipperBaseStations entity.

Survey type

Label identifier for ZTEM survey type.


Units for frequency sampling of the data: Hertz (Hz), KiloHertz (kHz), MegaHertz (MHz) or Gigahertz (GHz).

/home/docs/checkouts/readthedocs.org/user_builds/geoh5py/conda/v0.6.0/lib/python3.7/site-packages/geoh5py/workspace/workspace.py:854: UserWarning: The 'finalize' method will be deprecated in future versions of geoh5py in favor of `workspace.close()`. Please update your code to suppress this warning.
  "The 'finalize' method will be deprecated in future versions of geoh5py in"