PAView serves as Padaco's view component. In the model, view, controller paradigm, this is the view. More...

Inheritance diagram for PAView:

Public Member Functions
function	PAView (in Padaco_fig_h, in lineContextmenuHandle, in primaryAxesContextmenuHandle, in featureLineContextmenuHandle, in secondaryAxesContextmenuHandle)

function	createView (in obj)
	Creates line handles and maps figure tags to PAView instance variables. More...

function	setViewMode (in obj, in viewMode)
	Sets padaco's view mode to either time series or results viewing. More...

function	getWindowDurSec (in obj)
	Retrieves the window duration drop down menu's current value as a number. More...

function	setWindowDurSecMenu (in obj, in windowDurSec)
	Sets the window duration drop down menu's current value based on the input parameter (as seconds). If the duration in seconds is not found, then the value is appended to the drop down menu prior to being set. More...

function	getCurWindow (in obj)
	Retrieves the current window's edit box string value as a number. More...

function	setCurWindow (in obj, in windowStr, in xposStart, in xposEnd)
	Sets current window edit box string value. More...

function	setAggregateDurationMinutes (in obj, in aggregateDurationStr)
	Sets aggregate duration edit box string value. More...

function	getAggregateDurationMinutes (in obj)
	Retrieves the aggregate duration edit box value as a number. More...

function	setFrameDurationMinutes (in obj, in frameDurationMinutesStr)
	Sets frame duration edit box (minutes) string value. More...

function	setFrameDurationHours (in obj, in frameDurationHoursStr)
	Sets frame duration edit box (hours) string value. More...

function	setUseSmoothing (in obj, in smoothingState)
	Sets line smoothing state for feature vectors displayed on the secondary axes. More...

function	getUseSmoothing (in obj)

function	setDisplayType (in obj, in displayTypeStr, in visibleProps)
	Sets display type instance variable. More...

function	getDisplayType (in obj)
	Returns the display type instance variable. More...

function	getFrameDurationMinutes (in obj)
	Retrieves the frame duration edit box value (minutes) as a number. More...

function	getFrameDurationHours (in obj)
	Retrieves the frame duration hours edit box value ) as a number. More...

function	clearFigure (in obj)
	Clears the main figure's handles (deletes all children handles). More...

function	clearTextHandles (in obj)
	Initialize text handles that will be used in the view. resets the currentWindow to 1. More...

function	initAxesHandlesViewMode (in obj, in viewMode)
	Clears axes handles of any children and sets default properties. Called when first creating a view. See also initAxesHandles. More...

function	clearAxesHandles (in obj)
	Clears axes handles of any children and sets default properties. Called when first creating a view. See also initAxesHandles. More...

function	clearWidgets (in obj)
	Clear text ('string') of view's user interface widgets. More...

function	disableWidgets (in obj)
	Disable user interface widgets. More...

function	initAxesHandles (in obj, in axesProps)
	Initialize data specific properties of the axes handles. Set the x and y limits of the axes based on limits found in dataStruct struct. More...

function	initWidgets (in obj, in viewMode, in disableFlag)
	Initialize user interface widgets on start up. More...

function	initWithAccelData (in obj, in PADataObject)
	Initializes the graphic handles (label and line handles) and maps figure tag names to PAView instance variables. Initializes the menubar and various widgets. Also set the acceleration data instance variable and assigns line handle y values to those found with corresponding field names in PADataObject. More...

function	updatePrimaryAxes (in obj, in axesRange)
	Updates the secondary axes x and y axes limits. More...

function	addFeaturesVecAndOverlayToSecondaryAxes (in obj, in featureVector, in startStopDatenum, in overlayHeight, in overlayOffset)
	Adds a feature vector as a heatmap and as a line plot to the secondary axes. More...

function	addFeaturesVecToSecondaryAxes (in obj, in featureVector, in startStopDatenum, in overlayHeight, in overlayOffset)
	Plots a feature vector on the secondary axes. More...

function	addOverlayToSecondaryAxes (in obj, in overlayVector, in startStopDatenum, in overlayHeight, in overlayOffset, in maxValue)
	Adds a magnitude vector as a heatmap to the secondary axes. More...

function	addLumensOverlayToSecondaryAxes (in obj, in lumenVector, in startStopDatenum)
	Adds an overlay of the lumens signal to the secondary axes. More...

function	updateSecondaryAxes (in obj, in startStopDatenum)
	Updates the secondary axes x and y axes limits. More...

function	createLineAndLabelHandles (in obj, in PADataObject)
	Create the line handles and text handles that describe the lines, that will be displayed by the view. This is based on the structure template generated by member function getStruct('dummydisplay'). More...

function	enableAggregateRadioButton (in obj, in enableState)
	Enables the aggregate radio button. More...

function	enableFeatureRadioButton (in obj, in enableState)
	Enables the Feature radio button. More...

function	enableTimeSeriesRadioButton (in obj, in enableState)
	Enables the time series radio button. More...

function	appendFeatureMenu (in obj, in newFeature, in newUserData)
	Appends the new feature to the drop down feature menu. More...

function	setFilename (in obj, in sourceFilename)
	Displays the string argument in the view. More...

function	setStudyPanelContents (in obj, in cellString)
	Displays the contents of cellString in the study panel. More...

function	draw (in obj)
	Draws the view. More...

function	setLinehandleColor (in obj, in lineHandleStruct, in colorStruct)
	Sets the color of the line handles. More...

function	getLabelhandlePosition (in obj, in displayTypeStr)
	Calculates the 'position' property of the labelhandle instance variable. More...

function	getFigHandle (in obj)
	Get the view's figure handle. More...

function	getLinehandle (in obj, in structType)
	Get the view's line handles as a struct. More...

function	showBusy (in obj, in status_label, in axesTag)
	Shows busy status (mouse becomes a watch). More...

function	showReady (in obj, in axesTag)
	Shows ready status (mouse becomes the default pointer). More...

function	setAxesState (in obj, in axesTag, in stateTag)
	Adjusts the color of the specified axes according to the specified state. More...

function	clear_handles (in obj)
	An alias for showReady() More...

Static Public Member Functions
static function	addFeaturesVecAndOverlayToAxes (in featureVector, in startStopDatenum, in overlayHeight, in overlayOffset, in axesH, in useSmoothing, in contextmenuH)
	Adds a feature vector as a heatmap and as a line plot to the specified axes. More...

static function	addFeaturesVecToAxes (in featureVector, in startStopDatenum, in overlayHeight, in overlayOffset, in axesH, in useSmoothing)
	Plots a feature vector on the specified axes. More...

static function	addOverlayToAxes (in overlayVector, in startStopDatenum, in overlayHeight, in overlayOffset, in maxValue, in axesH, in contextmenuH)
	Adds a magnitude vector as a heatmap to the specified axes. More...

static function	recurseHandleGenerator (in dummyStruct, in handleType, in handleProperties, in destStruct)
	Recursively fills in the template structure dummyStruct with matlab lines and returns as a new struct. If dummyStruct has numeric values in its deepest nodes, then these values are assigned as the y-values of the corresponding line handle, and the x-value is a vector from 1 to the number of elements in y. More...

static function	recurseHandleSetter (in handleStruct, in propertyStruct)
	Recursively sets struct of graphic handles with a matching struct of handle properties. More...

static function	setStructWithStruct (in handleStruct, in propertyStruct)
	Recursively initializes the graphic handles found in the provided structure with the properties found at corresponding locations in the propStruct argument. More...

static function	recurseHandleInit (in handleStruct, in properties)
	Recursively initializes the graphic handles found in the provided structure with the handle properties provided. More...

static function	getTicksForLabels (in cellOfLabels)
	Returns evenly spaced tick marks for an input cell of labels. This is a utility method for placing nicely spaced labels along an x or y axes. More...

Public Attributes
Property	hg_group
	for the patch handles when editing and dragging More...

Property	state_choices_cell
	cell of string choices for the marking state (off, 'marking','general') More...

Property	figurehandle
	figure handle that the class instance is associated with More...

Property	axeshandle
	struct whose fields are axes handles. Fields include: More...

Property	patchhandle
	struct whose fields are patch handles. Fields include: More...

Property	axesproperty
	struct whose fields are structs with names of the axes and whose fields are property values for those axes. Fields include: More...

Property	texthandle
	struct of text handles. Fields are: More...

Property	panelhandle
	struct of panel handles. Fields are: More...

Property	menuhandle
	struct of menu handles. Fields are: More...

Property	checkhandle
	Struct of check box handles. Fields include. More...

Property	linehandle
	Struct of line handles (graphic handle class) for showing activity data. More...

Property	referencelinehandle
	struct of line handles with matching fieldnames of instance variable linehandle which are used to draw a dotted reference line corresponding to zero. More...

Property	labelhandle
	Struct of text handles (graphic handle class) that display the the name or label of the line held at the corresponding position of linehandle. More...

Property	positionBarHandle
	Graphic handle of the vertical bar which provides a visual reference of where the window is in comparison to the entire study. More...

Property	contextmenuhandle

Property	dataObj
	PAData instance. More...

Property	window_resolution

Detailed Description

PAView serves as Padaco's view component. In the model, view, controller paradigm, this is the view.

Constructor & Destructor Documentation

function PAView::PAView	(	in	Padaco_fig_h,
		in	lineContextmenuHandle,
		in	primaryAxesContextmenuHandle,
		in	featureLineContextmenuHandle,
		in	secondaryAxesContextmenuHandle
	)

PAView class constructor.

Parameters

Padaco_fig_h	Figure handle to assign PAView instance to.
lineContextmenuHandle	Contextmenu handle to assign to VIEW's line handles
primaryAxesContextmenuHandle	Contextmenu to assign to VIEW's primary axes.
featureLineContextmenuHandle	Contextmenu to assign to VIEW's feature line handles.

Return values

obj	Instance of PAView

Member Function Documentation

static function PAView::addFeaturesVecAndOverlayToAxes	(	in	featureVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset,
		in	axesH,
		in	useSmoothing,
		in	contextmenuH
	)

static

Adds a feature vector as a heatmap and as a line plot to the specified axes.

Parameters

featureVector	The vector of features to be displayed.
startStopDatenum	A vector of start and stop date nums that correspond to the start and stop times of the study that the feature in featureVector at the same index corresponds to.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the axes.
overlayOffset	The normalized y offset ([0, 1]) that is applied to the featureVector when displayed on the axes.
axesH	Handle of the axes to assign features to.
useSmoothing	Boolean flag to set if feature vector should be applied (true) or not (false) before display.
contextmenuH	Optional contextmenu handle. Is assigned to the overlayLineH lines contextmenu callback when included.

Return values

feature_patchH	Patch handle of feature
feature_lineH	Line handle of feature
feature_cumsumLineH	Line handle of cumulative sum of feature

function PAView::addFeaturesVecAndOverlayToSecondaryAxes	(	in	obj,
		in	featureVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset
	)

Adds a feature vector as a heatmap and as a line plot to the secondary axes.

Parameters

obj	Instance of PAView.
featureVector	A vector of features to be displayed on the secondary axes.
startStopDatenum	A vector of start and stop date nums that correspond to the start and stop times of the study that the feature in featureVector at the same index corresponds to.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the secondary axes.
overlayOffset	The normalized y offset ([0, 1]) that is applied to the featureVector when displayed on the secondary axes.

static function PAView::addFeaturesVecToAxes	(	in	featureVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset,
		in	axesH,
		in	useSmoothing
	)

static

Plots a feature vector on the specified axes.

Parameters

featureVector	A vector of features to be displayed.
startStopDatenum	A vector of start and stop date nums that correspond to the start and stop times of the study that the feature in featureVector at the same index corresponds to.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the secondary axes.
overlayOffset	The normalized y offset ([0, 1]) that is applied to the featureVector when displayed on the secondary axes.
axesH	The graphic handle to the axes.
useSmoothing	Boolean flag to set if feature vector should be applied (true) or not (false) before display.

Return values

featureHandles Line handles created from the method.

function PAView::addFeaturesVecToSecondaryAxes	(	in	obj,
		in	featureVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset
	)

Plots a feature vector on the secondary axes.

Parameters

obj	Instance of PAView.
featureVector	A vector of features to be displayed on the secondary axes.
startStopDatenum	A vector of start and stop date nums that correspond to the start and stop times of the study that the feature in featureVector at the same index corresponds to.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the secondary axes.
overlayOffset	The normalized y offset ([0, 1]) that is applied to the featureVector when displayed on the secondary axes.

Return values

featureHandles Line handles created from the method.

function PAView::addLumensOverlayToSecondaryAxes	(	in	obj,
		in	lumenVector,
		in	startStopDatenum
	)

Adds an overlay of the lumens signal to the secondary axes.

Parameters

obj	Instance of PAView.
lumenVector	An Nx1 vector of lumen values to be displayed in the secondary axes.
startStopDatenum	An Nx2 matrix start and stop datenums which correspond to the start and stop times of the same row in overlayVector.

static function PAView::addOverlayToAxes	(	in	overlayVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset,
		in	maxValue,
		in	axesH,
		in	contextmenuH
	)

static

Adds a magnitude vector as a heatmap to the specified axes.

Parameters

overlayVector	A magnitude vector to be displayed in the axes as a heat map.
startStopDatenum	An Nx2 matrix start and stop datenums which correspond to the start and stop times of the same row in overlayVector.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the secondary axes.
overlayOffset	The normalized y offset that is applied to the overlayVector when displayed on the secondary axes.
maxValue	The maximum value to normalize the overlayVector with so that the normalized overlayVector's maximum value is 1.
axesH	The graphic handle to the axes.
contextmenuH	Optional contextmenu handle. Is assigned to the overlayLineH lines contextmenu callback when included.

function PAView::addOverlayToSecondaryAxes	(	in	obj,
		in	overlayVector,
		in	startStopDatenum,
		in	overlayHeight,
		in	overlayOffset,
		in	maxValue
	)

Adds a magnitude vector as a heatmap to the secondary axes.

Parameters

obj	Instance of PAView.
overlayVector	A magnitude vector to be displayed in the secondary axes as a heat map.
startStopDatenum	An Nx2 matrix start and stop datenums which correspond to the start and stop times of the same row in overlayVector.
overlayHeight	- The proportion (fraction) of vertical space that the overlay will take up in the secondary axes.
overlayOffset	The normalized y offset that is applied to the overlayVector when displayed on the secondary axes.
maxValue	The maximum value to normalize the overlayVector with so that the normalized overlayVector's maximum value is 1.

function PAView::appendFeatureMenu	(	in	obj,
		in	newFeature,
		in	newUserData
	)

Appends the new feature to the drop down feature menu.

Parameters

obj	Instance of PAView
newFeature	String label to append to the drop down feature menu.
newUserData	Mixed entry to append to the drop down feature menu's user data field.

function PAView::clear_handles ( in obj )

An alias for showReady()

Parameters

obj	Instance of PAView

function PAView::clearAxesHandles ( in obj )

Clears axes handles of any children and sets default properties. Called when first creating a view. See also initAxesHandles.

Parameters

obj	Instance of PAView

function PAView::clearFigure ( in obj )

Clears the main figure's handles (deletes all children handles).

Parameters

obj	Instance of PAView.

function PAView::clearTextHandles ( in obj )

Initialize text handles that will be used in the view. resets the currentWindow to 1.

Parameters

obj	Instance of PAView

function PAView::clearWidgets ( in obj )

Clear text ('string') of view's user interface widgets.

Parameters

obj	Instance of PAView

function PAView::createLineAndLabelHandles	(	in	obj,
		in	PADataObject
	)

Create the line handles and text handles that describe the lines, that will be displayed by the view. This is based on the structure template generated by member function getStruct('dummydisplay').

Parameters

PADataObject	Instance of PAData.
obj	Instance of PAView

function PAView::createView ( in obj )

Creates line handles and maps figure tags to PAView instance variables.

Parameters

obj	Instance of PAView.

Note: This method does not set the view mode. Call setViewMode(.) to configure the axes and widgets accordingly.

function PAView::disableWidgets ( in obj )

Disable user interface widgets.

Parameters

obj	Instance of PAView

function PAView::draw ( in obj )

Draws the view.

Parameters

obj	PADataObject Instance of PAData

function PAView::enableAggregateRadioButton	(	in	obj,
		in	enableState
	)

Enables the aggregate radio button.

Note: Requires aggregate data exists in the associated PAData object instance variable

Parameters

obj	Instance of PAView
enableState	Optional tag for specifying the 'enable' state. `'on'` [default] `'off'`

function PAView::enableFeatureRadioButton	(	in	obj,
		in	enableState
	)

Enables the Feature radio button.

Parameters

obj	Instance of PAView
enableState	Optional tag for specifying the 'enable' state. `'on'` [default] `'off'`

function PAView::enableTimeSeriesRadioButton	(	in	obj,
		in	enableState
	)

Enables the time series radio button.

Note: Requires feature data exist in the associated PAData object instance variable

Parameters

obj	Instance of PAView
enableState	Optional tag for specifying the 'enable' state. `'on'` [default] `'off'`

function PAView::getAggregateDurationMinutes ( in obj )

Retrieves the aggregate duration edit box value as a number.

Parameters

obj	Instance of PAView.

Return values

aggregateDurMin The aggregate duration (in minutes) currently set in the text edit box as a numeric value.

function PAView::getCurWindow ( in obj )

Retrieves the current window's edit box string value as a number.

Parameters

obj	Instance of PAView.

Return values

curWindow Numeric value of the current window displayed in the edit box.

function PAView::getDisplayType ( in obj )

Returns the display type instance variable.

Parameters

obj	Instance of PAView.

Return values

displayTypeStr

A string representing the display type. Will be one of:

Time Series
Aggregate Bins
Features

function PAView::getFigHandle ( in obj )

Get the view's figure handle.

Parameters

obj	Instance of PAView

Return values

figHandle View's figure handle.

function PAView::getFrameDurationHours ( in obj )

Retrieves the frame duration hours edit box value ) as a number.

Parameters

obj	Instance of PAView.

Return values

frameDurHours The frame duration (hours) currently set in the text edit box as a numeric value.

function PAView::getFrameDurationMinutes ( in obj )

Retrieves the frame duration edit box value (minutes) as a number.

Parameters

obj	Instance of PAView.

Return values

frameDurMinutes The frame duration (in minutes) currently set in the text edit box as a numeric value.

function PAView::getLabelhandlePosition	(	in	obj,
		in	displayTypeStr
	)

Calculates the 'position' property of the labelhandle instance variable.

Parameters

obj	Instance of PAView.
displayTypeStr	String representing the current display type. This can be `time` series `aggregate` bins `Features`

Return values

labelPosStruct A struct of 'position' properties that can be assigned to labelhandle instance variable.

function PAView::getLinehandle	(	in	obj,
		in	structType
	)

Get the view's line handles as a struct.

Parameters

obj	Instance of PAView
structType	String of a subfieldname to access the line handle of. (e.g. 'timeSeries')

Return values

linehandle View's line handles as a struct.

static function PAView::getTicksForLabels ( in cellOfLabels )

static

Returns evenly spaced tick marks for an input cell of labels. This is a utility method for placing nicely spaced labels along an x or y axes.

Parameters

cellOfLabels For example {'X','Y','Z','VecMag'}

Return values

ticks Vector of evenly spaced values between 1/(number of labels)/2 and 1

function PAView::getUseSmoothing ( in obj )

function PAView::getWindowDurSec ( in obj )

Retrieves the window duration drop down menu's current value as a number.

Parameters

obj	Instance of PAView.

Return values

windowDurSec Duration of the current view's window as seconds.

function PAView::initAxesHandles	(	in	obj,
		in	axesProps
	)

Initialize data specific properties of the axes handles. Set the x and y limits of the axes based on limits found in dataStruct struct.

Parameters

obj	Instance of PAView
axesProps	Structure of axes property structures. First fields are: `primary` (for the primary axes); `secondary` (for the secondary axes, lower, timeline axes)

function PAView::initAxesHandlesViewMode	(	in	obj,
		in	viewMode
	)

Clears axes handles of any children and sets default properties. Called when first creating a view. See also initAxesHandles.

Parameters

obj	Instance of PAView
viewMode	A string with one of two values `timeseries` `results`

function PAView::initWidgets	(	in	obj,
		in	viewMode,
		in	disableFlag
	)

Initialize user interface widgets on start up.

Parameters

obj	Instance of PAView
viewMode	A string with one of two values `timeseries` [default] `results`
disableFlag	boolean flag `false` [default] do not disable widgets for the view mode `true` - disable widgets for the view mode (sets 'enable' properties to 'off'

Note

Programmers: do not enable all radio button group children on init. Only if features and aggregate bins are available would we do this. However, we do not know if that is the case here.

buttonGroupChildren = get(handles.panel_displayButtonGroup,'children');

function PAView::initWithAccelData	(	in	obj,
		in	PADataObject
	)

Initializes the graphic handles (label and line handles) and maps figure tag names to PAView instance variables. Initializes the menubar and various widgets. Also set the acceleration data instance variable and assigns line handle y values to those found with corresponding field names in PADataObject.

Note: Resets the currentWindow to 1.

Parameters

obj	Instance of PAView
PADataObject	(Optional) PAData display struct that matches the linehandle struct of obj and whose values will be assigned to the 'ydata','xdata', and 'color' fields of the line handles. A label property struct will be created using the string values of labelStruct and the initial x, y value of the line props to initialize the 'string' and 'position' properties of obj's corresponding label handles.

static function PAView::recurseHandleGenerator	(	in	dummyStruct,
		in	handleType,
		in	handleProperties,
		in	destStruct
	)

static

Recursively fills in the template structure dummyStruct with matlab lines and returns as a new struct. If dummyStruct has numeric values in its deepest nodes, then these values are assigned as the y-values of the corresponding line handle, and the x-value is a vector from 1 to the number of elements in y.

Parameters

dummyStruct	Structure with arbitrarily deep number fields.
handleType	String name of the type of handle to be created: `line` `text`
handleProperties	Struct of line handle properties to initialize line handles with.
destStruct	Optional struct; see note.

Return values

destStruct The filled in struct, with the same field layout as dummyStruct but with line handles filled in at the deepest nodes.

Note: If destStruct is included, then lineproperties must also be included, even if only as an empty place holder. For example as
destStruct = PAView.recurseHandleGenerator(dummyStruct,handleType,[],destStruct)

Parameters

destStruct The initial struct to grow to (optional and can be different than the output node). For example
desStruct = PAView.recurseLineGenerator(dummyStruct,'line',proplines,diffStruct)
Or
recurseHandleGenerator(dummyStruct,'line',[],diffStruct)

static function PAView::recurseHandleInit	(	in	handleStruct,
		in	properties
	)

static

Recursively initializes the graphic handles found in the provided structure with the handle properties provided.

Parameters

handleStruct	The struct of line handles to set the properties of.
properties	Structure of property/value pairings to set the graphic handles found in handleStruct to.

static function PAView::recurseHandleSetter	(	in	handleStruct,
		in	propertyStruct
	)

static

Recursively sets struct of graphic handles with a matching struct of handle properties.

Parameters

handleStruct	The struct of matlab graphic handles. This is searched recursively until a handle is found (i.e. ishandle())
propertyStruct	Structure of property/value pairings to set the graphic handles found in handleStruct to.

function PAView::setAggregateDurationMinutes	(	in	obj,
		in	aggregateDurationStr
	)

Sets aggregate duration edit box string value.

Parameters

obj	Instance of PAView.
aggregateDurationStr	A string representing the aggregate duration as minutes.

function PAView::setAxesState	(	in	obj,
		in	axesTag,
		in	stateTag
	)

Adjusts the color of the specified axes according to the specified state.

Parameters

obj	Instance of PAView
axesTag	tag of the axes to set as ready or busy. Can be: `primary` `secondary` `all`
stateTag	State to set the axes as. Can be: `busy` - color is darker `ready` - color is white

function PAView::setCurWindow	(	in	obj,
		in	windowStr,
		in	xposStart,
		in	xposEnd
	)

Sets current window edit box string value.

Parameters

obj	Instance of PAView.
windowStr	A string to display in the current window edit box.
xposStart	The position on the x-axis of where the window starts. This will be a datenum for padaco.
xposEnd	The position on the x-axis of where the window in the ends. This will be a datenum for padaco.

function PAView::setDisplayType	(	in	obj,
		in	displayTypeStr,
		in	visibleProps
	)

Sets display type instance variable.

Parameters

obj	Instance of PAView.
displayTypeStr	A string representing the display type. Can be `timeSeries` `bins` `features`
visibleProps	Struct with the visibility property for each lineTag that can be displayed under the current displayType specified.

function PAView::setFilename	(	in	obj,
		in	sourceFilename
	)

Displays the string argument in the view.

Parameters

obj	PADataObject Instance of PAData
sourceFilename	String that will be displayed in the view as the source filename when provided.

function PAView::setFrameDurationHours	(	in	obj,
		in	frameDurationHoursStr
	)

Sets frame duration edit box (hours) string value.

Parameters

obj	Instance of PAView.
frameDurationHoursStr	A string representing the frame duration as minutes.

function PAView::setFrameDurationMinutes	(	in	obj,
		in	frameDurationMinutesStr
	)

Sets frame duration edit box (minutes) string value.

Parameters

obj	Instance of PAView.
frameDurationMinutesStr	A string representing the frame duration as minutes.

function PAView::setLinehandleColor	(	in	obj,
		in	lineHandleStruct,
		in	colorStruct
	)

Sets the color of the line handles.

Parameters

obj	Instance of PAView
lineHandleStruct	Struct of line handles to set the color of.
colorStruct	Struct with field organization corresponding to that of input line handles. The values are the colors to set the matching line handle to.

static function PAView::setStructWithStruct	(	in	handleStruct,
		in	propertyStruct
	)

static

Recursively initializes the graphic handles found in the provided structure with the properties found at corresponding locations in the propStruct argument.

Parameters

handleStruct	The struct of line handles to set the properties of.
propertyStruct	Structure of property structs (i.e. property/value pairings) to set the graphic handles found in handleStruct to.

function PAView::setStudyPanelContents	(	in	obj,
		in	cellString
	)

Displays the contents of cellString in the study panel.

Parameters

obj	PADataObject Instance of PAData
cellString	Cell of string that will be displayed in the study panel. Each cell element is given its own display line.

function PAView::setUseSmoothing	(	in	obj,
		in	smoothingState
	)

Sets line smoothing state for feature vectors displayed on the secondary axes.

Parameters

obj	Instance of PAView.
smoothingState	Possible values include: `true` Smoothing is on. `false` Smoothing is off.

function PAView::setViewMode	(	in	obj,
		in	viewMode
	)

Sets padaco's view mode to either time series or results viewing.

Parameters

obj	Instance of PAView
viewModeView	A string with one of two values `timeseries` `results`

function PAView::setWindowDurSecMenu	(	in	obj,
		in	windowDurSec
	)

Sets the window duration drop down menu's current value based on the input parameter (as seconds). If the duration in seconds is not found, then the value is appended to the drop down menu prior to being set.

Parameters

obj	Instance of PAView.
windowDurSec	Duration in seconds to set the drop downmenu's selection to

function PAView::showBusy	(	in	obj,
		in	status_label,
		in	axesTag
	)

Shows busy status (mouse becomes a watch).

Parameters

obj	Instance of PAView
status_label	Optional string which, if included, is displayed in the figure's status text field (currently at the top right of the view).
axesTag	Optional tag, that if set will set the axes tag's state to 'busy'. See setAxesState method.

function PAView::showReady	(	in	obj,
		in	axesTag
	)

Shows ready status (mouse becomes the default pointer).

Parameters

axesTag	Optional tag, that if set will set the axes tag's state to 'ready'. See setAxesState method.
obj	Instance of PAView

function PAView::updatePrimaryAxes	(	in	obj,
		in	axesRange
	)

Updates the secondary axes x and y axes limits.

timeSeries
features
Parameters

obj Instance of PAView

axesRange A 1x2 vector of the starting and stoping date numbers for the primary axes' x-axis.

function PAView::updateSecondaryAxes	(	in	obj,
		in	startStopDatenum
	)

Updates the secondary axes x and y axes limits.

Parameters

obj	Instance of PAView
startStopDatenum	A 1x2 vector of the starting and stoping date numbers.

Member Data Documentation

Property PAView::axeshandle

struct whose fields are axes handles. Fields include:

primary handle to the main axes an instance of this class is associated with
secondary Window view of events (over view)

Property PAView::axesproperty

struct whose fields are structs with names of the axes and whose fields are property values for those axes. Fields include:

primary handle to the main axes an instance of this class is associated with
secondary Window view of events (over view)

Property PAView::checkhandle

Struct of check box handles. Fields include.

sortResults - check to presort values from high to low for each profile vector
normalizeResults - check to show normalized results.
trimResults - check to trim outlier results.

Property PAView::contextmenuhandle

struct of handles for the context menu. Fields include

primaryAxes - for the primary Axes.
signals - For the lines, reference lines, and labels

Property PAView::dataObj

PAData instance.

Property PAView::figurehandle

figure handle that the class instance is associated with

Property PAView::hg_group

for the patch handles when editing and dragging

Property PAView::labelhandle

Struct of text handles (graphic handle class) that display the the name or label of the line held at the corresponding position of linehandle.

Property PAView::linehandle

Struct of line handles (graphic handle class) for showing activity data.

Property PAView::menuhandle

struct of menu handles. Fields are:

windowDurSec The window display duration in seconds
prefilter The selection of prefilter methods
signalSelection The signal to use (e.g. x-acceleration)
displayFeature Which feature to display (Default is all)
signalource - This is for the result type
featureSource - Result selection feature.
resultType - plot type used to show signal-feature results.

Property PAView::panelhandle

struct of panel handles. Fields are:

controls Handle to the left most panel that contains a panel of features
features Handle to the panel that contains widgets for extracting features.
metaData Handle to the panel that describes information about the current study.

Property PAView::patchhandle

struct whose fields are patch handles. Fields include:

feature Patches representing the current feature method.

Property PAView::positionBarHandle

Graphic handle of the vertical bar which provides a visual reference of where the window is in comparison to the entire study.

Property PAView::referencelinehandle

struct of line handles with matching fieldnames of instance variable linehandle which are used to draw a dotted reference line corresponding to zero.

Property PAView::state_choices_cell

cell of string choices for the marking state (off, 'marking','general')

Property PAView::texthandle

struct of text handles. Fields are:

status handle to the text status location of the Padaco figure where updates can go
studyinfo handle to the text box for display of loaded filename
curWindow
aggregateDuration
frameDurationMinutes
frameDurationHours
trimAmount

Property PAView::window_resolution

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

c_version_comments/PAView.cpp

obj	Instance of PAView
axesRange	A 1x2 vector of the starting and stoping date numbers for the primary axes' x-axis.

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation