mibImageFiltersController Class Reference

class is a template class for using with GUI developed using appdesigner of Matlab More...

Inheritance diagram for mibImageFiltersController:

Collaboration diagram for mibImageFiltersController:

Public Member Functions
	mibImageFiltersController (mibModel, varargin)
	get version of Matlab, important because not all widgets are available in R2019a and older
function	closeWindow ()
	closing mibImageFiltersController window
function	updateWidgets ()
	update widgets of this window
function	returnBatchOpt (BatchOptOut)
	return structure with Batch Options and possible configurations via the notify syncBatch event Parameters: BatchOptOut: a local structure with Batch Options generated during Continue callback. It may contain more fields than obj.BatchOpt structure
function	FilterGroupValueChanged (event)
	update gui upon press of FilterGroup dropout
function	scrollWheel_Callback (event)
	verticalScrollAmount = event.VerticalScrollAmount;
function	updateImageFiltersParameters (hWidget, event)
	update obj.ImageFilters structure with parameters of filters
function	FilterNameValueChanged (event)
	update gui upon press of FilterName dropdown
function	helpButton_Callback ()
function	Mode3DValueChanged ()
	callback for Mode3D press
function	renderThumbnailPreview ()
	render an image for the thumbnail preview if ismember(obj.BatchOpt.FilterName{1}, {DNNdenoise,FastLocalLaplacian,FlatfieldCorrection, LocalBrighten, ReduceHaze, UnsharpMask}); return; end % do not render preview for these filters
function	PreviewButtonPushed ()
	generate filter preview for the currenly shown area

Static Public Member Functions
static function	ViewListner_Callback (obj, src, evnt)

Public Attributes
	mibModel
	handles to mibModel
	View
	handle to the view / mibImageFiltersGUI
	listener
	a cell array with handles to listeners
	BasicFiltersList
	cell array with available basic filters % {Average, Disk};
	EdgePreservingFiltersList
	cell array with available edge preserving filters % {Bilateral, Anisotropic diffusion, '};
	ContrastFiltersList
	cell array with available contrast adjustment filters
	BinarizationFiltersList
	cell array with available binarization filters
	ImageFilters
	a structure with parameters for the filter, taken from obj.mibModel.sessionSettings.ImageFilters
	Filters3D
	list of 3D compatible filters
	MatlabR2019b
	a logical switch indicating matlab version R2019b or newer
	ParaHandles
	a cell array with handles to the parameters widgets
	BatchOpt
	a structure compatible with batch operation name of each field should be displayed in a tooltip of GUI it is recommended that the Tags of widgets match the name of the fields in this structure .Parameter - [editbox], char/string .Checkbox - [checkbox], logical value true or false .Dropdown{1} - [dropdown], cell string for the dropdown .Dropdown{2} - [optional], an array with possible options .Radio - [radiobuttons], cell string Radio1 or Radio2... .ParameterNumeric{1} - [numeric editbox], cell with a number .ParameterNumeric{2} - [optional], vector with limits [min, max] .ParameterNumeric{3} - [optional], string on - to round the value, off to do not round the value
EVENT	closeEvent
	> Description of events event firing when window is closed
Public Attributes inherited from handle
	addlistener
	Creates a listener for the specified event and assigns a callback function to execute when the event occurs.
	notify
	Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects.
	delete
	Handle object destructor method that is called when the object's lifecycle ends.
	disp
	Handle object disp method which is called by the display method. See the MATLAB disp function.
	display
	Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function.
	findobj
	Finds objects matching the specified conditions from the input array of handle objects.
	findprop
	Returns a meta.property objects associated with the specified property name.
	fields
	Returns a cell array of string containing the names of public properties.
	fieldnames
	Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function.
	isvalid
	Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass.
	eq
	Relational functions example. See details for more information.
	transpose
	Transposes the elements of the handle object array.
	permute
	Rearranges the dimensions of the handle object array. See the MATLAB permute function.
	reshape
	hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function.
	sort
	ort the handle objects in any array in ascending or descending order.

Detailed Description

class is a template class for using with GUI developed using appdesigner of Matlab

obj.startController('mibImageFiltersController'); // as GUI tool

or

// a code below was used for mibImageArithmeticController
BatchOpt.Parameter = 'test';  // fill edit boxes as strings
BatchOpt.Checkbox = true;     // fill checkboxes with logicals: true/false
BatchOpt.Popup = {'value'};        // value for the popups as a cell
BatchOpt.Radio = {'Radio1'};          // selection of radio buttons, as cell with the handle of the target radio button
BatchOpt.showWaitbar = true;  // show or not the waitbar
obj.startController('mibImageFiltersController', [], BatchOpt); // start mibImageFiltersController in the batch mode

or

// trigger return of the possible Options using returnBatchOpt function
// using notify syncBatch event
obj.startController('mibImageFiltersController', [], NaN);

Constructor & Destructor Documentation

mibImageFiltersController()

mibImageFiltersController.mibImageFiltersController	(		mibModel,
			varargin )

get version of Matlab, important because not all widgets are available in R2019a and older

References handle.addlistener, mibModel, mibUpdateFontSize(), moveWindowOutside(), handle.notify, updateBatchOptCombineFields_Shared(), and updateGUIFromBatchOpt_Shared().

Here is the call graph for this function:

Member Function Documentation

closeWindow()

function mibImageFiltersController.closeWindow

(

)

closing mibImageFiltersController window

References handle.isvalid, and handle.notify.

FilterGroupValueChanged()

function mibImageFiltersController.FilterGroupValueChanged

(

event

)

update gui upon press of FilterGroup dropout

Required fields of event:

FilterNameValueChanged()

function mibImageFiltersController.FilterNameValueChanged

(

event

)

update gui upon press of FilterName dropdown

Required fields of event:

References handle.fieldnames.

helpButton_Callback()

function mibImageFiltersController.helpButton_Callback

(

)

Mode3DValueChanged()

function mibImageFiltersController.Mode3DValueChanged

(

)

callback for Mode3D press

References updateBatchOptFromGUI_Shared().

Here is the call graph for this function:

PreviewButtonPushed()

function mibImageFiltersController.PreviewButtonPushed

(

)

generate filter preview for the currenly shown area

References max, min, and handle.notify.

renderThumbnailPreview()

function mibImageFiltersController.renderThumbnailPreview

(

)

render an image for the thumbnail preview if ismember(obj.BatchOpt.FilterName{1}, {DNNdenoise,FastLocalLaplacian,FlatfieldCorrection, LocalBrighten, ReduceHaze, UnsharpMask}); return; end % do not render preview for these filters

returnBatchOpt()

function mibImageFiltersController.returnBatchOpt

(

BatchOptOut

)

return structure with Batch Options and possible configurations via the notify syncBatch event Parameters: BatchOptOut: a local structure with Batch Options generated during Continue callback. It may contain more fields than obj.BatchOpt structure

Required fields of BatchOptOut:

References handle.fieldnames, and handle.notify.

scrollWheel_Callback()

function mibImageFiltersController.scrollWheel_Callback

(

event

)

verticalScrollAmount = event.VerticalScrollAmount;

Required fields of event:

References max, and min.

updateImageFiltersParameters()

function mibImageFiltersController.updateImageFiltersParameters	(		hWidget,
			event )

update obj.ImageFilters structure with parameters of filters

References updateBatchOptFromGUI_Shared().

Here is the call graph for this function:

updateWidgets()

function mibImageFiltersController.updateWidgets

(

)

update widgets of this window

References updateBatchOptFromGUI_Shared(), and updateGUIFromBatchOpt_Shared().

Here is the call graph for this function:

ViewListner_Callback()

static function mibImageFiltersController.ViewListner_Callback ( obj, src, evnt )

static

Member Data Documentation

BasicFiltersList

mibImageFiltersController.BasicFiltersList

cell array with available basic filters % {Average, Disk};

BatchOpt

mibImageFiltersController.BatchOpt

a structure compatible with batch operation name of each field should be displayed in a tooltip of GUI it is recommended that the Tags of widgets match the name of the fields in this structure .Parameter - [editbox], char/string .Checkbox - [checkbox], logical value true or false .Dropdown{1} - [dropdown], cell string for the dropdown .Dropdown{2} - [optional], an array with possible options .Radio - [radiobuttons], cell string Radio1 or Radio2... .ParameterNumeric{1} - [numeric editbox], cell with a number .ParameterNumeric{2} - [optional], vector with limits [min, max] .ParameterNumeric{3} - [optional], string on - to round the value, off to do not round the value

BinarizationFiltersList

mibImageFiltersController.BinarizationFiltersList

cell array with available binarization filters

closeEvent

EVENT mibImageFiltersController.closeEvent

> Description of events event firing when window is closed

Events

closeEvent

ContrastFiltersList

mibImageFiltersController.ContrastFiltersList

cell array with available contrast adjustment filters

EdgePreservingFiltersList

mibImageFiltersController.EdgePreservingFiltersList

cell array with available edge preserving filters % {Bilateral, Anisotropic diffusion, '};

Filters3D

mibImageFiltersController.Filters3D

list of 3D compatible filters

ImageFilters

mibImageFiltersController.ImageFilters

a structure with parameters for the filter, taken from obj.mibModel.sessionSettings.ImageFilters

listener

mibImageFiltersController.listener

a cell array with handles to listeners

MatlabR2019b

mibImageFiltersController.MatlabR2019b

a logical switch indicating matlab version R2019b or newer

mibModel

mibImageFiltersController.mibModel

handles to mibModel

Referenced by mibImageFiltersController().

ParaHandles

mibImageFiltersController.ParaHandles

a cell array with handles to the parameters widgets

View

mibImageFiltersController.View

handle to the view / mibImageFiltersGUI

---

The documentation for this class was generated from the following file:

• Classes/@mibImageFiltersController/mibImageFiltersController.m