getValue(name)
getBool(name)
getInt(name)
getFloat(name)
getString(name)
getResult(name)
getPoint2D(name)
getLine2D(name)
getPoint3D(name)
getLine3D(name)
getCircle(name)
getSphere(name)
getPlane(name)
getFloatVec1D(name)
getFloatVec2D(name)
getFloatVec3D(name)
getFloatMatr1D(name)
getFloatMatr2D(name)
getFloatMatr3D(name)
getTuple(name)

setValue(name,value,valid=True)
setBool(name,value,valid=True)
setInt(name,value,valid=True)
setFloat(name,value,valid=True)
setString(name,value,valid=True)
setResult(name,value,valid=True)
setPoint2D(name,value,valid=True)
setLine2D(name,value,valid=True)
setPoint3D(name,value,valid=True)
setLine3D(name,value,valid=True)
setCircle(name,value,valid=True)
setSphere(name,value,valid=True)
setPlane(name,value,valid=True)
setFloatVec1D(name,value,valid=True)
setFloatVec2D(name,value,valid=True)
setFloatVec3D(name,value,valid=True)
setFloatMatr1D(name,value,valid=True)
setFloatMatr2D(name,value,valid=True)
setFloatMatr3D(name,value,valid=True)
setTuple(name,value,valid=True)

Example 1 - Set a tool result

t=GetTool('ExData')
t.setFloat'Radius',12.0)

Example 2 - Run tools outside normal execution order

t=GetTool('FindCircle')            
t.execute()
t=GetTool('CircleFound')         
if t.execute(None)==1:
  print 'circle found'
else:
  print 'circle not found'

im=GetImageMatr('Image2')	#get the image matrix of Image2
t.execute(im)             	#execute on another image

Example 3 - Change tool configuration using the SPB

import SPB
t=GetTool('FindReference')
spb=SPB.CreateSpb(t.config)
spb.setFloat('ROI.x',10.3)  
spb.setFloat('ROI.y',15.2)
t.config=spb.xml

Example 4 - Access tools outside current toolbox (valid inside toolbox scripts only)

t=GetTool('.')		#returns owner toolbox tool
t=GetTool(':DATA')		#returns the tool 'DATA' at root level from whatever scope
t=GetTool('Circle.SETUP')	#returns the toolbox tool 'SETUP' in the toolbox 'Circle' at current level

Example 5 - Load and save tools

def LoadTool(name,fileName):
  #precondition: tool and file exists with identical tool class
  #postcondition: tool is loaded from file 
  return GetTool(name).load(fileName)

def SaveTool(name,fileName):
  #precondition: tool exists 
  #postcondition: tool configuration is written to file  
  return GetTool(name).save(fileName)

Example 6 - Accessing the python instance

Below is two methods defined in the tool scripts, the predefined 'init' scripts defined a instance property cnt. The 'execute' method is a user defined method taking a command argument. From the outside, both the cnt property and the execute method may be accessed, as seen in then last lines of the example.

Note that the instance is None if the tool don't implement any methods.

def init(self):
  self.cnt=0

def execute(self,command):
  if command=='inc':
    self.cnt+=1
  elif command=='dec':
    self.cnt-=1
  elif command=='reset':
    self.cnt=0

#sample code for accessing the instance
t=GetTool('py0')
if t.pyinst<>None:
  if t.pyinst.cnt<10:
    t.pyinst.execute('inc')
  else:
    t.pyinst.execute('reset')
  print 'cnt',t.pyinst.cnt