Skip to content

redplanet.Crust.boug.load 

load(model: str = None) -> None

Load Bouguer gravity anomaly dataset.

Parameters:

Name Type Description Default
model str

Name of the Bouguer model to load. Options are:

  • 'Genova2016' (127 MiB) — Bouguer gravity anomaly map from Genova (2016), computed from truncated GMM-3 solution (degree 2 to 90) (Genova et al., 2016).
 None

Raises:

Type Description
ValueError

If an invalid model name is provided.
References
  1. Genova, A. (2016). Bouguer Gravity Anomaly Map Derived from the NASA GMM-3 Gravity Field [Dataset]. NASA PDS. https://pds-geosciences.wustl.edu/mro/mro-m-rss-5-sdp-v1/mrors_1xxx/data/rsdmap/ [See "ggmro_120_bouguer_90" .img and .lbl files]
  2. Genova, A., Goossens, S., Lemoine, F. G., Mazarico, E., Neumann, G. A., Smith, D. E., & Zuber, M. T. (2016). Seasonal and static gravity field of Mars from MGS, Mars Odyssey and MRO radio science. Icarus, 272, 228-245. https://doi.org/10.1016/j.icarus.2016.02.050
Source code in src/redplanet/Crust/boug/loader.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
@substitute_docstrings
def load(model: str = None) -> None:
    """
    Load Bouguer gravity anomaly dataset.

    Parameters
    ----------
    model : str
        Name of the Bouguer model to load. Options are:

        - `'Genova2016'` (127 MiB) — Bouguer gravity anomaly map from {@Genova2016_boug_data.n}, computed from truncated GMM-3 solution (degree 2 to 90) ({@Genova2016_boug_paper.p}).

    Raises
    ------
    ValueError
        If an invalid model name is provided.
    """

    ## I expect to add more later, so users should explicitly choose Genova2016 for forward compatibility.
    info = {
        'Genova2016': {
            'shape'          : (2880, 5760),
            'dtype'          : np.float64,
            'post-processing': lambda arr: np.flipud(arr),
            'lon'            : np.linspace(  0, 360, 5760, endpoint=False) + 1 / (2 * 16),
            'lat'            : np.linspace(-90,  90, 2880, endpoint=False) + 1 / (2 * 16),
            'metadata': {
                'description': 'Bouguer gravity anomaly map computed from truncated GMM-3 solution (degree 2 to 90).',
                'units'      : 'mGal',
                'links'      : {
                    'download': 'https://pds-geosciences.wustl.edu/mro/mro-m-rss-5-sdp-v1/mrors_1xxx/data/rsdmap/',
                    'lbl'     : 'https://pds-geosciences.wustl.edu/mro/mro-m-rss-5-sdp-v1/mrors_1xxx/data/rsdmap/ggmro_120_bouguer_90.lbl',
                },
            },
        },
    }

    if model not in info:
        raise ValueError(f"Invalid Bouguer model: '{model}'. Options are: {list(info.keys())}.")



    if model == 'Genova2016':

        fpath = _get_fpath_dataset(model)

        dat = np.memmap(
            fpath,
            mode  = 'r',
            dtype = info[model]['dtype'],
            shape = info[model]['shape'],
        )
        dat = info[model]['post-processing'] (dat)

        metadata = info[model]['metadata']
        metadata['fpath'] = fpath

        global _dat_boug
        _dat_boug = GriddedData(
            lon       = info[model]['lon'],
            lat       = info[model]['lat'],
            is_slon   = False,
            data_dict = {'boug': dat},
            metadata  = metadata,
        )



    else:
        raise ValueError(f"THE DEVELOPER MESSED UP. THIS SHOULD NOT HAPPEN.")

    return