Mercurial > octave
diff scripts/image/imshow.m @ 25856:9578af67a0d4 stable
Document that image x/ydata indicate the centers of corner pixels (bug #54610).
* image.m, imagesc.m, imshow.m: Rephrase doc for x and y arguments to make it
clear that they indicate the coordinates of the center of pixels.
* genpropdoc.m: Ditto.
| author | Pantxo Diribarne <pantxo.diribarne@gmail.com> |
|---|---|
| date | Fri, 07 Sep 2018 10:45:19 +0200 |
| parents | 6652d3823428 |
| children | 221c039aa415 |
line wrap: on
line diff
--- a/scripts/image/imshow.m Thu Aug 30 10:03:09 2018 -0400 +++ b/scripts/image/imshow.m Fri Sep 07 10:45:19 2018 +0200 @@ -48,15 +48,17 @@ ## @var{value1} is the colormap to use when displaying an indexed image. ## ## @item @qcode{"xdata"} -## If @var{value1} is a two element vector, it must contain horizontal axis -## limits in the form [xmin xmax]; Otherwise @var{value1} must be a vector and -## only the first and last elements will be used for xmin and xmax +## If @var{value1} is a 2-element vector, it must contain horizontal image +## limits in the form [xmin, xmax], where xmin and xmax are the abscissa of +## the centers of the corner pixels. Otherwise @var{value1} must be a vector +## and only the first and last elements will be used for xmin and xmax ## respectively. ## ## @item @qcode{"ydata"} -## If @var{value1} is a two element vector, it must contain vertical axis -## limits in the form [ymin ymax]; Otherwise @var{value1} must be a vector and -## only the first and last elements will be used for ymin and ymax +## If @var{value1} is a 2-element vector, it must contain vertical image +## limits in the form [ymin, ymax], where ymin and ymax are the ordinates of +## the center of the corner pixels. Otherwise @var{value1} must be a vector +## and only the first and last elements will be used for ymin and ymax ## respectively. ## ## @end table