Skip to content

ndi.viz.selectRowsByModulationIndex

  SELECTROWSBYMODULATIONINDEX - Filter rows based on the modulation index

    T_OUT = NDI.VIZ.SELECTROWSBYMODULATIONINDEX(T, NAMEVALUEARGS)

    Filters a table that has been produced by ndi.viz.modulationIndex.

    It takes as input a table with a column that ends in the string
    'X.TC.modulationIndex'. The user can specify the column name as an
    optional input.

    The function examines each entry with an X.TC.modulationIndex value.
    If the modulation index is greater than or equal to 1, then the row
    is kept in the output table if the row X.properties.response_type is
    equal to 'F1'. If the modulation index is less than 1, then the row
    is kept in the output table if the row X.properties.response_type is
    equal to 'mean'.

    This function can also be specified using name/value pairs.
    'modulationIndexColumn'      : The column with the modulation index.
                                     If not specified, the function will look for a
                                     column that ends in '.TC.modulationIndex'.
    'responseTypeColumn'         : The column with the response type.
                                     If not specified, the function will look for a
                                     column that ends in '.properties.response_type'.
    'allowMultipleModulationIndexFilters' : (true/false) If true, then the function
                                     can search for many columns X.TC.modulationIndex
                                     and run the filter for each type of modulationIndex.
                                     Default is false.

    Example:
       T_filtered = ndi.viz.selectRowsByModulationIndex(T_with_MI)