Filter Case Document statement

 [/h/]Filt
   [[/h/]Name[=window_name]]
   [[/h/]Inac[=pt_inactivate_threshold]]
   [[/h/]Rest[=pt_restore_threshold]]
   [[/h/]Fail[=pt_failure_threshold]]
   [[/h/]Add[=max_time]]
   [[/h/]Mint[=min_time]]
   [[/h/]Rem[=min_dist,min_dev]]
   [[/h/]ShThr[=shift_threshold]]
   [[/h/]ShLen[=max_shift]]
   [[/h/]Trej[=number_of_failures]]
   [[/h/]Rang[=trial_range]]
   [[/h/]SupXY[=channel_range]]
   [[/h/]Rprt[=None|New|Merge|Chain]

Type conventions and statement syntax are explained in the Glossary.

Parameters...

Name
Name parameter indicating the name of the case document to be affected by the command. Default: the topmost case document.

Inac
Number parameter indicating the threshold deviation for inactivation of data points. 0 turns inactivation of data points off. Minimum is 0, default: 0.08.

Rest
Number parameter indicating the maximal deviation to allow for restoration of previously inactivated data points. 0 turns restoration of data points off. Minimum is 0, default: 0.08.

Fail
Number parameter indicating the threshold for residual deviations to be counted as filter failures. 0 turns failure counting off.Minimum is 0, default: 0.08.

Add
Number parameter indicating the time gap between data points which is to trigger insertion of reconstructed points. Gaps between data points may arise from point rejection or from missing data. 0 turns reconstruction off. Minimum is 0, default: 1.

Mint
Number parameter indicating the minimal time interval between data points. Points that are closer to preceding point than this are removed. 0 turns feature off. Minimum is 0, default: 0.

Rem
Array parameter specifying spatial redundancy thresholds. Two numbers are expected. The first number specifies a minimal point to point distance. If points lie closer than this, they are considered redundant and removed from the data. The second number specifies the minimal distance from a straight line. If a series of points deviate less than this distance from the connecting straight line, all but the first and last are deleted. Specify 0,0 (defautl) to turn both checks off. Point reconstruction is run before the redundancy filter, in order to prevent reconstruction of points that were removed because of spatial redundancy.

ShThr
Number parameter indicating the threshold shift for inactivation of path segments. 0 turns inactivation of path segments off. Minimum is 0, default: 0.15.

ShLen
Number parameter indicating the maximal duration that path segments may have in order to be inactivated. This parameter also specifies how data are reconstructed during point resampling. If gaps are shorter than this value, weighed inter/extrapolation is used for smooth reconstruction, else data are linearly interpolated. Minimum is 0, default: 2.

Trej
Number parameter indicating the number of filter failures which will trigger the rejection of the entire trial. Enter 0 if you want trials never to be rejected. Minimum is 0, default: 2.

Rang
Range parameter indicating the range of trials to be filtered. By default all trials in the case are filtered.

SupXY
Range parameter specifying a range of supplemental data channels that are to be reconstructed using balanced inter/extrapolation like xy data of the path. Supplemental data not included in this range are reconstructed using an algorithm that strongly emphasizes interpolation over extrapolation. By default none of the supplemental data channels is treated as xy data.

Rprt
Radio button parameter indicating how the outcome of the filter operation should be reported. Default = None, else one of the following options:

• None = do not create a report.
• New = create a new scrollsheet to hold the results of the analysis.
• Merge = merge the results into the topmost scrollsheet reusing existing columns as much as possible and overwriting any previous results of the same analysis. If the topmost scrollsheet contains incompatible data, a new one is created.
• Chain = append the results to the topmost scrollsheet without reusing or overwriting any existing columns or rows. If the topmost scrollsheet contains incompatible data, a new one is created.

Note that...

Filter reports have the same format as trial variables created by the Analyze Case statement, therefore both can be reported in the same scrollsheet document.

Additional information...

• See the topic Filter Case command for basic information on the command.
• See the topic New Scrollsheet command for basic information on that command.
• Managing setup files provides in depth information on the management of setups.
• Inside case documents provides advanced information on case documents.
• Inside scrollsheets provides advanced information on scrollsheets.
• See Creating and using macros to learn how to use and create macros.
• There are lists of all available macro statements and menu commands.