Name | Data Type | Description |
---|---|---|
DATABASENAME | VARCHAR | Name of the database. Must include the table referenced by TABLENAME. |
TABLENAME | VARCHAR | Name of the table for filters. Must contain ID, ROW_I and MAG columns. |
FILTERID | Integer | Filter identifier, based on filter coefficients, stored in the table. |
FILTERTYPE | VARCHAR | The type of filter to generate. Options are:
|
WINDOWTYPE | VARCHAR | [Optional] Window function to the filter that maintains a smooth drop off to zero, and avoids extra artifacts in the frequency domain. Options are:
The default is to leave the filter coefficients as they are, and not apply any windowing function. |
FILTERLENGTH | Integer | [Optional] Length of the filter to generate. Overrides TRANSITIONBANDWIDTH argument if both are supplied, and renders the other an optional argument. Default is approximately 4/(TRANSITIONBANDWIDTH/SAMPLINGFREQUENCY). |
TRANSITIONBANDWIDTH | FLOAT | [Optional The maximum allowed size for the range of frequencies for filter transitions between a passband and stopband. This also determines the number of coefficients to be generated. Value must be greater than 0. A smaller value produces faster drop off at the cost of more coefficients. Not used when FILTERLENGTH is supplied. Default is bandwidth from FILTERLENGTH. |
LOWCUTOFF | FLOAT | [Optional] Determines the lower frequency that change between a passband and stopband occurs. Must be greater than 0. Not used by default with HIGHPASS filter. |
HIGHCUTOFF | FLOAT | [Optional] Determines the higher frequency that change between a passband and stopband occurs. Must be greater than 0. Not used by default with LOWPASS filter. |
SAMPLINGFREQUENCY | FLOAT | The frequency that the data to be filtered was sampled. Must be greater than 0. |
FILTERDESCRIPTION | VARCHAR | [Optional] Description for the filter coefficients that contain the same filter ID. Description is only written to one row for each filter generated, and ROW_I is 0. Default is a string describing parameters. |