mni.util

Classes

mni.util.textprogressbar

class mni.util.textprogressbar

Bases: handle

TEXTPROGRESSBAR Summary of this class goes here Detailed explanation goes here

Constructor Summary

textprogressbar(info_str, log_fcn)

Property Summary

LogFcn

info_str

str_current

Method Summary

close(): obj.LogFcn(’n’,false,true);

update(c)

Functions

mni.util.get_version

mni.util.get_version()

mni.util.gif

mni.util.gif(varargin)

gif is the simplest way to make gifs. Simply call

gif(‘myfile.gif’)

to write the first frame, and then call

gif

to write each subsequent frame. That’s it.

Syntax

gif(‘filename.gif’) gif(…,’DelayTime’,DelayTimeValue,…) gif(…,’LoopCount’,LoopCountValue,…) gif(…,’frame’,handle,…) gif(…,’resolution’,res) gif(…,’nodither’) gif(…,’overwrite’,true) gif gif(‘clear’)

Description

gif(‘filename.gif’) writes the first frame of a new gif file by the name filename.gif.

gif(…,’DelayTime’,DelayTimeValue,…) specifies a the delay time in seconds between frames. Default delay time is 1/15.

gif(…,’LoopCount’,LoopCountValue,…) specifies the number of times the gif animation will play. Default loop count is Inf.

gif(…,’frame’,handle,…) uses the frame of the given figure or set of axes. The default frame handle is gcf, meaning the current figure. To turn just one set of axes into a gif, use ‘frame’,gca. This behavior changed in Jan 2021, as the default option changed from gca to gcf.

gif(…,’resolution’,res) specifies the resolution (in dpi) of each frame. This option requires export_fig (https://www.mathworks.com/matlabcentral/fileexchange/23629).

gif(…,’nodither’) maps each color in the original image to the closest color in the new without dithering. Dithering is performed by default to achieve better color resolution, albeit at the expense of spatial resolution.

gif(…,’overwrite’,true) bypasses a dialoge box that would otherwise verify that you want to overwrite an existing file by the specified name.

gif adds a frame to the current gif file.

gif(‘clear’) clears the persistent variables associated with the most recent gif.

Example For examples, type

cdt gif

Author Information This function was written by Chad A. Greene of the University of Texas Institute for Geophysics (UTIG), June 2017.

See also: imwrite, getframe, and rgb2ind. Define persistent variables:

mni.util.logger

mni.util.logger(str, bNewLine, bLiteral)

logger Presents the import display to the user by printing to the command window

Syntax:

Print a string to the command window and do not go to a new line:

>> logger(‘Hello World’);%

Print a string to the command window and add EOL
>> logger(‘Hello World’, true);

Print a string to the command window and allow escape characters
>> logger(‘This is an EOL character: n’, true, false);

Detailed Description: