Added 3 examples. Refs #10243.

Code/Mantid/docs/source/algorithms/FilterEvents-v1.rst

@@ -66,4 +66,122 @@ Comparing with other event filtering algorithms
 Wiki page `EventFiltering <http://www.mantidproject.org/EventFiltering>`__ has a detailed
 introduction on event filtering in MantidPlot.
 
+Usage
+-----
+
+**Example - Filtering event without correction on TOF**  
+
+.. testcode:: FilterEventNoCorrection
+
+    ws = Load(Filename='CNCS_7860_event.nxs')
+    splitws, infows = GenerateEventsFilter(InputWorkspace=ws, UnitOfTime='Nanoseconds', LogName='SampleTemp', 
+            MinimumLogValue=279.9,  MaximumLogValue=279.98, LogValueInterval=0.01)
+    
+    FilterEvents(InputWorkspace=ws, SplitterWorkspace=splitws, InformationWorkspace=infows,
+            OutputWorkspaceBaseName='tempsplitws',  GroupWorkspaces=True, 
+            FilterByPulseTime = False, OutputWorkspaceIndexedFrom1 = False,
+            CorrectionToSample = "None", SpectrumWithoutDetector = "Skip", SplitSampleLogs = False,
+            OutputTOFCorrectionWorkspace='mock')
+   
+    # Print result
+    wsgroup = mtd["tempsplitws"]
+    wsnames = wsgroup.getNames()
+    for name in sorted(wsnames): 
+        tmpws = mtd[name]
+        print "workspace %s has %d events" % (name, tmpws.getNumberEvents())
+
+
+Output:
+
+.. testoutput:: FilterEventNoCorrection
+
+    workspace tempsplitws_0 has 124 events
+    workspace tempsplitws_1 has 16915 events
+    workspace tempsplitws_2 has 10009 events
+    workspace tempsplitws_3 has 6962 events
+    workspace tempsplitws_4 has 22520 events
+    workspace tempsplitws_5 has 5133 events
+    workspace tempsplitws_unfiltered has 50603 events
+
+
+**Example - Filtering event by pulse time**  
+
+.. testcode:: FilterEventByPulseTime
+
+    ws = Load(Filename='CNCS_7860_event.nxs')
+    splitws, infows = GenerateEventsFilter(InputWorkspace=ws, UnitOfTime='Nanoseconds', LogName='SampleTemp', 
+            MinimumLogValue=279.9,  MaximumLogValue=279.98, LogValueInterval=0.01)
+    
+    FilterEvents(InputWorkspace=ws, 
+        SplitterWorkspace=splitws, 
+        InformationWorkspace=infows,
+        OutputWorkspaceBaseName='tempsplitws',  
+        GroupWorkspaces=True, 
+        FilterByPulseTime = True, 
+        OutputWorkspaceIndexedFrom1 = True,
+        CorrectionToSample = "None", 
+        SpectrumWithoutDetector = "Skip", 
+        SplitSampleLogs = False,
+        OutputTOFCorrectionWorkspace='mock') 
+
+    # Print result
+    wsgroup = mtd["tempsplitws"]
+    wsnames = wsgroup.getNames()
+    for name in sorted(wsnames): 
+        tmpws = mtd[name]
+        print "workspace %s has %d events" % (name, tmpws.getNumberEvents())
+
+
+Output:
+
+.. testoutput:: FilterEventByPulseTime
+
+    workspace tempsplitws_1 has 123 events
+    workspace tempsplitws_2 has 16951 events
+    workspace tempsplitws_3 has 9972 events
+    workspace tempsplitws_4 has 7019 events
+    workspace tempsplitws_5 has 22529 events
+    workspace tempsplitws_6 has 5067 events
+
+
+**Example - Filtering event with correction on TOF**  
+
+.. testcode:: FilterEventTOFCorrection
+
+    ws = Load(Filename='CNCS_7860_event.nxs')
+    splitws, infows = GenerateEventsFilter(InputWorkspace=ws, UnitOfTime='Nanoseconds', LogName='SampleTemp', 
+            MinimumLogValue=279.9,  MaximumLogValue=279.98, LogValueInterval=0.01)
+
+    FilterEvents(InputWorkspace=ws, SplitterWorkspace=splitws, InformationWorkspace=infows,
+        OutputWorkspaceBaseName='tempsplitws',  
+        GroupWorkspaces=True, 
+        FilterByPulseTime = False, 
+        OutputWorkspaceIndexedFrom1 = False,
+        CorrectionToSample = "Direct", 
+        IncidentEnergy=3,
+        SpectrumWithoutDetector = "Skip", 
+        SplitSampleLogs = False,
+        OutputTOFCorrectionWorkspace='mock')
+    
+    # Print result
+    wsgroup = mtd["tempsplitws"]
+    wsnames = wsgroup.getNames()
+    for name in sorted(wsnames): 
+        tmpws = mtd[name]
+        print "workspace %s has %d events" % (name, tmpws.getNumberEvents())
+
+
+Output:
+
+.. testoutput:: FilterEventTOFCorrection
+
+    workspace tempsplitws_0 has 124 events
+    workspace tempsplitws_1 has 16937 events
+    workspace tempsplitws_2 has 9987 events
+    workspace tempsplitws_3 has 6962 events
+    workspace tempsplitws_4 has 22529 events
+    workspace tempsplitws_5 has 5124 events
+    workspace tempsplitws_unfiltered has 50603 events
+
+
 .. categories::