get_tsyganenko_on_lfm_grid¶
- rbinvariantslib.models.get_tsyganenko_on_lfm_grid(model_name, params, time, lfm_hdf4_path, external_field_only=False) MagneticFieldModel¶
Helper function to get one of the tsyganenko fields on an LFM grid.
- Parameters:
- model_name{‘T96’, ‘TS05’}
Name of the magnetic field model to use.
- paramsdictionary of string to array
Parameters to support Tsyganenko magnetic field mode
- timedatetime, no timezone
Time to support the Tsyganenko magnetic field model
- lfm_hdf4_pathstr
Path to LFM file in HDF4 format to provide grid.
- external_field_onlybool
Set to True to not include the internal (dipole) model
- Returns:
- model
MagneticFieldModel Magnetic model on LFM grid with dipole field values. Grid is in units of Re and magnetic field is is units of Gauss.
- model
