AHF_Rewarder
AHF_Rewarder.AHF_Rewarder module
- class AHF_Rewarder.AHF_Rewarder(taskP, settingsDictP)
Bases:
AHF_Base.AHF_BaseBase class for all rewarder classs. Other rewarders subclass from this, or from one of its subclasses
- addRewardToDict(rewardName, rewardSize)
- abstract countermandReward(resultsDict={}, settingsDict={})
- entryRewardDelayDefault = 1.0
- abstract giveReward(rewardName, resultsDict={}, settingsDict={})
- abstract giveRewardCM(rewardName, resultsDict={}, settingsDict={})
- hardwareTest()
Tests functionality, gives user a chance to change settings. :Returns: bool – True if any settings have changed
- maxBreakBeamRewardsDefault = 200
- maxEntryRewardsDefault = 1000
- rewardControl()
Opens and closes valve, as for testing, or draining the lines
- rewardUnits = ''
- setCountermandTime(countermandTime)
- testAmount = 0
- abstract turnOFF()
- abstract turnON()
AHF_Rewarder.AHF_Rewarder_solenoid module
- class AHF_Rewarder_solenoid.AHF_Rewarder_solenoid(taskP, settingsDictP)
Bases:
AHF_Rewarder.AHF_RewarderAn abstract base class to use a solenoid to deliver water rewards using 1 GPIO pin, subclasses use different timing methods
- breakBeamHandling()
- clearResultsDict(resultsDict)
Clears results for daily totals of reward types
- config_subject_get(starterDict={})
- Returns
dict – the default dictionary for individualized parameters
- static config_user_get(starterDict={})
static method that querries user for settings, with default responses from starterDict, and returns starterDict with settings as edited by the user.
- config_user_subject_get(starterDict={})
Prompts the user for individualized parameters, with default responses from starterDict, and returns starterDict with settings as edited by the user.
- countermandReward(resultsDict={}, settingsDict={})
Countermands the previously given reward
- defaultBBWait = 1
- defaultBreakBeam = 0.1
- defaultEntry = 0.2
- defaultPin = 13
- defaultTask = 0.4
- defaultWait = 900
- entryHandling()
- giveReward(rewardName, resultsDict={}, settingsDict={})
Gives reward, if reward name is in dictionary. If an entry reward, must be less than number of max entry rewards per day
- giveRewardCM(rewardName, resultsDict={}, settingsDict={})
Gives a reward that can be countermanded, i.e. cancelled if occurring before a timeour
- newResultsDict()
Return a dictionary of keys = rewardNames, values = number of rewards given, each mouse will get one of these for reward monitoring each day
- results_subject_get()
- rewardUnits = 'Seconds'
- abstract setup()
does hardware initialization with(possibly updated) info in self.settingsDict Run by __init__, or can be run separately after editing the settingsDict
- Returns
- code
bool whether setup completed without errors
- testAmount = 1.0
- abstract threadCMReward(sleepTime)
- abstract threadCountermand()
- abstract threadReward(sleepTime)
AHF_Rewarder.AHF_Rewarder_solenoid_pt module
- class AHF_Rewarder_solenoid_pt.AHF_Rewarder_solenoid_pt(taskP, settingsDictP)
Bases:
AHF_Rewarder_solenoid.AHF_Rewarder_solenoidA class to use a solenoid to deliver water rewards using 1 GPIO pin, using pulsed thread/PTSimpleGPIO for timing
- static about()
Returns a brief message describing your sub-class, used when asking user to pick a sub-class of this class
- setdown()
oppposite of setup. Releases any hardware resouces. can be run before editing settings so GPIO pins can be reused, for example. This strategy should be used in hardwareTest method.
- setup()
does hardware initialization with(possibly updated) info in self.settingsDict Run by __init__, or can be run separately after editing the settingsDict
- Returns
- code
bool whether setup completed without errors
- threadCMReward(sleepTime)
- threadCountermand()
- threadReward(sleepTime)
- turnOFF()
- turnON()
AHF_Rewarder.AHF_Rewarder_solenoid_rpi module
- class AHF_Rewarder_solenoid_rpi.AHF_Rewarder_solenoid_rpi(taskP, settingsDictP)
Bases:
AHF_Rewarder_solenoid.AHF_Rewarder_solenoidA class to use a solenoid to deliver water rewards using 1 GPIO pin controlled by RPi.GPIO , using sleep for timing
- static about()
Returns a brief message describing your sub-class, used when asking user to pick a sub-class of this class
- countermandVal = 0
- static rewardCMThread(delayTime, sleepTime, rewardPin)
- static rewardThread(sleepTime, rewardPin)
- setdown()
oppposite of setup. Releases any hardware resouces. can be run before editing settings so GPIO pins can be reused, for example. This strategy should be used in hardwareTest method.
- setup()
does hardware initialization with(possibly updated) info in self.settingsDict Run by __init__, or can be run separately after editing the settingsDict
- Returns
- code
bool whether setup completed without errors
- threadCMReward(sleepTime)
- threadCountermand()
- threadReward(sleepTime)
- turnOFF()
- turnON()