![]() |
Microscopy Image Browser 2.91
MIB
|
class is a template class for using with GUI developed using appdesigner of Matlab More...
Public Member Functions | |
mibVolRenAppController (mibModel, varargin) | |
class constructor | |
function | updateVolumeRenderingStyle () |
update Volume Rendering Style | |
function | updateIsovalue (newIsovalue) |
update IsosurfaceValue of the volume | |
function | alphaAxesButtonDown (event) |
buttom down event above obj.View.handles.alphaAxes | |
function | updateBackgroundColor (event) |
update background color settings | |
function | updateColormap (event) |
select and update colormap | |
function | generateColorMap () |
generate obj.volumeColormap from the selected obj.Settings.Volume.colormapName and obj.Settings.Volume.colormapInvert | |
function | updateCameraWidgets () |
update widgets that describe position of the camera | |
function | menuChangeView (event) |
callback for selection of views | |
function | closeWindow () |
closing mibVolRenAppController window | |
function | updateWidgets () |
update widgets of this window | |
function | updateKeyFrameTable () |
update obj.View.handles.keyFrameTable | |
function | addAnimationKeyFrame (posIndex) |
add/insert a key frame | |
function | keyFrameTable_CellSelection (indices) |
callback for selection of a cell in obj.View.handles.keyFrameTable | |
function | surfaceTable_CellSelection (indices) |
callback for selection of a cell in obj.View.handles.surfaceTable | |
function | modelTable_CellSelection (indices) |
callback for selection of a cell in obj.View.handles.modelTable | |
function | loadAnimationPath () |
load animation path from a file | |
function | saveAnimationPath () |
save animation path to a file | |
function | deleteAllAnimationKeyFrames () |
delete all key frames | |
function | previewAnimation (noFrames) |
preview animation | |
function positions = | generatePositionsForKeyFramesAnimation (noFrames, options) |
generate camera positions from the key frames | |
function | updateAnimationNumberOfFrames (noFrames) |
update number of frames in the animation | |
function | modelTable_cm_Callback (event) |
callback for modelTable context menu | |
function | surfaceTable_cm_Callback (event) |
callback for surfaceTable context menu | |
function | keyFrameTable_cm_Callback (event) |
callback for keyFrameTable context menu | |
function | alphaCurveOperations (event) |
callback for press of buttons in the alpha curve tab | |
function | plotAlphaPlot () |
draw alpha plot | |
function | toggleViewerSettings (event) |
toggle switch on/off for some of the viewer parameters | |
function | updateScalingTransform (pixSize) |
generate tform (obj.scalingTransform) to scale the dataset upon loading to have its units in um | |
function imgOut = | grabFrame (width, height, options) |
grab a frame from the volume viewer | |
function | prepareWindowForGrabFrame (width, height) |
prepare window to grab a frame | |
function | restoreWindowAfterGrabFrame () |
restore widget sizes after the snapshot | |
function | makeAnimation (mode) |
start making movie window | |
function status = | grabVolume (volumeType, colorChannel) |
grab the currently displayed volume to the 3D volume viewer | |
function | recalculateAlphamap (transparentVolume) |
recalculate obj.volume.Alphamap | |
function | spinDataset () |
spin dataset (rotate camera around the dataset) | |
function positions = | generatePositionsForSpinAnimation (noFrames, options) |
generate camera positions for the spin animation | |
function | makeSnapshop () |
make snapshot | |
function | modelUpdateOverlay (overlayType, materialId) |
grab the model from MIB and assign it as an overlay for the volume | |
function | updateOverlayRenderingStyle () |
update rendering style for overlays | |
function | updateSurfaceTable () |
update obj.View.handles.surfaceTable | |
function | modelHideAllMaterials (hideMaterialsSwitch) |
hide all materials of the shown model | |
function | updateModelTable () |
update obj.View.handles.modelTable after loading of the model | |
function | surfaceTableCellEdit (event) |
callback for update of values in obj.View.handles.modelTable | |
function | modelTableCellEdit (event) |
callback for update of values in obj.View.handles.modelTable | |
function | updateCameraPosition (event) |
function | changeSlice (sourceWidget, value) |
callback for change of the slice value on obj.View.handles.xSliderEdit / ySliderEdit / zSliderEdit | |
function | showVolume (showSwitch) |
toggle showing of the volume | |
function | transparentVolume (transparentSwitch) |
make volume transparent, which still shows the overlay model | |
function | showHelp () |
show help | |
Static Public Member Functions | |
static function | ViewListner_Callback (obj, src, evnt) |
static function | cameraListner_Callback (obj, src, evnt) |
listener callback for camera moving | |
Public Attributes | |
mibModel | |
handles to mibModel | |
View | |
handle to the view / mibVolRenAppGUI | |
listener | |
a cell array with handles to listeners | |
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 | |
childControllers | |
list of opened subcontrollers | |
childControllersIds | |
a cell array with names of initialized child controllers | |
alphaPlotHandle | |
handle to the alpha plot | |
animationFilename | |
template for the animation filename | |
animationPath | |
a structure with animation path .CameraPosition - a matrix of camera positions [keyFrame, x,y,z] .CameraUpVector - a matrix of camera up vectors [keyFrame, x,y,z] .CameraTarget - a matrix of camera target positions [keyFrame, x,y,z] | |
animationPreviewRunning | |
logical switch defining whether the animation is previewed | |
defaultView | |
a structure with the default camera position | |
figPosStored | |
a structure with stored positions of the widgets for making snapshots .mibVolRenAppFigure -> position of the main figure .mainGridLayoutRowHeights -> heights of rows in obj.View.handles.mainGridLayout | |
keyFrameTableIndex | |
index of the selected key frame | |
matlabVersion | |
current version of MATLAB | |
maxIntValue | |
max integer value of the loaded volume | |
noOverlayMaterials | |
number of materials shown in the overlay | |
overlayShownMaterials | |
a vector of shown (true) or hidden (false) materials in the model overlay | |
overlayAlpha | |
a vector with alpha values for overlay materials | |
modelTableIndex | |
index of the selected material in the modelTable | |
scalingTransform | |
tform to scale the dataset upon loading to have its units in um | |
Settings | |
a structure with settings, initialized from obj.mibModel.preferences.VolRen; .volumeAlphaCurve.x = [0 .3 .7 1]; .volumeAlphaCurve.y = [1 1 0 0]; .markerSize - marker size for the alpha plot .BackgroundColor - color for the background .colormapName - a string with default colormap, or custom (not yet implemented) .colormapInvert - true/false, invert or not the colormap .animationPath - a structure with animation path .noFramesPreview - number of frames for the preview | |
surfList | |
a cell array of generated surfaces | |
surfListAlpha | |
an array of alpha values for the generated surfaces | |
surfaceTableIndex | |
index of the selected row in the surfaceTable | |
viewer | |
handle to the main viewer widget | |
volume | |
main image volume | |
volumeAlphaCurve | |
a structure with alpha curve details .x - vector of intensity points [0 - 1] .y - value of alpha for each intensity point [0 - 1] .alphamap - calculated alpha map used in volshow .activePoint - selected point | |
volumeColormap | |
vector with the colormap | |
volumeScaleFactor | |
scale factor to downsample the datasets, below 1 | |
EVENT | closeEvent |
> Description of events event firing when window is closed | |
![]() | |
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. | |
class is a template class for using with GUI developed using appdesigner of Matlab
or
or
mibVolRenAppController.mibVolRenAppController | ( | mibModel, | |
varargin ) |
class constructor
mibModel | a handle to mibModel class |
varargin | mibVolRenAppController ( ..., options )
mibVolRenAppController(mibModel, varargin) class constructor Definition mibVolRenAppController.m:318
|
References handle.addlistener, handle.fieldnames, mibModel, mibUpdateFontSize(), and moveWindowOutside().
function mibVolRenAppController.addAnimationKeyFrame | ( | posIndex | ) |
add/insert a key frame
posIndex | [optional] position of the key frame, when 1 - in the beginning of the animation sequence |
function mibVolRenAppController.alphaAxesButtonDown | ( | event | ) |
buttom down event above obj.View.handles.alphaAxes
References max, min, and handle.sort.
function mibVolRenAppController.alphaCurveOperations | ( | event | ) |
callback for press of buttons in the alpha curve tab
event | a handle of the pressed button .event.Source.Tag -> resetAlphaCurve .event.Source.Tag -> invertAlphaCurve |
References handle.sort.
|
static |
listener callback for camera moving
function mibVolRenAppController.changeSlice | ( | sourceWidget, | |
value ) |
callback for change of the slice value on obj.View.handles.xSliderEdit / ySliderEdit / zSliderEdit
sourceWidget | tag (str) of the widgets that was modified, xSliderEdit , ySliderEdit , zSliderEdit |
value | new value |
function mibVolRenAppController.closeWindow | ( | ) |
closing mibVolRenAppController window
References handle.isvalid, and handle.notify.
function mibVolRenAppController.deleteAllAnimationKeyFrames | ( | ) |
delete all key frames
function mibVolRenAppController.generateColorMap | ( | ) |
generate obj.volumeColormap from the selected obj.Settings.Volume.colormapName and obj.Settings.Volume.colormapInvert
function positions = mibVolRenAppController.generatePositionsForKeyFramesAnimation | ( | noFrames, | |
options ) |
generate camera positions from the key frames
noFrames | number of frames options - an optional structure with additional parameters .back_and_forth - a switch to make animations in both forward and reverse orientation |
positions | a structure with camera positions for each frame of the resulting movie .CameraUpVector - an array of camera-up vectors for each time point or a single vector .CameraTarget - an array of camera-target vectors for each time point or a single vector .CameraPosition - a vector for each time point |
function positions = mibVolRenAppController.generatePositionsForSpinAnimation | ( | noFrames, | |
options ) |
generate camera positions for the spin animation
noFrames | number of frames |
options | a structure with optional parameters .back_and_forth - a switch to make animations in both forward and reverse orientation .clockwise - a switch 1 - clockwise, 0 - anticlockwise rotation .rotAxis - a number with rotation axis, 3-z , 1-x , 2-y Return values: |
positions | a structure with camera positions for each frame .CameraUpVector - an array of camera-up vectors for each time point or a single vector .CameraTarget - an array of camera-target vectors for each time point or a single vector .CameraPosition - a vector for each time point |
function imgOut = mibVolRenAppController.grabFrame | ( | width, | |
height, | |||
options ) |
grab a frame from the volume viewer
Parameters width: width of the snapshot, can be empty height: height of the snapshot, can be empty options: [optional] structure with extra parameters .resizeWindow - a switch, 1-resize window, 0-do not resize window, used for animations .showWaitbar - show or not waitbar .hWaitbar - a handle to existing waitbar .waitbarProgress - a fraction for the waitbar position
Examples:
function status = mibVolRenAppController.grabVolume | ( | volumeType, | |
colorChannel ) |
grab the currently displayed volume to the 3D volume viewer
volumeType | [default: image ] string with type of the volume to grab: image ,model , selection , mask |
colorChannel | [default: 1] index of the color channel or material to grab Return values: |
status | 1 - success, 0 - cancel |
References max, mibInputMultiDlg(), mibResize3d(), and handle.permute.
function mibVolRenAppController.keyFrameTable_CellSelection | ( | indices | ) |
callback for selection of a cell in obj.View.handles.keyFrameTable
function mibVolRenAppController.keyFrameTable_cm_Callback | ( | event | ) |
callback for keyFrameTable context menu
event | a handle of the pressed button .event.Source.Tag -> keyFrameTable_cm_jumpToKeyFrame , jump to the selected key frame and update the view .event.Source.Tag -> keyFrameTable_cm_insertKeyFrame , insert a key frame to the current position .event.Source.Tag -> keyFrameTable_cm_replaceKeyFrame , replace the selected key frame .event.Source.Tag -> keyFrameTable_cm_removeKeyFrame , remove the key frame from the current position; |
function mibVolRenAppController.loadAnimationPath | ( | ) |
load animation path from a file
References mib_uigetfile().
function mibVolRenAppController.makeAnimation | ( | mode | ) |
start making movie window
Parameters mode: a string with the desired animation type, spin
- to spin around selected axis animation
- to animate the scene using key frames
function mibVolRenAppController.makeSnapshop | ( | ) |
make snapshot
function mibVolRenAppController.menuChangeView | ( | event | ) |
callback for selection of views
event | a handle to the selected widget event.Source.Tag = menuDefaultView -> show the default view event.Source.Tag = menuXYview -> show the XY view event.Source.Tag = menuXZview -> show the XZ view event.Source.Tag = menuYZview -> show the YZ view |
function mibVolRenAppController.modelHideAllMaterials | ( | hideMaterialsSwitch | ) |
hide all materials of the shown model
value | [logical, optional], switch to hide (true) or show materials (false) |
function mibVolRenAppController.modelTable_CellSelection | ( | indices | ) |
callback for selection of a cell in obj.View.handles.modelTable
function mibVolRenAppController.modelTable_cm_Callback | ( | event | ) |
callback for modelTable context menu
event | a handle of the pressed button .event.Source.Tag -> modelTable_cm_generateSurface , generate surface from the selected material |
function mibVolRenAppController.modelTableCellEdit | ( | event | ) |
callback for update of values in obj.View.handles.modelTable
function mibVolRenAppController.modelUpdateOverlay | ( | overlayType, | |
materialId ) |
grab the model from MIB and assign it as an overlay for the volume
overlayType | string, type of the overlay to show,
|
materialId | index of material of the model, use NaN to get all materials |
References mibResize3d().
function mibVolRenAppController.plotAlphaPlot | ( | ) |
draw alpha plot
function mibVolRenAppController.prepareWindowForGrabFrame | ( | width, | |
height ) |
prepare window to grab a frame
Examples:
function mibVolRenAppController.previewAnimation | ( | noFrames | ) |
preview animation
function mibVolRenAppController.recalculateAlphamap | ( | transparentVolume | ) |
recalculate obj.volume.Alphamap
transparentVolume | [default false] when true, make the volume transparent |
References transparentVolume().
function mibVolRenAppController.restoreWindowAfterGrabFrame | ( | ) |
restore widget sizes after the snapshot
function mibVolRenAppController.saveAnimationPath | ( | ) |
save animation path to a file
function mibVolRenAppController.showHelp | ( | ) |
show help
function mibVolRenAppController.showVolume | ( | showSwitch | ) |
toggle showing of the volume
function mibVolRenAppController.spinDataset | ( | ) |
spin dataset (rotate camera around the dataset)
function mibVolRenAppController.surfaceTable_CellSelection | ( | indices | ) |
callback for selection of a cell in obj.View.handles.surfaceTable
function mibVolRenAppController.surfaceTable_cm_Callback | ( | event | ) |
callback for surfaceTable context menu
event | a handle of the pressed button .event.Source.Tag -> surfaceTable_cm_saveSurface , save surface to a file in STL format .event.Source.Tag -> surfaceTable_cm_removeSurface , delete surface from the viewer |
References stlwrite().
function mibVolRenAppController.surfaceTableCellEdit | ( | event | ) |
callback for update of values in obj.View.handles.modelTable
function mibVolRenAppController.toggleViewerSettings | ( | event | ) |
toggle switch on/off for some of the viewer parameters
function mibVolRenAppController.transparentVolume | ( | transparentSwitch | ) |
make volume transparent, which still shows the overlay model
References transparentVolume().
Referenced by recalculateAlphamap(), and transparentVolume().
function mibVolRenAppController.updateAnimationNumberOfFrames | ( | noFrames | ) |
update number of frames in the animation
function mibVolRenAppController.updateBackgroundColor | ( | event | ) |
update background color settings
event | a structure event generated upon selection of the operation to perform |
function mibVolRenAppController.updateCameraPosition | ( | event | ) |
References handle.isvalid.
function mibVolRenAppController.updateCameraWidgets | ( | ) |
update widgets that describe position of the camera
References handle.isvalid.
function mibVolRenAppController.updateColormap | ( | event | ) |
select and update colormap
function mibVolRenAppController.updateIsovalue | ( | newIsovalue | ) |
update IsosurfaceValue of the volume
function mibVolRenAppController.updateKeyFrameTable | ( | ) |
update obj.View.handles.keyFrameTable
function mibVolRenAppController.updateModelTable | ( | ) |
update obj.View.handles.modelTable after loading of the model
function mibVolRenAppController.updateOverlayRenderingStyle | ( | ) |
update rendering style for overlays
function mibVolRenAppController.updateScalingTransform | ( | pixSize | ) |
generate tform (obj.scalingTransform) to scale the dataset upon loading to have its units in um
function mibVolRenAppController.updateSurfaceTable | ( | ) |
update obj.View.handles.surfaceTable
function mibVolRenAppController.updateVolumeRenderingStyle | ( | ) |
update Volume Rendering Style
style | string with new rendering style: VolumeRendering, MaximumIntensityProjection, MinimumIntensityProjection, GradientOpacity, Isosurface, SlicePlanes |
function mibVolRenAppController.updateWidgets | ( | ) |
update widgets of this window
|
static |
References max.
mibVolRenAppController.alphaPlotHandle |
handle to the alpha plot
mibVolRenAppController.animationFilename |
template for the animation filename
mibVolRenAppController.animationPath |
a structure with animation path .CameraPosition - a matrix of camera positions [keyFrame, x,y,z] .CameraUpVector - a matrix of camera up vectors [keyFrame, x,y,z] .CameraTarget - a matrix of camera target positions [keyFrame, x,y,z]
mibVolRenAppController.animationPreviewRunning |
logical switch defining whether the animation is previewed
mibVolRenAppController.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
mibVolRenAppController.childControllers |
list of opened subcontrollers
mibVolRenAppController.childControllersIds |
a cell array with names of initialized child controllers
EVENT mibVolRenAppController.closeEvent |
> Description of events event firing when window is closed
mibVolRenAppController.defaultView |
a structure with the default camera position
mibVolRenAppController.figPosStored |
a structure with stored positions of the widgets for making snapshots .mibVolRenAppFigure -> position of the main figure .mainGridLayoutRowHeights -> heights of rows in obj.View.handles.mainGridLayout
mibVolRenAppController.keyFrameTableIndex |
index of the selected key frame
mibVolRenAppController.listener |
a cell array with handles to listeners
mibVolRenAppController.matlabVersion |
current version of MATLAB
mibVolRenAppController.maxIntValue |
max integer value of the loaded volume
mibVolRenAppController.mibModel |
handles to mibModel
Referenced by mibVolRenAppController().
mibVolRenAppController.modelTableIndex |
index of the selected material in the modelTable
mibVolRenAppController.noOverlayMaterials |
number of materials shown in the overlay
mibVolRenAppController.overlayAlpha |
a vector with alpha values for overlay materials
mibVolRenAppController.overlayShownMaterials |
a vector of shown (true) or hidden (false) materials in the model overlay
mibVolRenAppController.scalingTransform |
tform to scale the dataset upon loading to have its units in um
mibVolRenAppController.Settings |
a structure with settings, initialized from obj.mibModel.preferences.VolRen; .volumeAlphaCurve.x = [0 .3 .7 1]; .volumeAlphaCurve.y = [1 1 0 0]; .markerSize - marker size for the alpha plot .BackgroundColor - color for the background .colormapName - a string with default colormap, or custom
(not yet implemented) .colormapInvert - true/false, invert or not the colormap .animationPath - a structure with animation path .noFramesPreview - number of frames for the preview
mibVolRenAppController.surfaceTableIndex |
index of the selected row in the surfaceTable
mibVolRenAppController.surfList |
a cell array of generated surfaces
mibVolRenAppController.surfListAlpha |
an array of alpha values for the generated surfaces
mibVolRenAppController.View |
handle to the view / mibVolRenAppGUI
mibVolRenAppController.viewer |
handle to the main viewer widget
mibVolRenAppController.volume |
main image volume
mibVolRenAppController.volumeAlphaCurve |
a structure with alpha curve details .x - vector of intensity points [0 - 1] .y - value of alpha for each intensity point [0 - 1] .alphamap - calculated alpha map used in volshow .activePoint - selected point
mibVolRenAppController.volumeColormap |
vector with the colormap
mibVolRenAppController.volumeScaleFactor |
scale factor to downsample the datasets, below 1