{
    "command": "sgxcorr",
    "description": "Correlate a selected vector pair within each group and write the result on a\nlag axis. When only one input vector is selected, the program computes its\nautocorrelation; use the lag and normalization options to control the result.",
    "examples": [],
    "input_description": "input data",
    "notes": [],
    "output_description": "output data:\n1. other vectors are removed\n2. all columns in one group produce one correlation column",
    "package": "sigclear-dsp",
    "parameters": [
        {
            "choices": [],
            "default": "stdin",
            "default_known": false,
            "description": "input data",
            "name": "in",
            "required": false,
            "type": "ifile",
            "units": null
        },
        {
            "choices": [],
            "default": "stdout",
            "default_known": false,
            "description": "output data:\n1. other vectors are removed\n2. all columns in one group produce one correlation column",
            "name": "out",
            "required": false,
            "type": "ofile",
            "units": null
        },
        {
            "choices": [],
            "default": "VECTOR(\"data\")",
            "default_known": false,
            "description": "x component, will be replaced by correlation data",
            "name": "x",
            "required": false,
            "type": "vect",
            "units": null
        },
        {
            "choices": [],
            "default": "NULL",
            "default_known": false,
            "description": "y component; defaults to x for autocorrelation",
            "name": "y",
            "required": false,
            "type": "vect",
            "units": null
        },
        {
            "choices": [],
            "default": 0.5,
            "default_known": true,
            "description": "last delay of cross-correlation",
            "name": "tmax",
            "required": false,
            "type": "float",
            "units": null
        },
        {
            "choices": [],
            "default": "-tmax",
            "default_known": false,
            "description": "first delay of cross-correlation",
            "name": "tmin",
            "required": false,
            "type": "float",
            "units": null
        },
        {
            "choices": [],
            "default": false,
            "default_known": true,
            "description": "normalize the correlation values",
            "name": "norm",
            "required": false,
            "type": "bool",
            "units": null
        }
    ],
    "related": [],
    "schema_version": 1,
    "summary": "auto-correlation or cross-correlation for dual vectors",
    "synopsis": "sgxcorr <stdin >stdout x=VECTOR(\"data\") y=NULL tmax=0.5 tmin=-tmax norm=false",
    "version": "1.2.0-2"
}