@@ -8,8 +8,15 @@ def make_rgb_axes(ax, pad=0.01, axes_class=None, **kwargs):
88 """
99 Parameters
1010 ----------
11- pad : float
12- Fraction of the axes height.
11+ ax : `matplotlib.axes.Axes`
12+ Axes instance to create the RGB axes in.
13+ pad : float, optional
14+ Fraction of the axes height to pad.
15+ axes_class : `matplotlib.axes.Axes` or None, optional
16+ Axes class to use for the R, G, and B axes. If None, use
17+ the same class as *ax*.
18+ **kwargs :
19+ Unpacked into *axes_class* init for R, G, and B axes.
1320 """
1421
1522 divider = make_axes_locatable (ax )
@@ -89,12 +96,12 @@ def __init__(self, *args, pad=0, **kwargs):
8996 ----------
9097 pad : float, default: 0
9198 fraction of the axes height to put as padding.
92- axes_class : matplotlib.axes.Axes
93-
99+ axes_class : ` matplotlib.axes.Axes`
100+ Axes class to use. If not provided ``_defaultAxesClass`` is used.
94101 *args
95- Unpacked into axes_class() init for RGB
102+ Unpacked into * axes_class* init for RGB
96103 **kwargs
97- Unpacked into axes_class() init for RGB, R, G, B axes
104+ Unpacked into * axes_class* init for RGB, R, G, B axes
98105 """
99106 axes_class = kwargs .pop ("axes_class" , self ._defaultAxesClass )
100107 self .RGB = ax = axes_class (* args , ** kwargs )
@@ -114,15 +121,15 @@ def imshow_rgb(self, r, g, b, **kwargs):
114121 ----------
115122 r, g, b : array-like
116123 The red, green, and blue arrays.
117- kwargs : imshow kwargs
118- kwargs get unpacked into the imshow calls for the four images.
124+ ** kwargs :
125+ Unpacked into the `~.Axes. imshow` calls for the four images.
119126
120127 Returns
121128 -------
122- rgb : matplotlib.image.AxesImage
123- r : matplotlib.image.AxesImage
124- g : matplotlib.image.AxesImage
125- b : matplotlib.image.AxesImage
129+ rgb : ` matplotlib.image.AxesImage`
130+ r : ` matplotlib.image.AxesImage`
131+ g : ` matplotlib.image.AxesImage`
132+ b : ` matplotlib.image.AxesImage`
126133 """
127134 if not (r .shape == g .shape == b .shape ):
128135 raise ValueError (
0 commit comments