harmonica.reduction_to_pole#
- harmonica.reduction_to_pole(grid, inclination, declination, magnetization_inclination=None, magnetization_declination=None, *, pad=True, pad_kwargs=None)[source]#
Calculate the reduction to the pole of a magnetic field grid.
Compute the reduction to the pole of regular gridded magnetic data using frequency domain calculations through Fast Fourier Transform.
- Parameters:
- grid
xarray.DataArray A two dimensional
xarray.DataArraywhose coordinates are evenly spaced (regular grid). Its dimensions should be in the following order: northing, easting. Its coordinates should be defined in the same units.- inclination
floatindegrees The inclination of the inducing Geomagnetic field.
- declination
floatindegrees The declination of the inducing Geomagnetic field.
- magnetization_inclination
floatindegreesorNone The inclination of the total magnetization of the anomaly source. If None, the
magnetization_inclinationwill be set equal to theinclination, neglecting remanent magnetization and self demagnetization. Default None.- magnetization_declination
floatindegrees The declination of the total magnetization of the anomaly source. If None, the
magnetization_declinationwill be set equal to thedeclination, neglecting remanent magnetization and self demagnetization. Default None.- padbool,
optional If True, will add padding to the grid before taking the Fourier Transform and applying the filter and remove it after the inverse Fourier Transform. Adding padding usually helps reduce edge effects from signal truncation. Default is True.
- pad_kwargs
dictorNone,optional Any additional keyword arguments that should be passed to the
xarray.DataArray.padfunction in the form of a dictionary. If none are given, the default padding of 25% the dimensions of the grid will be added using the “edge” method.
- grid
- Returns:
- reduced_to_pole_grid
xarray.DataArray A
xarray.DataArrayafter reduction to the pole of the passedgrid.
- reduced_to_pole_grid
References