@@ -508,30 +508,31 @@ def get_image_magnification(self):
508508 """
509509return 1.0
510510
511- def draw_image (self ,gc ,x ,y ,im ,trans = None ):
511+ def draw_image (self ,gc ,x ,y ,im ,transform = None ):
512512"""
513- Drawthe image instance into the current axes;
513+ Drawan RGBA image.
514514
515515 *gc*
516- aGraphicsContext containing clipping information
516+ a:class:`GraphicsContextBase` instance with clipping information.
517517
518518 *x*
519- is the distance in pixels from the left hand side of the canvas.
519+ the distance in pixels from the left hand side of the canvas.
520520
521521 *y*
522- the distance from the origin. That is, if origin is
523- upper, y is the distance from top. If origin is lower, y
524- is the distance from bottom
522+ the distance in pixels from the bottom side of the canvas.
525523
526524 *im*
527525 An NxMx4 array of RGBA pixels (of dtype uint8).
528526
529- *trans*
530- If the concrete backend is written such that
531- `option_scale_image` returns `True`, an affine
532- transformation may also be passed to `draw_image`. The
533- backend should apply the transformation to the image
534- before applying the translation of `x` and `y`.
527+ *transform*
528+ If and only if the concrete backend is written such that
529+ :meth:`option_scale_image` returns ``True``, an affine
530+ transformation *may* be passed to :meth:`draw_image`. It takes the
531+ form of a :class:`~matplotlib.transforms.Affine2DBase` instance,
532+ with translation given in pixels. Note that this transformation
533+ does not override `x` and `y`, and has to be applied *before*
534+ translating the result by `x` and `y` (this can be accomplished
535+ by adding `x` and `y` to the translation defined by `transform`).
535536 """
536537raise NotImplementedError
537538
@@ -544,8 +545,8 @@ def option_image_nocomposite(self):
544545
545546def option_scale_image (self ):
546547"""
547- override this method for renderers that support arbitrary
548- scaling of image (mostof the vectorbackend ).
548+ override this method for renderers that support arbitrary affine
549+ transformations in :meth:`draw_image` (most vectorbackends ).
549550 """
550551return False
551552