selection for which trace information to return

pykat/finesse.py

@@ -93,7 +93,7 @@ def f__lkat_process(callback, cmd, kwargs):
         lkat._pykat_finish(0)
 
 
-def f__lkat_trace_callback(lkat, trace_info):
+def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
     """
     lkat callback for computing the beam traces through a setup.
     Returns a dictionary of nodes, spaces and cavities and the
@@ -106,6 +106,7 @@ def f__lkat_trace_callback(lkat, trace_info):
 
     lkat._pykat_step()
 
+    if getNodes:
         for n in range(0, inter.num_nodes):
             node = inter.node_list[n]
 
@@ -116,6 +117,7 @@ def f__lkat_trace_callback(lkat, trace_info):
 
             trace_info[node.name] = node_info
 
+    if getCavities:
         for c in range(0, inter.num_cavities):
             cav = inter.cavity_list[c]
 
@@ -135,6 +137,7 @@ def f__lkat_trace_callback(lkat, trace_info):
 
             trace_info[cav.name] = cav_info
 
+    if getSpaces:
         for s in range(0, inter.num_spaces):
             space = inter.space_list[s]
 
@@ -1187,7 +1190,13 @@ class kat(object):
             
         return rtn
         
-    def lkat_trace(self):
+    def lkat_trace(self, getCavities=True, getNodes=True, getSpaces=True):
+        """
+        Given the current state of the kat object a new FINESSE process is called and just
+        the beam tracing routine is run. The object that is returned contains all the information
+        from the beam tracing routine for each node and space components defined as well as cavity 
+        commands.   
+        """
         if lkat_location == None:
             raise RuntimeError("Could not find shared library 'libkat', please install to a system location or copy to the same directory as this script")
             
@@ -1197,15 +1206,15 @@ class kat(object):
         self.maxtem = 0
         
         try:
-            p = self.getProcess(f__lkat_trace_callback, trace_info=trace_info)
+            p = self.getProcess(f__lkat_trace_callback, trace_info=trace_info,
+                                getCavities=getCavities, getNodes=getNodes, getSpaces=getSpaces)
             p.start()
             p.join()
             
-        finally:
-            self.maxtem = prev
-
             # return a local copy of the trace information dictionary
             return dict(trace_info)
+        finally: 
+            self.maxtem = prev
     
     def __add_detector(self, det):