simpeg.electromagnetics.frequency_domain.receivers.PointMagneticField#

class simpeg.electromagnetics.frequency_domain.receivers.PointMagneticField(locations, orientation='x', component='real', **kwargs)[source]#

Bases: BaseRx

Measure FDEM total magnetic field at a point.

Parameters:
locations(n_loc, n_dim) numpy.ndarray

Receiver locations.

orientation{‘x’, ‘y’, ‘z’}

Receiver orientation.

component{‘real’, ‘imag’, ‘both’, ‘complex’}

Component of the receiver; i.e. ‘real’ or ‘imag’. The options ‘both’ and ‘complex’ are only available for the 1D layered simulations.

data_type{‘field’, ‘ppm’}

Data type observed by the receiver, either field, or ppm secondary of the total field.

use_source_receiver_offsetbool, optional

Whether to interpret the receiver locations as defining the source and receiver offset.

Attributes

component

Data component; i.e. real or imaginary.

data_type

The type of data for this receiver.

locations

Receiver locations

nD

Number of data associated with the receiver

orientation

Orientation of the receiver.

uid

Universal unique identifier

use_source_receiver_offset

Use source-receiver offset.

Methods

eval(src, mesh, f)

Project fields from the mesh to the receiver(s).

evalDeriv(src, mesh, f[, du_dm_v, v, adjoint])

Derivative of the projected fields with respect to the model, times a vector.

getP(mesh, projected_grid)

Get projection matrix from mesh to receivers

Notes

data_type, use_source_receiver_offset, and the options of ‘both’ and ‘complex’ for component are only implemented for the Simulation1DLayered.