ship_mapper.map_density¶
-
ship_mapper.
map_density
(info, file_in=None, cmap='Default', sidebar=False, to_screen=True, save=True, filename_out='auto', filedir_out='auto')[source]¶ Plots a map using a gridded (or merged) file
Parameters: info (info) –
info
object containing metadataKeyword Arguments: - file_in (str) – Gridded or merged file to map. If
None
it looks formerged_grid.nc
in the merged directory - cmap (str) – Colormap to use
- sidebar (bool) – If
True
, includes side panel with metadata - to_screen (bool) – If
True
, a plot is printed to screen - save (bool) – If
True
a.png
figure is saved to hardrive - filename_out (str) – Name of produced figure.
If
auto
then name isinfo.run_name + '__' + file_in + '.png'
- filedir_out (str) – Directory where figure is saved.
If
auto
then output directory isinfo.dirs.pngs
Returns: Basemap object
- file_in (str) – Gridded or merged file to map. If