SHMagCoeffs class

A class for magnetic potential spherical harmonic coefficients.

Subclasses

Subclass name	Description
SHMagRealCoeffs	Real magnetic potential spherical harmonic coefficient class.

Initialization

Initialization method	Description
`x = SHMagCoeffs.from_array()`	Initialize using coefficients from an array.
`x = SHMagCoeffs.from_random()`	Initialize using random coefficients with a prescribed power spectrum.
`x = SHMagCoeffs.from_zeros()`	Initialize with coefficients set to zero.
`x = SHMagCoeffs.from_file()`	Initialize using coefficients from a file.
`x = SHMagCoeffs.from_netcdf()`	Initialize using coefficients from a netcdf file.

Class attributes

Attribute	Description
`lmax`	The maximum spherical harmonic degree of the coefficients.
`coeffs`	The raw coefficients with the specified normalization and phase conventions.
`errors`	The uncertainties of the spherical harmonic coefficients.
`error_kind`	An arbitrary string describing the kind of errors, such as `None`, `'unspecified'`, `'calibrated'` or `'formal'`.
`r0`	The reference radius of the magnetic potential coefficients.
`normalization`	The normalization of the coefficients: `'4pi'`, `'ortho'`, `'schmidt'`, or `'unnorm'`.
`csphase`	Defines whether the Condon-Shortley phase is used (`1`) or not (`-1`).
`mask`	A boolean mask that is `True` for the permissible values of degree `l` and order `m`.
`kind`	The coefficient data type (only `'real'` is permissible).
`units`	The units of the spherical harmonic coefficients.
`year`	The year of the time-variable spherical harmonic coefficients.
`header`	A list of values from the header line of the input file used to initialize the class.
`header2`	A list of values from the second header line of the input file used to initialize the class.

Class methods

Method	Description
`degrees()`	Return an array listing the spherical harmonic degrees from `0` to `lmax`.
`spectrum()`	Return the spectrum of the function.
`correlation()`	Return the spectral correlation with another function.
`set_coeffs()`	Set coefficients in-place to specified values.
`change_ref()`	Return a new class instance referenced to a different reference radius, r0.
`rotate()`	Rotate the coordinate system used to express the spherical harmonics coefficients and return a new class instance.
`convert()`	Return a new class instance using a different normalization convention.
`pad()`	Return a new class instance that is zero padded or truncated to a different `lmax`.
`expand()`	Calculate the three vector components of the magnetic field, the total field, and the magnetic potential, and return an SHMagGrid class instance.
`tensor()`	Calculate the 9 components of the magnetic field tensor and return an SHMagTensor class instance.
`plot_spectrum()`	Plot the spectrum as a function of spherical harmonic degree.
`plot_spectrum2d()`	Plot the spectrum of all spherical-harmonic coefficients.
`plot_correlation()`	Plot the correlation with another function.
`to_array()`	Return an array of spherical harmonics coefficients with a different normalization convention.
`to_file()`	Save raw spherical harmonic coefficients to a text or binary file.
`to_netcdf()`	Return the coefficient data as a netcdf formatted file or object.
`copy()`	Return a copy of the class instance.
`info()`	Print a summary of the data stored in the SHMagCoeffs instance.

Edit me