iptsetpref (Image Processing Toolbox)

Set Image Processing Toolbox preferences or display valid values

Syntax

```
iptsetpref(prefname,value)
```

Description

iptsetpref(prefname) displays the valid values for prefname. See Preferences for a complete list of available preferences.

iptsetpref(prefname,value) sets the Image Processing Toolbox preference specified by the string prefname to 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.)

Preferences

This table describes the available preferences. Note that the preference names are case insensitive and can be abbreviated.

Preference Name
Values
Description

'ImshowBorder'
'loose' (default) or 'tight'
If 'ImshowBorder' is 'loose', imshow displays the image with a border between the image and the edges of the figure window, thus leaving room for axes labels, titles, etc. If 'ImshowBorder' is 'tight', imshow adjusts the figure size so that the image entirely fills the figure.
Note: There may 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'
'on' or
'off' (default)
If 'ImshowAxesVisible' is 'on', imshow displays the image with the axes box and tick labels. If 'ImshowAxesVisible' is 'off', imshow displays the image without the axes box and tick labels.

'ImshowTruesize'
'auto' (default) or 'manual'
If 'ImshowTruesize' is 'manual', imshow does not call truesize. If 'ImshowTruesize' is 'auto', imshow automatically decides whether to call truesize. (imshow calls truesize if there will be no other objects in the resulting figure besides the image and its axes.) You can override this setting for an individual display by specifying the display_option argument to imshow, or you can call truesize manually after displaying the image.

'TruesizeWarning'
'on' (default) or
'off'
If 'TruesizeWarning' is 'on', the truesize function displays a warning if the image is too large to fit on the screen. (The entire image is still displayed, but at less than true size.) If 'TruesizeWarning' is 'off', truesize does not display the warning.
Note: This preference applies even when you call truesize indirectly, such as through imshow.

Preference Name	Values	Description
`'ImshowBorder'`	`'loose'` (default) or `'tight'`	If `'ImshowBorder'` is `'loose'`, `imshow` displays the image with a border between the image and the edges of the figure window, thus leaving room for axes labels, titles, etc. If `'ImshowBorder'` is `'tight'`, `imshow` adjusts the figure size so that the image entirely fills the figure. Note: There may 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'`	`'on'` or `'off'` (default)	If `'ImshowAxesVisible'` is `'on'`, `imshow` displays the image with the axes box and tick labels. If `'ImshowAxesVisible'` is `'off'`, `imshow` displays the image without the axes box and tick labels.
`'ImshowTruesize'`	`'auto'` (default) or `'manual'`	If `'ImshowTruesize'` is `'manual'`, `imshow` does not call `truesize`. If `'ImshowTruesize'` is `'auto'`, `imshow` automatically decides whether to call `truesize`. (`imshow` calls `truesize` if there will be no other objects in the resulting figure besides the image and its axes.) You can override this setting for an individual display by specifying the `display_option` argument to `imshow`, or you can call `truesize` manually after displaying the image.
`'TruesizeWarning'`	`'on'` (default) or `'off'`	If `'TruesizeWarning'` is `'on'`, the `truesize` function displays a warning if the image is too large to fit on the screen. (The entire image is still displayed, but at less than true size.) If `'TruesizeWarning'` is `'off'`, `truesize` does not display the warning. Note: This preference applies even when you call `truesize` indirectly, such as through `imshow`.

Example

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

See Also

imshow, iptgetpref, truesize

axis in the MATLAB Function Reference

iptgetpref iradon