Matplotlib.axis.Axis.get_units() function in Python

Matplotlib is a library in Python and it is numerical – mathematical extension for NumPy library. It is an amazing visualization library in Python for 2D plots of arrays and used for working with the broader SciPy stack.

Matplotlib.axis.Axis.get_units() Function

The Axis.get_units() function in axis module of matplotlib library is used to get the units for axis. 

Syntax: Axis.get_units(self) 

Parameters: This method does not accepts any parameters. 

Return value: This method return the units for axis. 

Below examples illustrate the matplotlib.axis.Axis.get_units() function in matplotlib.axis:
Example 1:

Python3

# Implementation of matplotlib function
from matplotlib.axis import Axis
import random
import matplotlib.lines as lines
import matplotlib.patches as patches
import matplotlib.text as text
import matplotlib.collections as collections
from basic_units import cm, inch
import numpy as np
import matplotlib.pyplot as plt

fig, ax = plt.subplots()
ax.xaxis.set_units(cm)
ax.yaxis.set_units(cm)

np.random.seed(19680801)

line = lines.Line2D([2*cm, 8*cm], [0*cm, 2.5*cm],
                    lw=2, color='green', axes=ax)
ax.add_line(line)

t = text.Text(3*cm, 2.5*cm,
              'Line 1',
              ha='left',
              va='bottom',
              axes=ax,
              color='red')
ax.add_artist(t)

ax.grid(True)

print("Value return by get_units() :",
      ax.xaxis.get_units())

fig.suptitle("""matplotlib.axis.Axis.get_units()
function Example\n""", fontweight ="bold")

plt.show()

Output:

Value return by get_units() : centimeters

Example 2:

Python3

# Implementation of matplotlib function
from matplotlib.axis import Axis
import numpy as np
import matplotlib.pyplot as plt
from basic_units import secs

# create masked array
data = (1, 2, 3, 4, 5, 6, 7, 8)
mask = (1, 0, 1, 0, 0, 0, 1, 0)
xsecs = secs * np.ma.MaskedArray(data, mask, float)

fig, ax1 = plt.subplots()

ax1.scatter(xsecs, xsecs)
ax1.yaxis.set_units(secs)

ax1.grid()

print("Value return by get_units() :",
      ax1.yaxis.get_units())

fig.suptitle("""matplotlib.axis.Axis.get_units()
function Example\n""", fontweight ="bold")

plt.show()

Output:

Value return by get_units() : seconds