In the example below, the scale bar for a length_fraction of 0.25 and 0.5 is the same because the scale cannot have a value between 2 and 5 mm.ĭeprecated, use width_fraction. If you want a specific value, see fixed_value and fixed_units. The actual length of the scale bar is automatically determined based on the specified pixel size ( dx and units) and the contraint that the scale value can only take the following numbers: 1, 2, 5, 10, 15, 20, 25, 50, 75, 100, 125, 150, 200, 500 or 750. length_fractionĭesired length of the scale bar as a fraction of the subplot's width.ĭefault: None, value from matplotlibrc or 0.2. The position of the label with respect to the scale bar can be adjusted using label_loc argument. Optional label associated with the scale bar. imshow ( im, cmap = "gray" ) scalebar = ScaleBar ( 0.0315, "in", dimension = "imperial-length", length_fraction = 0.25 ) ax.
For example, dx = great_circle_distance((X, Y), (X + 1, Y))
PYTHON3 INSTALL MATPLOTLIB FULL
If you are plotting geospatial coordinates (such as scatterplots of the location of structures, geopandas geodataframe plots, etc.), dx needs to be set differently depending on the coordinate system: imshow ( im, cmap = "gray", extent = ) scalebar = ScaleBar ( 1, "cm", length_fraction = 0.25 ) ax. Set dx to 1.0 if the axes image has already been calibrated by setting its extent. Size of one pixel in units specified by the next argument. The following schematic illustrates the nomenclature used in the definition of the arguments. scalebar = ScaleBar ( dx, units = "m", dimension = "si-length", label = None, length_fraction = None, height_fraction = None, width_fraction = None, location = None, pad = None, border_pad = None, sep = None, frameon = None, color = None, box_color = None, box_alpha = None, scale_loc = None, label_loc = None, font_properties = None, label_formatter = None, scale_formatter = None, fixed_value = None, fixed_units = None, animated = False, rotation = None, )Įach argument can also be changed afterwards using their respective property.
PYTHON3 INSTALL MATPLOTLIB HOW TO
Here are arguments of the ScaleBar class constructor and examples how to use them. imshow ( im, cmap = "gray" ) # Create scale bar scalebar = ScaleBar ( 0.08, "cm", length_fraction = 0.25 ) ax. reshape (( 256, 256 )) # Create subplot fig, ax = plt. get_sample_data ( "" ) as dfile : im = np. import numpy as np import matplotlib.pyplot as plt import matplotlib.cbook as cbook from matplotlib_scalebar.scalebar import ScaleBar # Load image with cbook. In this example, we load a sample image from the matplotlib library, create a subplot, plot image, create scale bar and add scale bar as an "artist" of the subplot. See examples below for other system of units. The constructor arguments dx and units specify the pixel dimension.įor example ScaleBar(0.2, 'um') indicates that each pixel is equal to 0.2 micrometer.īy default, the scale bar uses SI units of length (e.g. There are many ways to customize the scale bar.Įxamples and explanations of the arguments of the ScaleBar class are given below, but here is a quick start guide. InstallationĮasiest way to install using pip: pip install matplotlib-scalebarįor development installation from the git repository: git clone install -e matplotlib-scalebar
The artist supports customization either directly from the ScaleBar object or from the matplotlibrc. It is particularly useful when displaying calibrated images plotted using Provides a new artist for matplotlib to display a scale bar, aka micron bar.
0 kommentar(er)
