This page contains all the words in Ein and their help text. You can access this within Ein by running
( word ) help. Note that different compiles of Ein (for different robots) will contain different words. For example, if you have compiled Ein for Jaco, then the Baxter-specific words will not appear in this index, and vice-versa if you have compiled Ein for Baxter and not Jaco.

WordDescription
not
!
Pops a word; pushes a 0 or a 1 depending on its truth value.
mod
%
Takes two ints and pushes the mod of the two ints on the stack. 25 4 % returns 1.
and
&&
Returns logical and of its numeric arguments. Back does not have booleans so it treats 0 (and 0.0) as false, and all other numbers as true.
slide
'
Moves a word from the call stack to the data stack.
oP
(
Open paren; begin a compound word.
cP
)
Close paren; end a compound word.
times
*
Multiply two numeric arguments.
plus
+
Takes two numbers and adds them. If two ints, returns an int; otherwise returns a double; otherwise does string.
minus
-
Takes two numbers and subtracts them. `2 1 - ` produces 1. 1 2 - produces -1.
divide
/
Divide two numeric arguments.
executeStack
;
langle
<
Takes two words and returns 1 if they are less than (by value) and 0 otherwise. 1 3 < returns true, and 3 1 < returns false.
leq
<=
Takes two words and returns 1 if they are less than or equal to (by value) and 0 otherwise.
equals
=
Takes two words and returns 1 if they are equal (by value) and 0 otherwise.
rangle
>
Takes two words and returns 1 if they are greater than (by value) and 0 otherwise. 1 3 < returns false, and 3 1 < returns true
geq
>=
Takes two words and returns 1 if they are greater than or equal to (by value) and 0 otherwise.
car
First
Head
Takes a compound word on the stack and returns the first word in the list.
car
First
Head
Takes a compound word on the stack and returns the first word in the list.
pauseStackExecution
Pause
cdr
Rest
Tail
Takes a compound word on the stack and returns the rest of the word (as a compound word), minus the first word.
cdr
Rest
Tail
Takes a compound word on the stack and returns the rest of the word (as a compound word), minus the first word.
oSB
[
cSB
]
aboutFace
Rotate the gripper in oZ by 180 degrees.
abs
Returns the absolute value of its argument.
accumulate
Accumulate entries in a compound word using an operator word. Usage: ( 1 1 1 ) ( + ) accumulate -> 3.
activateSensorStreaming
Start streaming data; you might want to set the SiS ("Should I Stream?") first using setSisFlags or streamSetSis.
add3dGrasp
Add the current pose as a 3D grasp relative to the focused object. Must have locked the 3d grasp first so it knows what pose to use relative to the object.
add3dGraspPoseWord
Takes an argument on the stack of an EEPose and adds that pose as a 3d grasp relative to the base object.
addPlaceOverPoint
addPlaceUnderPoint
analogIOCommand
and
&&
Returns logical and of its numeric arguments. Back does not have booleans so it treats 0 (and 0.0) as false, and all other numbers as true.
append
approachSpeed
arm1By
arm1Current
arm1Down
arm1To
arm1True
arm1Up
arm2By
arm2Current
arm2Down
arm2To
arm2True
arm2Up
arm3By
arm3Current
arm3Down
arm3To
arm3True
arm3Up
arm4By
arm4Current
arm4Down
arm4To
arm4True
arm4Up
arm5By
arm5Current
arm5Down
arm5To
arm5True
arm5Up
arm6By
arm6Current
arm6Down
arm6To
arm6True
arm6Up
arm7By
arm7Current
arm7Down
arm7To
arm7True
arm7Up
armBackButtonState
armOkButtonState
armPose1Get
armPose1Set
armPose2Get
armPose2Set
armPose3Get
armPose3Set
armPose4Get
armPose4Set
armPose5Get
armPose5Set
armPose6Get
armPose6Set
armPose7Get
armPose7Set
armPoseToEePose
armPublishJointPositionCommand
armShowButtonState
armedThreshold
assert
assertNo
assumeAimedPose
assumeAny3dGrasp
assumeBackScanningPose
assumeBeeHome
assumeBest3dGrasp
assumeCalibrationPose
assumeCrane1
assumeCurrent3dGrasp
assumeDeliveryPose
assumeFacePose
assumeHandingPose
assumePose
assumeShrugPose
assumeZOfPoseWord
beeHome
beep
blankFace
blur
bringUpAllNonessentialSystems
Bring up systems that are not important for streaming data.
buildClassSimilarityMatrix
Builds the matrix of gradients of the current class labels.
buildClassSimilarityMatrixFromDensity
Builds the matrix of gradients of the current class labels.
c3dPoseBase
cB
}
cP
)
Close paren; end a compound word.
cSB
]
calibrateCameraAToB
calibrateGripper
calibrateRGBCameraIntrinsicsPoint
Run the old wrist camera calibration, that uses a single black dot to calibrate. You should use the new light field calibration with magic paper instead.
cameraCenterX
cameraCenterY
cameraCreate
Creates a new camera, usage in kinect2.back
cameraCropUpperLeftCornerX
cameraCropUpperLeftCornerY
cameraExposure
cameraFitHyperbolic
cameraFitQuadratic
cameraGain
cameraGetCalibrationMode
cameraGetCurrentHeightReticleX
Height reticle x
cameraGetCurrentHeightReticleY
Height reticle y
cameraGetIdxMagX
cameraGetIdxMagY
cameraGetTransformMatrix
cameraGetVpX
Vanishing point of camera.
cameraGetVpY
Vanishing point of camera.
cameraInitializeConfig
Initialize the configuration of the camera (reticles) with reasonable default values based on image size.
cameraKappaX
cameraKappaY
cameraMuX
cameraMuY
cameraName
The name of the focused camera.
cameraPrintParams
cameraR00
cameraR01
cameraR10
cameraR11
cameraSetCalibrationMode
cameraSetCurrentHeightReticleX
cameraSetCurrentHeightReticleY
cameraSetIdxMagX
cameraSetIdxMagY
cameraSetTransformMatrix
cameraSetVpX
cameraSetVpY
cameraWhiteBalanceBlue
cameraWhiteBalanceGreen
cameraWhiteBalanceRed
cameraZeroNonLinear
car
First
Head
Takes a compound word on the stack and returns the first word in the list.
castToInteger
catScan5VarianceTrialAuditClassNames
catScan5VarianceTrialAutolabelClassNames
catScan5VarianceTrialCalculateAllClassesAccuracy
catScan5VarianceTrialCalculateConfigurationAccuracy
catScan5VarianceTrialCalculatePoseVariances
cdr
Rest
Tail
Takes a compound word on the stack and returns the rest of the word (as a compound word), minus the first word.
ceil
centerHead
changeAnimationState
changeTargetClassToClosestBlueBox
changeToCounterTable
changeToHeight
changeToHeight0
changeToHeight1
changeToHeight2
changeToHeight3
changeToPantryTable
checkAndCountGrasp
checkGrasp
checkIfJammed
clearBlueBoxMemories
clearStack
clearCallStack
Clear the call stack.
clearClass3dGrasps
clearClassLabels
clearConsole
Prints a lot of newlines to the console to clear it.
clearData
clearDataStack
Clear the data stack.
clearData
clearDataStack
Clear the data stack.
clearIkMap
Reset the IK Map so that every cell is good.
clearMapForPatrol
clearStack
clearCallStack
Clear the call stack.
clearStackIntoMappingPatrol
clearStacks
Clear the call stack and the data stack.
clearStreamBuffers
closeGripper
cmp
Takes two words and returns 0 if they are equal, -1 if they are less than, and 1 if they are greater than. Works on integers, doubles and strings.
collapseStack
collectMoreCrops
collectMoreStreams
comeToHover
comeToHoverA
comeToStop
comeToStopA
commandOtherArm
Send a command to the other arm. It takes a string on the stack and sends it as a program to be executed on the other arm.
copyIkMapToHeightIdx
Copy the ik map to the height index.
cornellMugsOnTables
cos
createArmPose
createCachedClassifierFromClassLabels
createEEPose
cruisingSpeed
currentBackgroundMap
Pushes the current background map on the stack.
currentIKBoundaryMode
currentIKFastMode
currentIKMode
currentIKModeString
currentJointWord
currentObservedMap
Pushes the current observed map on the stack.
currentPose
currentPoseToWord
currentPredictedMap
Pushes the current predicted map on the stack.
currentScene
Pushes the current scene on the stack.
currentSceneFixationMode
currentTableZ
Current location of the table at z in base.
dataDirectory
The directory where data is stored.
dateString
deactivateSensorStreaming
Stop streaming data.
decMx
decMy
decrementCamera
decrementCurrentCornellTable
decrementTargetClass
decrementTargetInstanceSprite
decrementTargetMasterSprite
define
Store a new compound word with specified body, description, and name. Usage: <compound word> < help text > < name > define.
deliverObject
deliverTargetBoxMemory
deliverTargetObject
density
departureSpeed
deref
Takes a symbol word argument from the data stack and pushes its current value back onto the data stack. Usage: < symbol word > deref -> < value >
derefToTruth
Takes a symbol word argument from the data stack and pushes its current value back onto the data stack. Usage: < symbol word > deref -> < value >
destroyObjectInEndEffector
destroyTargetInstanceSprite
detectionSpin
diagnosticRelativePose
digitalIOCommand
disableDiskStreaming
disableRobot
dislodgeEndEffectorFromTable
divide
/
Divide two numeric arguments.
drand48
dsr
ducksInARow
dup
eePoseApplyRelativePoseTo
eePoseGetPoseRelativeTo
eePosePX
eePosePY
eePosePZ
eePoseQW
eePoseQX
eePoseQY
eePoseQZ
eePoseRPYOnQ
eePoseToArmPose
eeRange
Range reading.
eeRangeMaxValue
Range max value.
effortThresh
eighthTurn
einSoftwareVersion
Ein's version.
enableDiskStreaming
enableRobot
endArgs
endStackCollapse
endStackCollapseNoop
equals
=
Takes two words and returns 1 if they are equal (by value) and 0 otherwise.
eval
Takes a string from the data stack; evaluates the string as a back program. Usage: < string > eval -> whatever the program does
exec
executePreparedGrasp
executeStack
;
executionModeInstant
executionModeStep
exp
expand
exportDoc
Export words to an html file which is displayed on the website.
exportWords
Export words to a text file for documentation purposes.
faceAnimationFindEmotions
faceAnimationGetMode
faceAnimationGetRate
Rate of the face animation in hz
faceAnimationLoadAllEmotions
faceAnimationLoadEmotion
faceAnimationSetEmotionValue
faceAnimationSetMode
faceAnimationSetRate
fakeBBWidth
fasterRasterScanningSpeed
fetch
fileClose
Close the file. If you forget to do this, it will be closed automatically when the word is deallocated.
fileOpenInput
Open an input file for reading; takes a file name as an argument.
fileOpenOutput
Open an output file for writing; takes a file name as an argument.
fileReadAll
Read the contents of the file into a string and push it on the data stack.
fileReadLine
Read one line from the file into a string and leave it on the data stack.
fileWrite
Write a string to the file. Takes a file and a word, which is written. if it is a string, writes it as-is. Otherwise writes it with repr.
fileWriteLine
Write a line to the file. Takes a file and a word, which is written. if it is a string, writes it as-is. Otherwise writes it with repr.
fillClearanceMap
fillIkMap
Fill the IK map for the current range starting at the i and j and height on the stack.
fillIkMapAtCurrentHeight
Fill the IK map using data at the current EE height. We run at height 2 usually.
fillIkMapAtHeights
Fill the IK map at different heights.
fillIkMapFromCachedHeightIdx
Fill the IK map by taking the height idx from the cache.
fillIkMapFromCachedHeights
Fill the IK map by taking the and of the result at all the different heights.
filterBoxMemories
fixCameraLighting
Fix the camera lighting. Usage: <exposure> <gain> <red> <green> <blue> fixCameraLighting. You can see the current values with cameraGain, cameraExposure, cameraWhiteBalanceRed, cameraWhiteBlanaceGreen, cameraWhiteBalanceBlue.
fixCameraLightingNoUpdate
fixCameraLightingToAutomaticParameters
Fix the camera lighting using autogain. The camera parameters will first adjust automatically, then ein will fix them to the automatically adjusted values.
fixCameraLightingToObservedValues
floor
focusedCamera
focusedClassLabel
The focused class.
followPath
fullImpulse
gaitAnchoredTranslation
geq
>=
Takes two words and returns 1 if they are greater than or equal to (by value) and 0 otherwise.
get
Takes a compound word on the stack and an int. Returns the ith entry of the compound word. Uses zero based indexing.
getSpeed
goClassifyBlueBoxes
goFindBlueBoxes
gradientServoHardMaxIterations
gradientServoMode
gradientServoSoftMaxIterations
graspBackoffDistance
gridSize
gripperMaskThresh
Threshold for the gripper mask bmp.
guiCustom1
guiHideAll
guiShowAll
halfImpulse
handCameraOffset
handEndEffectorOffset
happyFace
help
Return help text for a word. Takes a compound word as an argument with a single word inside. Usage: ( word ) help.
histgramAllExamplesFocusedClass
histogramDetection
histogramDetectionIfBlueBoxes
histogramDetectionInit
histogramDetectionNormalize
histogramDetectionReport
histogramExampleAsFocusedClass
hover
hoverA
hoverThreshold
hundredthImpulse
iRCalibrationSpeed
idler
ifGrasp
ifNoGrasp
ift
Takes two words on the stack, executes the second word if the first word is true. For example, " ( "hello" print ) 1 ift" will print hello, while " ( "hello" print ) 0 ift" will not do it.
ifte
If then else takes two compound words and a condition and does the first one if the condition is true and the second if it is false. Usage: 0 ( "condition was true" print ) ( "condition was false" print ) ifte
ikMapEndHeight
End height for making the IP map.
ikMapStartHeight
Start height at which we make the IK map.
ikModeIkFast
ikModeIkFastDebug
ikModeService
imageStreamBufferLoadCurrent
import
inc
Adds one to its argument. 1 inc produces 2.
incMx
incMy
incrementCamera
incrementCurrentCornellTable
incrementImageStreamBuffer
Increments the current location in the image stream buffer. Loads it into memory and kicks it out when done.
incrementImageStreamBufferNoLoad
Increments the current location in the image stream buffer. Does not load the image into memory, but kicks it out when done.
incrementImageStreamBufferNoLoadNoKick
Increments the current location in the image stream buffer. Does not load the image into memory or kick it out when done.
incrementTargetClass
incrementTargetInstanceSprite
incrementTargetMasterSprite
initCumulativeGripperMask
initializeAndFocusOnNewClass
Initialize a new class with a default date-based name and focus on it. It will be created in the file system with default values and focused on.
initializeAndFocusOnTempClass
initializeConfig
initializeMap
integrateImageStreamBufferCrops
integrateImageStreamBufferServoImages
integrateRangeStreamBuffer
interlaceBottom
interlaceTop
interpolatePath
irFixPick
isAtCurrentPosition
isGripperGripping
isGripperMoving
iterateIsbAndAccumulateHeightImages
sum
join
Pops a compound word; sums the entries; pushes the result. Usage: ( 1 1 1 ) sum -> 3.
langle
<
Takes two words and returns 1 if they are less than (by value) and 0 otherwise. 1 3 < returns true, and 3 1 < returns false.
leftOrRightArm
leq
<=
Takes two words and returns 1 if they are less than or equal to (by value) and 0 otherwise.
lightsOff
lightsOn
loadCalibration
loadCalibrationRaw
loadConfig
loadDefaultCalibration
loadGripperMask
loadIkMap
loadIkMapAtHeight
localXDown
localXUp
localYDown
localYUp
localZDown
localZUp
lock3dGraspBase
map
mapAndPick
mapAndPickL
mapClosestBlueBox
mapEmptySpace
mapFreeSpacePixelSkirt
mapGrayBoxPixelSkirtCols
mapGrayBoxPixelSkirtRows
mapGrayBoxPixelWaistCols
mapGrayBoxPixelWaistRows
mapLocal
mapSearchFenceXMax
Xmax for the map in base.
mapSearchFenceXMin
Xmin for the map in base.
mapSearchFenceYMax
YMax for the map in base.
mapSearchFenceYMin
Ymin for the map in base.
mapServo
mapWaypoints
Maps objects at locations specified by EePoseWords underneath.
mappingPatrol
mappingPatrolA
mappingServoTimeout
markMapAsCompleted
max
measureTime
measureTimeA
measureTimeEnd
measureTimeInit
measureTimeInitSinceStart
measureTimeSetPeriod
measureTimeSinceStart
measureTimeStart
min
minus
-
Takes two numbers and subtracts them. `2 1 - ` produces 1. 1 2 - produces -1.
mkdir
mkdirs
mod
%
Takes two ints and pushes the mod of the two ints on the stack. 25 4 % returns 1.
mostRecentUntabledZ
moveAndStreamAimedShot
moveArmToPoseWord
moveCropToCenter
moveCropToCenterVanishingPoint
Move the crop to the center/vanishing point of the camera.
moveCropToCenterVanishingPointSlideHeightReticles
moveCropToProperValue
moveCropToProperValueNoUpdate
moveEeToPoseWord
moveJointsByAngles
moveJointsToAngles
moveObjectBetweenObjectAndObject
moveObjectToObjectByAmount
moveObjectToPose
moveTargetObjectToPose
moveToCurrentCornellTable
moveToEEPose
moveToNextMapPosition
moveToRegister
moveToRegister1
moveToRegister2
moveToRegister3
moveToRegister4
moveToRegister5
moveToRegister6
moveToSetVanishingPointHeightHigh
moveToSetVanishingPointHeightLow
moveToTargetZAndGrasp
moveToTargetZAndGraspA
movingThreshold
neutralFace
next
nil
The empty list. ( ) .
nod
noop
not
!
Pops a word; pushes a 0 or a 1 depending on its truth value.
now
numBlueBoxes
numCameras
numClasses
oB
{
oP
(
Open paren; begin a compound word.
oSB
[
oXDown
oXUp
oYDown
oYUp
oZDown
oZUp
observedCameraExposure
observedCameraFlip
observedCameraGain
observedCameraMirror
observedCameraWhiteBalanceBlue
observedCameraWhiteBalanceGreen
observedCameraWhiteBalanceRed
observedCameraWindowX
observedCameraWindowY
openGripper
openGripperInt
or
||
Returns logical or of its numeric arguments. Back does not have booleans so it treats 0 (and 0.0) as false, and all other numbers as true.
pauseAndReset
pauseStackExecution
Pause
perturbPosition
perturbPositionScale
photoSpin
pi
pickAllBlueBoxes
pickClosestBlueBox
pickFlushFactor
How close we get when picking.
pickObjectUnderEndEffector
pixelGlobalTest
placeHeldObjectOnObject
placeObjectInDeliveryZone
placeObjectInEndEffector
planCommandJointsAtRateSpin
planToPointCraneFourStroke
planToPointCraneThreeStroke
planToPointCraneThreeStrokeOpenJointHyperPlanner
plus
+
Takes two numbers and adds them. If two ints, returns an int; otherwise returns a double; otherwise does string.
pointToClearanceMap
pop
populateStreamBuffers
pow
prepareForAndExecuteGraspFromMemory
pressAndGrasp
pressAndGraspA
pressAndRelease
pressAndReleaseA
pressUntilEffort
pressUntilEffortA
pressUntilEffortAllInOne
Push down until there is effort sensed; top level word that can be called all in one.
pressUntilEffortCombo
Press down until effort is larger than a threshold. Pushes down once more quickly with a coarse press, then does a fine-grained press (to unwined the springs), so at the end you are lightly touching the surface.
pressUntilEffortInit
Initialize parameters for pressUntilEffort.
pressUntilEffortOrTwist
pressUntilEffortOrTwistA
pressUntilEffortOrTwistInit
pressUntilEffortStart
print
Pop a word from the stack and print it to the Ein console.
printClassLabels
Print class labels to standard output.
printJointAngles
printStacks
printState
prod
Pops a compound word; multiplies the entries; pushes the result. Usage: ( 1 1 1 ) prod -> 1.
publishCommandsMode
publishCommandsOff
Do not publish commands to the robot; useful if someone else (like MoveIt) is going to move the robot.
publishCommandsOn
Turn on publishing movement commands and other changing commands (lights, sonar).
publishImageFileToFace
publishImageToFace
publishRecognizedObjectArrayFromBlueBoxMemory
publishRecognizedObjectArrayFromPredictedMap
Publish recognized obejcts from predicted map.
publishState
publishWristViewToFace
pursuitProximity
pushClassLabels
Push the class labels on the stack.
pushClassLabelsReport
pushCurrentJointAngle
pushCurrentJointAngles
pushHelp
Push help text for the word on the data stack.
pushState
putCameraOverPhotoPin
quarterImpulse
quarterTurn
quiveringPalm
rangle
>
Takes two words and returns 1 if they are greater than (by value) and 0 otherwise. 1 3 < returns false, and 3 1 < returns true
rasterScanningSpeed
rayBufferInit
rayBufferPopulateFromImageBuffer
rayBufferSaveRaw
rayBufferSize
recordAllBlueBoxes
recordAllExamplesFocusedClass
recordExampleAsFocusedClass
recordGraspZ
recordPostTargetLock
recordPreTargetLock
registerEffort
registerEffortA
registerWrench
registerWrenchA
reloadCamera
reloadClassLabels
renameFocusedClass
renderSetWristViewBrightnessScalar
renderWristViewBrightnessScalar
repeatHalo
replaceBlueBoxesWithFocusedClass
replaceBlueBoxesWithHistogramWinner
replicateWord
repr
Takes an argument from the data stack pushes the string representation onto the data stack. Usage: < word > repr -> string
resetAccumulatedStreamImage
resetAuxiliary
resetAveragedWrenchNorm
resetCurrentFocusedClass
resetTemporalMap
resetW1ThreshToDefault
restoreIkShare
retrainVocabOff
retrainVocabOn
returnObject
reverseCompound
reversePath
rewindImageStreamBuffer
rewindImageStreamBufferNLNK
rgbScan
robotSerial
The robot serial number, used for naming configuration files uniquely.
robotSoftwareVersion
The robot software version. used for baxter sdk versions.
robotType
The type of the robot.
sB
|B
sP
|S
sadFace
save3dGrasps
saveCalibration
saveCalibrationToClass
saveConfig
saveGripperMask
saveIkMap
saveIkMapAtHeight
saveRegister1
saveRegister2
saveRegister3
saveRegister4
scanCentered
scanGroup
The scan group, for saving groups of scans organized by objects.
scanObjectFast
Scans an object without an IR scan, and with an annotated grasp.
scanObjectScene
Scans a stack of objects in stream mode with an annotated 3d grasps in stack.
scanObjectStream
Scans an object in stream mode with an annotated grasp.
scanObjectStreamAnnotated
Scans an object in stream mode with an annotated grasp.
scanObjectStreamWaypoints
Scans a stack of objects in stream mode with an annotated grasps in stack.
scanObjectStreamWaypoints3d
Scans a stack of objects in stream mode with an annotated 3d grasps in stack.
scanObjectStreamWaypoints3dNoPick
Scans a stack of objects in stream mode with an annotated 3d grasps in stack.
scanObjectStreamWaypointsIR
Scans a stack of objects in stream mode using IR raster scan to infer grasp points.
sceneAddDiscrepantPredictedToObserved
sceneAddPredictedFocusedObject
sceneAddPredictedObject
sceneAddPredictedToObserved
sceneAnchorPose
Takes a gaussian map on the stack and returns its anchor eePose.
sceneAngularApertureCols
sceneAngularApertureRows
sceneAngularBaffleCols
sceneAngularBaffleRows
sceneBackgroundMap
Takes a scene on the stack and returns its background map.
sceneCellCountThreshold
sceneCellWidth
Cell width of scene.
sceneClearDepthStack
sceneClearObservedMap
sceneClearPredictedObjects
sceneCoalesceClassHarmonics
sceneComposePredictedMap
sceneComposePredictedMapThreshed
sceneComputeProbabilityOfMap
sceneComputeScore
sceneCopyGaussianMap
Takes a gaussian map on the stack and performs a deep copy, leaving a new gaussian map on the stack.
sceneCopyObservedToReprojectionBuffer
sceneCopyScene
Takes a scene on the stack and performs a deep copy, leaving a new scene on the stack.
sceneCountDiscrepantCells
sceneCropToDiscrepantRegion
sceneDepthPatchHalfWidth
sceneDepthStackLoadAndCropRaw
sceneDepthStackLoadAndMarginalizeRaw
sceneDepthStackLoadAndMinRaw
sceneDepthStackLoadAndPushRaw
sceneDepthStackSavePngRaw
sceneDepthStackSaveRaw
sceneDiscrepancyMode
sceneDiscrepancySearchDepth
sceneExponentialAverageObservedIntoBackground
sceneFabricateIdealBlockModel
sceneFlattenUncertainZWithDepthStack
sceneGetAnnotatedClassName
The annotated class, for evaluation purposes.
sceneGetClassificationMode
sceneGetFixationMode
sceneGetPredictedClassName
The predicted class.
sceneGrabDiscrepantCropAsClass
sceneHighPrecisionBeforeAfterDiffOfLogs
sceneInit
sceneInitDefaultBackgroundMap
Check if the map exists; otherwise create a default one.
sceneInitDimensions
sceneInitFromEePose
sceneInitFromEePoseScale
sceneInitFromEePoseScaleDimensions
sceneInitRegisterMax
sceneInitRegisterZero
sceneInitSmall
sceneIsNewConfiguration
sceneLoadBackgroundMap
sceneLoadDiscrepancyMap
sceneLoadFocusedObjectModel
Load the object model of the focused class from disk.
sceneLoadFocusedSceneModel
Loads a scene from disk into the scene model for the focused class. Requires the name of a scene that is saved to disk.
sceneLoadGaussianMap
Takes a string, loads the gaussian map and puts it on the stack.
sceneLoadLightingModelFromGaussianMapFile
sceneLoadMonochromeBackground
sceneLoadObjectModel
Load the object model. Takes an object name as argument, which must be a directory name in the objects directory.
sceneLoadObservedMap
sceneLoadScene
sceneLoadSceneRaw
sceneMapSceneObject
sceneMarginalizeDepthStackIntoRegister
sceneMinDepthStackIntoRegister
sceneMinIntoRegister
sceneMinSigmaSquared
Variance on scene
sceneNumPredictedObjects
sceneObjectLabelToSceneObjectIdx
sceneObservedMap
Takes a scene on the stack and returns its observed map.
scenePredictBestObject
scenePredictFocusedObject
scenePredictedMap
Takes a scene on the stack and returns its predicted map.
scenePushAnchorPose
scenePushAverageCrCbSigmaSquared
scenePushDepthStackSize
scenePushFocusedClassModelArea
scenePushFocusedClassTotalDiscrepancy
scenePushLightingModel
scenePushNumSceneObjects
scenePushOntoDepthStack
scenePushPixelOfMinStackVariance
scenePushPixelOfMinVariance
scenePushSceneObjectLabel
scenePushSceneObjectPose
Takes an index; pushes the pose for this predicted object.
scenePushTotalDiscrepancy
scenePushTotalDiscrepancyMagnitude
scenePushTotalLogDiscrepancy
scenePushTotalRelevantOneMinusDiscrepancy
sceneRecalculateObservedMusAndSigmas
sceneRecallDepthStackIndex
sceneRecallFromRegister
sceneRegularizeSceneL2
sceneRenderBackgroundMap
sceneRenderDiscrepancy
sceneRenderObservedMap
sceneRenderPredictedMap
sceneRenderScene
sceneRenderZ
sceneSaveBackgroundMap
sceneSaveDiscrepancyDensityImage
sceneSaveDiscrepancyMap
sceneSaveFocusedSceneModel
sceneSaveGaussianMap
Takes a string and saves a gaussian map to that string.
sceneSaveLightingModelToGaussianMapFile
sceneSaveObservedMap
sceneSaveObservedMapImage
sceneSaveScene
sceneSaveSceneAbsolute
sceneScoreObjectAtPose
sceneScoreThresh
Score threshold for discrepancy.
sceneSetAngularApertureCols
sceneSetAngularApertureRows
sceneSetAngularBaffleCols
sceneSetAngularBaffleRows
sceneSetAnnotatedClassName
sceneSetAnnotatedClassNameToFocusedClass
sceneSetBackgroundFromObserved
sceneSetBackgroundMap
Takes a scene and a background map and sets the scene with the background map.
sceneSetBackgroundStdDevColor
sceneSetBackgroundStdDevY
sceneSetCellCountThreshold
sceneSetClassificationMode
sceneSetCurrentScene
Sets the current scene with its argument.
sceneSetDepthPatchHalfWidth
sceneSetDiscrepancyDensityFromZ
sceneSetDiscrepancyModeDot
sceneSetDiscrepancyModeNoisyAnd
sceneSetDiscrepancyModeNoisyOr
sceneSetDiscrepancyModePoint
sceneSetDiscrepancySearchDepth
sceneSetFixationMode
sceneSetFocusedSceneStdDevColor
sceneSetFocusedSceneStdDevY
sceneSetHeightReticleFromPixel
sceneSetHeightReticleFromVariance
sceneSetLightModelFromDiscrepancy
sceneSetLightingModelFromStack
sceneSetLightingModelStdDevColor
sceneSetLightingModelStdDevY
sceneSetMinSigmaSquared
sceneSetObservedMap
Takes a scene and an observed map and sets the scene with the observed map.
sceneSetObservedRGBFromVariance
sceneSetObservedRGBFromZ
sceneSetPredictedClassName
sceneSetPredictedClassNameToFocusedClass
sceneSetPredictedStdDevColor
sceneSetPredictedStdDevY
sceneSetScoreThresh
sceneSetVanishingPointFromPixel
sceneSetVanishingPointFromVariance
sceneSmoothDepthStackInZ
sceneSmoothDiscrepancyDensity
sceneSmoothSquaredCountsAndSamplesXY
sceneSpawnClassHarmonics
sceneStoreObservedInRegister
sceneTakeAfterDensity
sceneTakeBeforeDensity
sceneTrimDepthWithDiscrepancy
sceneUpdateAllClassDiscrepancies
sceneUpdateDiscrepancy
sceneUpdateObservedFromRegisterAtZNoRecalcPhasedArray
sceneUpdateObservedFromRegisterAtZNoRecalcPhasedArrayKernel
sceneUpdateObservedFromReprojectionBufferAtZNoRecalc
sceneUpdateObservedFromStreamBuffer
sceneUpdateObservedFromStreamBufferAtZ
sceneUpdateObservedFromStreamBufferAtZNoRecalc
sceneUpdateObservedFromStreamBufferAtZNoRecalcAll
Updates the observed map from the stream buffer in a big for loop; fastest version without GPU. This is the one to copy and call.
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllLightModelRenderGlareOnly
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllLightModelRenderGlareOnlyRising
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllLightModelRenderWithoutGlare
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllLightModelRenderWithoutGlareRising
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllOOP
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllSelfModelRenderGlareOnly
sceneUpdateObservedFromStreamBufferAtZNoRecalcAllSelfModelRenderWithoutGlare
sceneUpdateObservedFromStreamBufferAtZNoRecalcEPI
sceneUpdateObservedFromStreamBufferAtZNoRecalcPhasedArray
sceneUpdateObservedFromStreamBufferAtZNoRecalcSecondStageArray
sceneUpdateObservedFromStreamBufferAtZNoRecalcSecondStageAsymmetricArray
sceneUpdateObservedFromStreamBufferAtZNoRecalcViewSynthAll
sceneUpdateObservedFromStreamBufferAtZNoRecalcViewSynthAllGCLightModelRenderGlareOnly
sceneUpdateObservedFromStreamBufferAtZNoRecalcViewSynthAllGCLightModelRenderWithoutGlare
sceneUpdateObservedFromStreamBufferAtZNoRecalcViewSynthAllGCSelfRenderGlareOnly
sceneUpdateObservedFromStreamBufferAtZNoRecalcViewSynthAllGCSelfRenderWithoutGlare
sceneUpdateObservedFromStreamBufferDepthMap
Updates the observed map from the stream buffer as a depth map. Used for the Kinect 2.
sceneUpdateObservedFromStreamBufferNoRecalc
sceneUpdateObservedFromWrist
sceneZeroBox
sceneZeroLowerX
sceneZeroLowerY
sceneZeroUpperX
sceneZeroUpperY
searchProximity
seeHz
setArmedThreshold
setBeeHome
setBreakGraspTiesWithNoise
setC3dPoseBase
setCameraCenterX
setCameraCenterY
setCameraCropUpperLeftCornerX
setCameraCropUpperLeftCornerY
setCameraKappaX
setCameraKappaY
setCameraMuX
setCameraMuY
setCameraR00
setCameraR01
setCameraR10
setCameraR11
setClassLabels
Set the active classes. useage: endArgs "class1" "class2" setClassLabels. The class names must be directorys in the ein/default/objects folder.
setClassLabelsBaseClassAbsolute
setClassLabelsObjectFolderAbsolute
setColorReticles
setColorReticlesA
setControlModeAngles
setControlModeEePosition
setCurrentCornellTableToZero
setCurrentIKBoundaryMode
setCurrentIKFastMode
setCurrentPoseFromJoints
setCurrentPoseToTruePose
setCurrentTableZ
setDefaultHandCameraOffset
Sets the hand camera offset to the default value (obtained for Baxter's RGB wrist camera.
setEEPosePX
setEEPosePY
setEEPosePZ
setEEPoseQW
setEEPoseQX
setEEPoseQY
setEEPoseQZ
setEffortHere
setEffortThresh
setExpectedCropsToStream
setFakeBBWidth
setFocusedClass
setTargetClass
setFocusedClassIdx
setTargetClassIdx
setGradientServoHardMaxIterations
setGradientServoMode
setGradientServoSoftMaxIterations
setGraspBackoffDistance
setGraspModeTo3D
setGraspModeToCrane
setGreenHalo
setGridSize
setGridSizeCoarse
setGridSizeCoarser
setGridSizeEvenCoarser
setGridSizeFine
setGridSizeMedium
setGridSizeNowThatsCoarse
setGridSizeVeryFine
setGripperMask
setGripperMaskA
setGripperMaskAA
setGripperMaskB
setGripperMaskBA
setGripperMaskCA
setGripperMaskCB
setGripperMaskOnes
setGripperMaskThresh
setGripperMaskWithMotion
setGripperMaskWithMotionA
setGripperMovingForce
Set the moving force of the gripper. Takes an integer between 0-100.
setGripperThresh
setHandCameraOffset
setHandCameraOffsetFromTf
Sets the hand camera from tf using the links.
setHandEndEffectorOffset
setHeadPanTargetSpeed
setHeightReticles
setHeightReticlesA
setHelp
Make a new compound word with specified description text. Usage: <compound word> < help text > setHelp -> < compound word with help text >.
setHoverThreshold
setIROffset
setIdleModeToCrane
setIdleModeToEmpty
setIdleModeToPatrol
setIdleModeToShrug
setIdleModeToStopClear
setLastLabelLearned
setMagnification
setMagnificationA
setMagnificationB
setMapAutoPick
setMapFreeSpacePixelSkirt
setMapGrayBoxPixelSkirtCols
setMapGrayBoxPixelSkirtRows
setMapGrayBoxPixelWaistCols
setMapGrayBoxPixelWaistRows
setMapSearchFenceXMax
setMapSearchFenceXMin
setMapSearchFenceYMax
setMapSearchFenceYMin
setMapServoMode
setMappingServoTimeout
setMovementStateToMoving
setMovingThreshold
setNumClasses
setPatrolModeToLoop
setPatrolModeToOnce
setPatrolStateToHanding
setPatrolStateToIdling
setPatrolStateToPatrolling
setPatrolStateToPicking
setPatrolStateToPlacing
setPhotoPinHere
setPickFlushFactor
setPlaceModeToHand
setPlaceModeToHold
setPlaceModeToRegister
setPlaceModeToShake
setPressPose
setPursuitProximity
setRandomOrientationForPhotospin
setRandomPositionAfterPick
setRedHalo
setRepeatHalo
setScanGroup
setScanModeCentered
setScanModeNotCentered
setSearchProximity
setSisFlags
Set whether we should save different sensor streams. <pose> <range> <image> <joints> <word> <label> setSisFlags
setSnapToFlushGrasp
setSonarLed
setSpeed
setStiffness
setStreamPicks
setTable
setTableA
setFocusedClass
setTargetClass
setFocusedClassIdx
setTargetClassIdx
setTheYcbTable
setTorsoFanLevel
setTrackbarLoHi
setTwistThresh
setVanishingPoint
setVanishingPointA
setVanishingPointB
setVanishingPointPrep
setW1AngleThresh
setW1GoThresh
shakeHeadNegative
shakeHeadPositive
shakeItOff1
shakeItUpAndDown
shutdownAllNonessentialSystems
Shut down all systems that are not important for streaming data, to maximize the framerate we stream.
shutdownToSensorsAndMovement
silenceSonar
sin
size
Takes a compound word on the stack and an int. Returns the ith entry of the compound word. Uses zero based indexing.
slide
'
Moves a word from the call stack to the data stack.
slip
Moves a word from the data stack to the call stack.
spawnTargetClassAtEndEffector
spawnTargetMasterSpriteAtEndEffector
spinForSeconds
spinForSecondsA
spinForSecondsInit
squeezeDuck
start
start3dGraspAnnotation
start3dGraspAnnotationNoChange
stay
stayNoRoll
stayZOnly
stereoCalculate
stereoDisplay
stereoPair
stereoPairCache1
stereoPairCache2
stereoPrep
store
Create a new variable. Usage <value> "<name>" store. After that you can say <name> and it will push its contents on the call stack.
streamBasePoseForCurrentImage
Push the arm pose for the current image in the stream buffer.
streamCenterCropAsFocusedClass
streamCropsAsFocusedClass
streamDisableAllSisFlags
Enable all SIS flags.
streamDiskStreaming
streamEnableAllSisFlags
Enable all SIS flags.
streamEnableSisImageAndPoses
Configure Ein to stream images and poses only.
streamGraspResult
streamImageBufferCurrentIdx
streamImageBufferSize
streamImageSpeed
streamIncrementImageStreamBuffer
Increments the current location in the image stream buffer. The new default word, which does no load and no kick.
streamJointBufferSize
streamLabel
streamLabelBufferSize
streamPlayStreamBuffer
Play back the stream buffer. Plays back at a constant rate; is not careful to wait the 'correct' amount of time between frames.
streamPoseBufferSize
streamPoseForCurrentImage
Push the pose for the current image in the stream buffer.
streamRangeBufferSize
streamRenderStreamWindow
Render the stream buffer window.
streamScanCentered
streamSetDiskStreaming
streamSetImageBufferCurrentIdx
streamSetSisImage
streamSetSisJoints
streamSetSisLabel
streamSetSisPose
streamSetSisRange
streamSetSisWord
streamSisImage
streamSisJoints
streamSisLabel
streamSisPose
streamSisRange
streamSisWord
streamSpin
streamWordBufferSize
streamWriteBuffersToDisk
Write what is in the stream buffer to disk.
subscribeCameraParameterTrackerToRosOut
Subscribe to rosout. We don't want to do this for long periods since it's very noisy, but this is how we see the current camera parameters, since they aren't published any other way.
sum
join
Pops a compound word; sums the entries; pushes the result. Usage: ( 1 1 1 ) sum -> 3.
swap
switchSonarLed
tenthImpulse
throw
throwOpenCV
time
times
*
Multiply two numeric arguments.
toggleDrawClearanceMap
toggleDrawIKMap
toggleShouldIDoIK
toggleShouldIRender
toggleUseFade
toggleUseGlow
torsoFanAuto
torsoFanOff
torsoFanOn
torsoFanState
touchDown
trainAndWriteFocusedClassKnn
trainModels
Rebuild the kNN model for the detectors.
trainModelsFromLabels
transformPath
trueCameraPose
truePose
tryToMoveToTheLastPickHeight
tryToMoveToTheLastPrePickHeight
tuckArms
turnAboutY
twistThresh
twistWords
twoPartPlaceObjectOnObject
unFixCameraLighting
Let the camera parmeters automatically update (this is the Baxter default).
unFixCameraLightingNoUpdate
unSilenceSonar
unTurnAboutY
unmapTargetBlueBox
unsubscribeCameraParameterTrackerToRosOut
Unsubscribe from rosout. We don't want to stay plugged into rosut for very long since it's so noisy.
untuckArms
uploadObjectToDatabase
visionCycle
visionCycleNoClassify
voidCurrentMapRegion
w1AngleThresh
When we do wait until at current position
w1GoThresh
When we do wait until at current position
waitForSeconds
waitForSecondsA
waitForTugThenOpenGripper
waitForTugThenOpenGripperA
waitGetCurrentWaitMode
waitSetCurrentWaitMode
waitUntilAccelerometerCallbackReceived
waitUntilAccelerometerCallbackReceivedA
waitUntilAtCurrentPosition
waitUntilAtCurrentPositionB
waitUntilAtCurrentPositionCollapse
waitUntilEffort
waitUntilEffortA
waitUntilEndpointCallbackReceived
waitUntilEndpointCallbackReceivedA
waitUntilGripperNotMoving
waitUntilGripperNotMovingB
waitUntilGripperNotMovingC
waitUntilImageCallbackReceived
waitUntilImageCallbackReceivedA
waitUntilOnSideOfPlane
waitUntilOnSideOfPlaneB
waitUntilRingBufferImageAtCurrentPosition
while
While loop. Usage: ( 1 ) ( torsoFanOn 1 waitForSeconds torsoFanOff 1 waitForSeconds ) while
whileCollapsed
While loop. Use as in while, but collaspses the stack. This means that if you don't exit the while, Ein will also never exit the while, and be in an infinite loop, even if you clear the stacks.
writeAlphaObjectToBetaFolders
writeAlphaObjectToBetaFoldersA
writeFocusedClass
writeFocusedClassGrasps
writeXMLEnvironment
xDown
xUp
Move end effector up in the x dimension one unit. Change unit size with setGridSize. Usage: xUp
yDown
yUp
zDown
zUp
zeroGMode
zeroGOff
Turns off zero gravity mode, so Ein will publish the current pose as the desired target position.
zeroGOn
Turns on zero gravity mode, so that you can move the arm where you want and it will stay there. Ein will publish the true joint position as the desired joint position.
zeroGToggle
Toggle zero gravity mode.
oB
{
sB
|B
sP
|S
or
||
Returns logical or of its numeric arguments. Back does not have booleans so it treats 0 (and 0.0) as false, and all other numbers as true.
cB
}