milkviz.point_map#

milkviz.point_map(x, y, types: List | np.ndarray = None, types_colors: Dict = None, values: List | np.ndarray = None, links: List | np.ndarray = None, vmin: float = None, vmax: float = None, colors: List = None, cmap: Any = None, rotate: int = None, markersize: int = 5, linecolor: Any = '#cccccc', linewidth: int = 1, no_spines: bool = True, legend: bool = True, legend_kw: Dict = None, cbar_kw: Dict = None, ax: mpl.axes.Axes = None)#

Point map

Parameters
  • x – The x-coord array

  • y – The y-coord array

  • types – The types array that tells the types of points

  • types_colors – A dictionary that tells color for every type, key is the type and value is the color

  • values – The values array that tells the values of points

  • vmin – Remap your values to another range

  • vmax – Remap your values to another range

  • links – The links between points, should be a list of (point_index_1, point_index_2)

  • colors – The color array that map to marker colors

  • cmap – The colormap to be used, either a cmap name or a matplotlib.cm.ColorMap

  • rotate – The degree to rotate the whole plot according to origin

  • markersize – The size of marker

  • linecolor – The color of lines

  • linewidth – The width of lines

  • no_spines – If True, will turn off the frame of the plot

  • legend – If True, show legend

  • legend_kw – [legend_kw]

  • cbar_kw – [cbar_kw]

  • ax – Pre-existing axes for the plot. Or a new one will be created.

Returns

A matplotlib.axes.Axes instance