2.3. cpforager.parameters.get_plot_params

cpforager.parameters.get_plot_params()

Create a plot parameters dictionary.

Param:

None

Returns:

a dictionary of plot parameters

Return type:

dict

The dictionary of plot parameters required to produce the diagnostic of GPS, TDR and AXY classes. Find below the exhaustive table of parameters within the dictionary.

name	description	required
cols_1	discrete contrasted color palette for trips	GPS, AXY
cols_2	continuous color palette for speed gradient	GPS, AXY
cols_3	continuous color palette for time gradient	GPS, AXY
main_fs	fontsize of the plot title	GPS, TDR, AXY
labs_fs	fontsize of the plot labels	GPS, TDR, AXY
axis_fs	fontsize of the plot axes	GPS, TDR, AXY
text_fs	fontsize of the plot texts	GPS, TDR, AXY
pnt_size	size of the scatter plot points	GPS, TDR, AXY
eph_size	size of the scatter plot emphasized points	GPS, TDR, AXY
mrk_size	size of vplot markers	GPS, TDR, AXY
pnt_type	type of the scatter plot points	GPS, TDR, AXY
grid_lwd	linewidth of the plot background grid	GPS, TDR, AXY
grid_col	line color of the plot background grid	GPS, TDR, AXY
grid_lty	line type of the plot background grid	GPS, TDR, AXY
night_transp	transparency applied to night grey box in timeserie plot	GPS, TDR, AXY
cb_shrink	colorbar shrink factor	GPS, AXY
cb_pad	colorbar padding factor	GPS, AXY
cb_aspect	colorbar size	GPS, AXY
fig_dpi	dots per inch of a saved figure	GPS, TDR, AXY
lon_fmt	longitude formatter	GPS, AXY
lat_fmt	latitude formatter	GPS, AXY