workspace.tools.views.userSettings Namespace Reference

Classes
class	UserSettingsForm

Functions
def	getExtendedUserSetting (name, userSettings)
	Get the value of an ExtendedUserSetting from a UserSettings object. More...
def	saveExtendedUserSetting (name, userSettings, value)
	Save an ExtendedUserSetting for a UserSetting object. More...
def	userSettings (request)
	Display a list of UserSettings entries. More...
def	viewSettings (request, settingsName)
	Display a UserSettings object, and edit. More...
def	deleteSettings (request, settingsName)
	Delete a user's UserSettings object. More...

Variables
tuple	SPECTRA_PITCHTRACE_TYPE_CHOICES
tuple	SPECTRA_PITCHTRACE_COLOR_CHOICES
list	extended_settings_keys

Function Documentation

def workspace.tools.views.userSettings.deleteSettings	(		request,
			settingsName
	)

Delete a user's UserSettings object.

Note

Won't delete the object named 'default'

Parameters

request	The Django HTTP request object
settingsName	The name of the settings object to delete.

Returns

Django HTTP response object (userSettings())

def workspace.tools.views.userSettings.getExtendedUserSetting	(		name,
			userSettings
	)

Get the value of an ExtendedUserSetting from a UserSettings object.

Looks for an ExtendedUserSetting for the specified UserSettings object - if one is not found, return the default value of the ExtendedUserSetting.

Parameters

name	Name of the ExtendedUserSetting we are retrieving.
userSettings	UserSettings object containing the ExtendedUserSetting for which we are searching.

Returns

String value of the ExtendedUserSetting, or the default if none exists for this UserSettings Object. (Note: None Object is a possible and valid response.)

def workspace.tools.views.userSettings.saveExtendedUserSetting	(		name,
			userSettings,
			value
	)

Save an ExtendedUserSetting for a UserSetting object.

This will update an existing, or add a new, ExtendedUserSetting for a UserSetting object. Note that the 'name' of the setting must be an existing ExtendedUserSetting.

Parameters

name	Name of the ExtendedUserSetting we are setting.
userSettings	UserSettings object containing the ExtendedUserSetting for which we are searching.
value	The value to set for this setting.

def workspace.tools.views.userSettings.userSettings

(

request

)

Display a list of UserSettings entries.

Parameters

request

The Django HTTP request object

Returns

Django HTTP response object

def workspace.tools.views.userSettings.viewSettings	(		request,
			settingsName
	)

Display a UserSettings object, and edit.

GET shows form, POST saves changes.

Parameters

request

The Django HTTP request object

Returns

Django HTTP response object

Variable Documentation

list workspace.tools.views.userSettings.extended_settings_keys

Initial value:

= [
  # Pitch Trace Spectra
  'spectraPitchTraceNumFramesPerSecond',
  'spectraPitchTraceNumFrequencyBands',
  'spectraPitchTraceDampingFactor',
  'spectraPitchTraceMinimumBandFrequency',
  'spectraPitchTraceMaximumBandFrequency',
  # Pitch Trace Settings
  'spectraPitchTraceType',
  'spectraPitchTraceNumSamplePoints',
  'spectraPitchTraceColor',
  'spectraPitchTraceWidth',
  'spectraPitchTraceMinCorrelation',
  'spectraPitchTraceEntropyThreshold',
  'spectraPitchTraceStartFreq',
  'spectraPitchTraceEndFreq',
  'spectraPitchTraceMinEnergyThreshold',
  'spectraPitchTraceTolerance',
  'spectraPitchTraceInverseFreqWeight',
  'spectraPitchTraceMaxPathLengthPerTransition',
  'spectraPitchTraceWindowSize',
  'spectraPitchTraceExtendRangeFactor',
  ]

tuple workspace.tools.views.userSettings.SPECTRA_PITCHTRACE_COLOR_CHOICES

Initial value:

= (
  ("Black", "Black"),
  ("White", "White"),
)

tuple workspace.tools.views.userSettings.SPECTRA_PITCHTRACE_TYPE_CHOICES

Initial value:

= (
  ("None",        "None"),
  ("Fundamental", "Fundamental"),
  ("MaxEnergy",   "Max Energy"),
)