Full Index of API Reference

This page gives an overview of all public RedPlanet objects, functions and methods.

All of this information is also accessible with Python's built-in help function — for example, try running help(redplanet.Craters.get) in your shell/notebook.

---

[1] User Config

Configure where datasets will be downloaded and how file integrity is verified.

• get_dirpath_datacache()
• set_dirpath_datacache(...)
• get_max_size_to_calculate_hash_GiB()
• set_max_size_to_calculate_hash_GiB(...)
• get_enable_stream_hash_check()
• set_enable_stream_hash_check(...)

---

[2] Datasets

Loading/accessing datasets in a standardized way.

• Craters:
  • get(...)
• Crust:
  • Topography / DEM:
    • load(...)
    • get(...)
    • get_metadata()
    • get_dataset()
  • Dichotomy:
    • get_coords()
    • is_above(...)
  • Mohorovičić Discontinuity / Crustal Thickness:
    • get_registry()
    • load(...)
    • get(...)
    • get_metadata()
    • get_dataset()
  • Bouguer Anomaly:
    • load(...)
    • get(...)
    • get_metadata()
    • get_dataset()
• Gamma-Ray Spectrometer (GRS):
  • get(...)
  • get_metadata()
  • get_dataset()
• Magnetic Field:
  • Spherical Harmonic Models:
    • load(...)
    • get(...)
    • get_metadata()
    • get_dataset()
  • Magnetic Source Depths:
    • get_dataset(...)
    • get_nearest(...)
    • get_grid(...)

All load(...) functions will check if a dataset file already exists in your cache directory. If found, it verifies the hash to ensure it wasn't modified; if not found, it will download and verify the file. For convenience, we provide prefetch() to download a few key datasets all at once.

To plot any raster (i.e. regularly gridded) data with many convenience features including hillshade underlay, use:

• plot(...)

 

---

[3] Analysis

Advanced dataset operations/calculations and other tools.

• Radial Profile:
  • get_concentric_ring_coords(...)
  • get_profile(...)
• Impact Demagnetization:
  • compute_pressure(...)

---

[4] Helper Functions

Miscellaneous functions used internally.

• Coordinates:
  • _plon2slon(...)
  • _slon2plon(...)
• Geodesy:
  • get_distance(...)
  • move_forward(...)
  • make_circle(...)
• Misc:
  • timer(...)
  • prefetch()