iptsetpref (Image Processing Toolbox User's Guide)

Image Processing Toolbox User's Guide

Set Image Processing Toolbox preferences or display valid values

Syntax

iptsetpref(prefname)
iptsetpref(prefname,value)

Description

iptsetpref(prefname) displays the valid values for the Image Processing Toolbox preference specified by prefname.

iptsetpref(prefname,value) sets the Image Processing Toolbox preference specified by the string prefname to the value specified by value. The setting persists until the end of the current MATLAB session, or until you change the setting. (To make the value persist between sessions, put the command in your startup.m file.)

This table describes the available preferences. Note that the preference names are case insensitive and can be abbreviated. The default value is enclosed in braces ({}).

Preference Name
Description

'ImshowBorder'
Controls whether imshow includes a border around the image in the figure window. Possible values:

{'loose'} -- Include a border between the image and the edges of the figure window, thus leaving room for axes labels, titles, etc.

'tight' -- Adjust the figure size so that the image entirely fills the figure.

Note: There can still be a border if the image is very small, or if there are other objects besides the image and its axes in the figure.

'ImshowAxesVisible'
Controls whether imshow displays images with the axes box and tick labels. Possible values:

'on' -- Include axes box and tick labels.

{'off'} -- Do not include axes box and tick labels.

'ImshowInitialMagnification'
Controls the initial magnification of the image displayed by imshow. Possible values:

Any numeric value -- imshow interprets numeric values as a percentage. The default value is 100. One hundred percent magnification means that there should be one screen pixel for every image pixel.

'fit' -- Scale the image so that it fits into the window in its entirety.

You can override this preference by specifying the 'InitialMagnification' parameter when you call imshow, or by calling the truesize function manually after displaying the image.

'ImtoolInitialMagnification'
Controls the initial magnification of the image displayed by imtool. Possible values:

{'adaptive'} -- Display the entire image. If the image is too large to display on the screen at 100% magnification, display the image at the largest magnification that fits on the screen. This is the default.

Any numeric value -- Specify the magnification as a percentage. One hundred percent magnification means that there should be one screen pixel for every image pixel.

'fit' -- Scale the image so that it fits into the window in its entirety.

You can override this this preference by specifying the 'InitialMagnification' parameter when you call imtool.

Preference Name	Description
`'ImshowBorder'`	Controls whether `imshow` includes a border around the image in the figure window. Possible values: `{'loose'}` -- Include a border between the image and the edges of the figure window, thus leaving room for axes labels, titles, etc. `'tight'` -- Adjust the figure size so that the image entirely fills the figure. Note: There can still be a border if the image is very small, or if there are other objects besides the image and its axes in the figure.
`'ImshowAxesVisible'`	Controls whether `imshow` displays images with the axes box and tick labels. Possible values: `'on'` -- Include axes box and tick labels. `{'off'}` -- Do not include axes box and tick labels.
`'ImshowInitialMagnification'`	Controls the initial magnification of the image displayed by `imshow`. Possible values: Any numeric value -- `imshow` interprets numeric values as a percentage. The default value is `100`. One hundred percent magnification means that there should be one screen pixel for every image pixel. `'fit'` -- Scale the image so that it fits into the window in its entirety. You can override this preference by specifying the `'InitialMagnification'` parameter when you call `imshow`, or by calling the `truesize` function manually after displaying the image.
`'ImtoolInitialMagnification'`	Controls the initial magnification of the image displayed by `imtool`. Possible values: `{'adaptive'}` -- `D`isplay the entire image. If the image is too large to display on the screen at 100% magnification, display the image at the largest magnification that fits on the screen. This is the default. Any numeric value -- Specify the magnification as a percentage. One hundred percent magnification means that there should be one screen pixel for every image pixel. `'fit'` -- Scale the image so that it fits into the window in its entirety. You can override this this preference by specifying the `'InitialMagnification'` parameter when you call `imtool`.

Example

```
iptsetpref('ImshowBorder','tight')
```

See Also

imshow, imtool, iptgetpref, truesize

axis in the MATLAB Function Reference

iptremovecallback iptwindowalign