mpl_toolkits.axes_grid1.axes_rgb.RGBAxes

class mpl_toolkits.axes_grid1.axes_rgb.RGBAxes(*args, pad=0, add_all=<deprecated parameter>, **kwargs)[source]

Bases: object

4-panel imshow (RGB, R, G, B).

Layout: +---------------+-----+ | | R | + +-----+ | RGB | G | + +-----+ | | B | +---------------+-----+

Subclasses can override the _defaultAxesClass attribute.

Attributes:
RGB_defaultAxesClass

The axes object for the three-channel imshow.

R_defaultAxesClass

The axes object for the red channel imshow.

G_defaultAxesClass

The axes object for the green channel imshow.

B_defaultAxesClass

The axes object for the blue channel imshow.

Parameters:
padfloat, default: 0

fraction of the axes height to put as padding.

add_allbool, default: True

Whether to add the {rgb, r, g, b} axes to the figure. This parameter is deprecated.

axes_classmatplotlib.axes.Axes
*args

Unpacked into axes_class() init for RGB

**kwargs

Unpacked into axes_class() init for RGB, R, G, B axes

__dict__ = mappingproxy({'__module__': 'mpl_toolkits.axes_grid1.axes_rgb', '__doc__': '\n 4-panel imshow (RGB, R, G, B).\n\n Layout:\n +---------------+-----+\n | | R |\n + +-----+\n | RGB | G |\n + +-----+\n | | B |\n +---------------+-----+\n\n Subclasses can override the ``_defaultAxesClass`` attribute.\n\n Attributes\n ----------\n RGB : ``_defaultAxesClass``\n The axes object for the three-channel imshow.\n R : ``_defaultAxesClass``\n The axes object for the red channel imshow.\n G : ``_defaultAxesClass``\n The axes object for the green channel imshow.\n B : ``_defaultAxesClass``\n The axes object for the blue channel imshow.\n ', '_defaultAxesClass': <class 'mpl_toolkits.axes_grid1.mpl_axes.Axes'>, '__init__': <function RGBAxes.__init__>, 'add_RGB_to_figure': <function RGBAxes.add_RGB_to_figure>, 'imshow_rgb': <function RGBAxes.imshow_rgb>, '__dict__': <attribute '__dict__' of 'RGBAxes' objects>, '__weakref__': <attribute '__weakref__' of 'RGBAxes' objects>, '__annotations__': {}})
__init__(*args, pad=0, add_all=<deprecated parameter>, **kwargs)[source]
Parameters:
padfloat, default: 0

fraction of the axes height to put as padding.

add_allbool, default: True

Whether to add the {rgb, r, g, b} axes to the figure. This parameter is deprecated.

axes_classmatplotlib.axes.Axes
*args

Unpacked into axes_class() init for RGB

**kwargs

Unpacked into axes_class() init for RGB, R, G, B axes

__module__ = 'mpl_toolkits.axes_grid1.axes_rgb'
__weakref__

list of weak references to the object (if defined)

add_RGB_to_figure()[source]

[Deprecated] Add red, green and blue axes to the RGB composite's axes figure.

Notes

Deprecated since version 3.3.

imshow_rgb(r, g, b, **kwargs)[source]

Create the four images {rgb, r, g, b}.

Parameters:
rarray-like

The red array

garray-like

The green array

barray-like

The blue array

kwargsimshow kwargs

kwargs get unpacked into the imshow calls for the four images

Returns:
rgbmatplotlib.image.AxesImage
rmatplotlib.image.AxesImage
gmatplotlib.image.AxesImage
bmatplotlib.image.AxesImage

Examples using mpl_toolkits.axes_grid1.axes_rgb.RGBAxes