pygmt.src.ClipAccessor.solar

ClipAccessor.solar(**kwargs)

Clip the data to the solar terminator.

Must be used as a context manager. Any plotting operations within the context manager will be clipped to the solar terminator.

Parameters:

kwargs – Additional keyword arguments passed to pygmt.Figure.solar. Not all parameters make sense in this context.

Examples

>>> from pygmt import Figure
>>> from pygmt.datasets import load_earth_relief
>>>
>>> grid = load_earth_relief()
>>> fig = Figure()
>>> fig.basemap(region="g", projection="W15c", frame=True)
>>> with fig.clip.solar(terminator="civil"):
...     fig.grdimage(grid, cmap="geo")
>>> fig.show()