{
    "command": "sgdippwd",
    "description": "Estimate local dip fields from sampled data using plane-wave destruction.\nChoose a 2D or 3D estimation mode to match the input dimensions; the output\ncontains the estimated dip components for subsequent dip-guided processing.",
    "examples": [],
    "input_description": "input dataset; only the first vector is used for dip estimation",
    "notes": [],
    "output_description": "output dataset with dipx and, for 3D estimation, dipy vectors added",
    "package": "sigclear-optim",
    "parameters": [
        {
            "choices": [],
            "default": "stdin",
            "default_known": false,
            "description": "input dataset; only the first vector is used for dip estimation",
            "name": "in",
            "required": false,
            "type": "ifile",
            "units": null
        },
        {
            "choices": [],
            "default": "stdout",
            "default_known": false,
            "description": "output dataset with dipx and, for 3D estimation, dipy vectors added",
            "name": "out",
            "required": false,
            "type": "ofile",
            "units": null
        },
        {
            "choices": [],
            "default": "dipx",
            "default_known": true,
            "description": "name of the first-axis dip vector",
            "name": "out.dipx",
            "required": false,
            "type": "str",
            "units": null
        },
        {
            "choices": [],
            "default": "dipy",
            "default_known": true,
            "description": "name of the second-axis dip vector for 3D estimation",
            "name": "out.dipy",
            "required": false,
            "type": "str",
            "units": null
        },
        {
            "choices": [],
            "default": false,
            "default_known": true,
            "description": "use 2D dip estimation; set to false for 3D estimation",
            "name": "twod",
            "required": false,
            "type": "bool",
            "units": null
        },
        {
            "choices": [
                "lagrange",
                "bspline",
                "pcmf"
            ],
            "default": "pcmf",
            "default_known": true,
            "description": "linear-phase approximation operator",
            "name": "lphase",
            "required": false,
            "type": "enum",
            "units": null
        },
        {
            "choices": [],
            "default": 2,
            "default_known": true,
            "description": "half-order of the linear-phase filter; its length is 2*order+1",
            "name": "order",
            "required": false,
            "type": "int",
            "units": null
        },
        {
            "choices": [
                "none",
                "mae",
                "mse",
                "tls",
                "m4e"
            ],
            "default": "mse",
            "default_known": true,
            "description": "regularization operator for dip estimation",
            "name": "smooth",
            "required": false,
            "type": "enum",
            "units": null
        },
        {
            "choices": [],
            "default": 5,
            "default_known": true,
            "description": "sample-axis window size for dip regularization",
            "name": "ntw",
            "required": false,
            "type": "int",
            "units": null
        },
        {
            "choices": [],
            "default": 3,
            "default_known": true,
            "description": "first lateral-axis window size for dip regularization",
            "name": "nxw",
            "required": false,
            "type": "int",
            "units": null
        },
        {
            "choices": [],
            "default": 3,
            "default_known": true,
            "description": "second lateral-axis window size for 3D dip regularization",
            "name": "nyw",
            "required": false,
            "type": "int",
            "units": null
        }
    ],
    "related": [],
    "schema_version": 1,
    "summary": "Estimate spatial dips from sampled data using plane-wave destruction",
    "synopsis": "sgdippwd <stdin >stdout out.dipx=\"dipx\" out.dipy=\"dipy\" twod=false lphase=pcmf order=2 smooth=mse ntw=5 nxw=3 nyw=3",
    "version": "1.0.1-5"
}