irfpy.mars.mpb

Magnetic pileup boundary (MPB) model.

Usage:

>>> from irfpy.mars import mpb
>>> mpb_model = mpb.MpbVignes.mpb_xr()

This will return the Vignes’s MPB model in X-R coordinates (as [2, 180] shaped matrix).

class irfpy.mars.mpb.MpbVignes

Bases: object

classmethod mpb_xr()

Return the magnetic pileup boundary position.

Returns:

The array with shape of (2, 180). Unit is in Rm.

>>> print(MpbVignes.mpb_xr()[:, 50])
[1.16947853 0.46878494]

classmethod inside(x, y, z)

Return if the s/c is in MPB

>>> print(MpbVignes.inside(1, 0, 0))
True
>>> print(MpbVignes.inside(0, 2, 0))
False

irfpy.mars.mpb.doctests()