spacepy.irbempy.find_Bmirror

spacepy.irbempy.find_Bmirror(ticks, loci, alpha, extMag='T01STORM', options=[1, 0, 0, 0, 0], omnivals=None)[source]

call find_mirror_point from irbem library and return a dictionary with values for Blocal, Bmirr and the GEO (cartesian) coordinates of the mirror point

Parameters:
ticksTicktock class

containing time information

lociCoords class

containing spatial information

alphaarray-like

containing the pitch angles

extMagstr

optional; will choose the external magnetic field model possible values [‘0’, ‘MEAD’, ‘T87SHORT’, ‘T87LONG’, ‘T89’, OPQUIET’, ‘OPDYN’, ‘T96’, ‘OSTA’, ‘T01QUIET’, ‘T01STORM’, ‘T05’, ‘ALEX’, ‘TS07’]

optionsarray-like (optional)

length=5 : explained in Lstar

omnivalsdict (optional)

if not provided, will use lookup table (see get_Lstar documentation for further explanation)

Returns:
resultsdictionary

containing keys: Blocal, Bmirr, GEOcar

See also

get_Lstar, get_Bfield, find_magequator

Examples

>>> t = Ticktock(['2002-02-02T12:00:00', '2002-02-02T12:10:00'], 'ISO')
>>> y = Coords([[3,0,0],[2,0,0]], 'GEO', 'car', use_irbem=True)
>>> ib.find_Bmirror(t,y,[90,80,60,10])
{'Blocal': array([ 0.,  0.]),
 'Bmirr': array([ 0.,  0.]),
 'loci': Coords( [[ NaN  NaN  NaN]
 [ NaN  NaN  NaN]] ), dtype=GEO,car, units=['Re', 'Re', 'Re']}