Skip to content

Method Parameters

Jump to bottom
Kevin Ballantyne edited this page Oct 25, 2024 · 4 revisions

NOTE: For parameters with on/off values, no entry is needed for off.

NOTE: All values must be entered as strings.

NOTE: The order of parameters in the method dictionary does not matter.

All Methods

All methods must have the following parameters:

Parameter Description
Category The parent Category Id for the method.
Method The Method Id.
LabelName The label name for the Method (can be any value but must be unique).

Every method (except 701 and 702) has the following parameters:

Parameter Required Description Value
DeliverOutputFile No Determines whether to deliver an output file. on/off
SaveOutputFormat Yes if using DeliverOutputFile An integer representing a parameter Id The following integers are valid:
1 - GeoTIFF

Category 100 - Utilities

Method 102 - Complex to Detected

No additional parameters for this method.

Method 104 - Incidence Angle Extraction 

"method-104-1": {
    "Category": "100",
    "Method": "104",
    "LabelName": "My Incidence Angle Extraction",
    "DeliverOutputFile": "on",
    "SaveOutputFormat": "1",
    "Product-102": "on",
    "Product-103": "on"
}

Output Layer Options:

Parameter Required Description Value
Product-102 No Incidence Angle (XML format):
The incidence angle information is represented in a vector format with a unique value for every pixel in range direction.		 on/off
Product-103 No Incidence Angle (raster format):
The incidence angle information is represented in a raster format with a unique value for every pixel in range direction and repeated for every line in the image.
The output consists of floating point numbers.		 on/off

Category 200 - Filters

Method 204 - Touzi-Lopes MMSE Filter 

"method-204-1": {
    "Category": "200",
    "Method": "204",
    "LabelName": "My Touzi-Lopes MMSE Filter",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Curve_detection_threshold": "0.5",
    "Edge_detection_threshold": "0.5",
    "Gradient_threshold": "0.1"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.
Curve_detection_threshold Yes Defines if a given pixel is part of a curved feature. A higher value reduces image smoothing but enhances the preservation of linear and curved features. A float value between 0.0 and 1.0 must be entered; 0.5 will be adequate in for most images.
Edge_detection_threshold Yes Defines if a given pixel is part of an edge feature. A higher value reduces image smoothing but enhances the preservation of edge features. A float value between 0.0 and 1.0 must be entered; 0.5 will be adequate in for most images.
Gradient_threshold Yes Defines the variation permitted for successive windows for defining the maximum isotropic area. If a low value is entered, the size of isotropic areas is reduced. A float value between 0.0 and 1.0 must be entered; 0.1 will be adequate for most images.

Method 205 - Median (G) 

"method-205-1": {
    "Category": "200",
    "Method": "205",
    "LabelName": "My Median (G)",
    "FilterSizeX": "5",
    "FilterSizeY": "5"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.

Method 206 - Enhanced Lee (G) 

"method-206-1": {
    "Category": "200",
    "Method": "206",
    "LabelName": "My Enhanced Lee (G)",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Dampening_coefficient": "0.5"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.
Dampening_coefficient Yes Defines the degree of the exponential damping. A higher value increases the degree of damping and so reduces image smoothing but enhances edge preservation. A float value between 0.0 and 1.0 can be entered.

Method 207 - Average Filter (G) 

"method-207-1": {
    "Category": "200",
    "Method": "207",
    "LabelName": "My Average Filter (G)",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "WeightingType": "1"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.
WeightingType Yes Preferred weighting function; this function controls the level of spatial detail that will be preserved. The following integers are valid:
0 - Constant
1 - Linear
2 - Gaussian

Method 208 - Gamma MAP (G) 

"method-208-1": {
    "Category": "200",
    "Method": "208",
    "LabelName": "My Gamma MAP (G)",
    "FilterSizeX": "5",
    "FilterSizeY": "5"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.

Method 209 - Lee (G) 

"method-209-1": {
    "Category": "200",
    "Method": "209",
    "LabelName": "My Lee (G)",
    "FilterSizeX": "5",
    "FilterSizeY": "5"
}
Parameter Required Description Value
FilterSizeX Yes Number of pixels of the moving window. An integer value that must be odd and between 1 to 21.
FilterSizeY Yes Number of lines of the moving window. An integer value that must be odd and between 1 to 21.

Category 300 - Ortho-rectification and Mosaic

Method 301 - Rational Function 

"method-301-1": {
    "Category": "300",
    "Method": "301",
    "LabelName": "My Rational Function",
    "ImgResampling": "2",
    "OutputPixSpacingMeters": "5",
    "OutputPixSpacingDeg": "0.000064",
    "TargetAlignedPixel": "on",
    "DemSource": "1",
    "Projection": "1",
    "ProcessAllOutputLayers": "on",
    "Product-302": "on"
}
Parameter Required Description Value
ImgResampling Yes Specify the resampling method to be applied to the image. The following integers are valid:
1 - Nearest Neighbour
2 - Bi-cubic
3 - Bi-linear
OutputPixSpacingMeters Yes Specify a value for the output pixel spacing in meters. Any float value between 0.0 and 1000.0.
OutputPixSpacingDeg Yes Specify a value for the output pixel spacing in decimal degrees. Any float value between 0.0 and 0.5.
TargetAlignedPixel No Align the coordinates of the extent of the output file to the values of the output pixel spacing,
such that the aligned extent includes the minimum extent.		 on/off
DemSource Yes Selects the preferred DEM to process the image. The following integers are valid:
1 - CDEM
2 - CDSM (CDEM+SRTM)
3 - SRTM 30m (Canada)
4 - SRTM 90m (World)
6 - ASTER 30m (World)
7 - SRTM 30m (World)
Projection Yes Specifies the desired output projection. The following integers are valid:
1 - UTM (auto) / NAD83  (CSRS)
2 - UTM (auto) / WGS84
4 - UTM / NAD83 (CSRS)
5 - UTM / WGS84
9 - Canada Atlas Lambert / NAD83 (EPSG:3978)
11 - Canada Albers Equal Area / NAD83 (EPSG:102001)
16 - Canada Crop Inventory Albers Equal Area / WGS84
17 - NSIDC Sea Ice Polar Stereographic North / WGS84
18 - NSIDC EASE-Grid 2.0 North / WGS84
ProcessAllOutputLayers No When this option is selected, all output layers from previously applied methods will be ortho-rectified. on/off

Output Layer Options:

Parameter Required Description Value
Product-302 No Determines to include optional output layers as a digital elevation model. on/off

Method 303 - Mosaic 

"method-303-1": {
    "Category": "300",
    "Method": "303",
    "LabelName": "My Mosaic",
    "OrthoMethod": "1",
    "ImgResampling": "2",
    "OutputPixSpacingMeters": "5",
    "OutputPixSpacingDeg": "0.000064",
    "TargetAlignedPixel": "on",
    "DemSource": "1",
    "Projection": "1",
    "Product-308": "on"
}
Parameter Required Description Value
OrthoMethod Yes The rational function is currently the only available option. The following integer is valid:
1 - Rational Function
ImgResampling Yes Specify the resampling method to be applied to the image. The following integers are valid:
1 - Nearest Neighbour
2 - Bi-cubic
3 - Bi-linear
OutputPixSpacingMeters Yes Specify a value for the output pixel spacing in meters. Any float value between 0.0 and 1000.0.
OutputPixSpacingDeg Yes Specify a value for the output pixel spacing in decimal degrees. Any float value between 0.0 and 0.5.
TargetAlignedPixel No Align the coordinates of the extent of the output file to the values of the output pixel spacing,
such that the aligned extent includes the minimum extent.		 on/off
DemSource Yes Selects the preferred DEM to process the image. The following integers are valid:
1 - CDEM
2 - CDSM (CDEM+SRTM)
3 - SRTM 30m (Canada)
4 - SRTM 90m (World)
6 - ASTER 30m (World)
7 - SRTM 30m (World)
Projection Yes Specifies the desired output projection. The following integers are valid:
1 - UTM (auto) / NAD83 (CSRS)
2 - UTM (auto) / WGS84
4 - UTM / NAD83 (CSRS)
5 - UTM / WGS84
9 - Canada Atlas Lambert / NAD83 (EPSG:3978)
11 - Canada Albers Equal Area / NAD83 (EPSG:102001)
16 - Canada Crop Inventory Albers Equal Area / WGS84
17 - NSIDC Sea Ice Polar Stereographic North / WGS84
18 - NSIDC EASE-Grid 2.0 North / WGS84

Output Layer Options:

Parameter Required Description Value
Product-308 No Determines whether to include optional output layers as a digital elevation model. on/off

Category 500 - Radiometry

Method 501 - Convert to Sigma Nought

No additional parameters for this method.

Method 502 - Convert to Beta Nought

No additional parameters for this method.

Method 503 - Convert to Gamma Nought

No additional parameters for this method.

Category 600 - Polarimetry

Method 601 - Pauli Decomposition 

"method-601-1": {
    "Category": "600",
    "Method": "601",
    "LabelName": "My Pauli Decomposition",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Product-695": "on",
    "Product-696": "on",
    "Product-697": "on",
    "Product-633": "on",
    "Product-634": "on",
    "Product-635": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.

Output Layer Options:

Parameter Required Description Value
Product-695 No Pauli Alpha: (single, or odd) bounce scatterer components - Float on/off
Product-696 No Pauli Beta: (double, or even) bounce scatterer components at 0 degree - Float on/off
Product-697 No Pauli Gamma: (double, or even) bounce scatterer components at 45 degrees - Float on/off
Product-633 No Pauli Alpha: (single, or odd) bounce scatterer components - Complex on/off
Product-634 No Pauli Beta: (double, or even) bounce scatterer components at 0 degree - Complex on/off
Product-635 No Pauli Gamma: (double, or even) bounce scatterer components at 45 degrees - Complex on/off

Method 602 - Freeman-Durden Decomposition 

"method-602-1": {
    "Category": "600",
    "Method": "602",
    "LabelName": "My Freeman-Durden Decomposition",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Product-625": "on",
    "Product-624": "on",
    "Product-626": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.

Output Layer Options:

Parameter Required Description Value
Product-625 No Double (or even) bounce scatterer components. on/off
Product-624 No Volume scatterer components. on/off
Product-626 No Surface (or single, or odd) bounce scatterer components. on/off

Method 603 - Touzi Decomposition 

"method-603-1": {
    "Category": "600",
    "Method": "603",
    "LabelName": "My Touzi Decomposition",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "AngleUnit": "1",
    "Product-601": "on",
    "Product-602": "on",
    "Product-603": "on",
    "Product-604": "on",
    "Product-605": "on",
    "Product-606": "on",
    "Product-607": "on",
    "Product-608": "on",
    "Product-609": "on",
    "Product-610": "on",
    "Product-611": "on",
    "Product-612": "on",
    "Product-613": "on",
    "Product-614": "on",
    "Product-615": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.
AngleUnit Yes Selects the desired units (degrees or radians) for angle-type variables. The following integers are valid:
1 - Degree
2 - Radian

Output Layer Options:

Parameter Required Description Value
Product-601 No EV1 - Orientation Angle (psi) on/off
Product-602 No EV1 - Dominant Eigenvalue (lambda) on/off
Product-603 No EV1 - Angle of the symmetric-scattering vector (Touzi alpha_s) on/off
Product-604 No EV1 - Phase difference between vector components (Touzi phi) on/off
Product-605 No EV1 - Helicity (Touzi tau) on/off
Product-606 No EV2 - Orientation Angle (psi) on/off
Product-607 No EV2 - Dominant Eigenvalue (lambda) on/off
Product-608 No EV2 - Angle of the symmetric-scattering vector (Touzi alpha_s) on/off
Product-609 No EV2 - Phase difference between vector components (Touzi phi) on/off
Product-610 No EV2 - Helicity (Touzi tau) on/off
Product-611 No EV3 - Orientation Angle (psi) on/off
Product-612 No EV3 - Dominant Eigenvalue (lambda) on/off
Product-613 No EV3 - Angle of the symmetric-scattering vector (Touzi alpha_s) on/off
Product-614 No EV3 - Phase difference between vector components (Touzi phi) on/off
Product-615 No EV3 - Helicity (Touzi tau) on/off

Method 604 - Polarimetric Discriminators 

"method-604-1": {
    "Category": "600",
    "Method": "604",
    "LabelName": "My Polarimetric Discriminators",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Product-653": "on",
    "Product-654": "on",
    "Product-655": "on",
    "Product-656": "on",
    "Product-657": "on",
    "Product-616": "on",
    "Product-617": "on",
    "Product-618": "on",
    "Product-619": "on",
    "Product-659": "on",
    "Product-652": "on",
    "Product-661": "on",
    "Product-658": "on",
    "Product-662": "on",
    "Product-663": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.

Output Layer Options:

Parameter Required Description Value
Product-653 No Stokes Vector - S0 (Total power) on/off
Product-654 No Stokes Vector - S1 on/off
Product-655 No Stokes Vector - S2 on/off
Product-656 No Stokes Vector - S3 on/off
Product-657 No Degree of Polarization (m) on/off
Product-616 No Sine of the latitude of the Stokes vector (s2chi) on/off
Product-617 No Sine of the longitude of the Stokes vector (s2psi) on/off
Product-618 No Degree of linear polarization (ml) on/off
Product-619 No Degree of circular polarization (mc) on/off
Product-659 No Linear polarization ratio (lpRatio) on/off
Product-652 No Circular polarization ratio (cpRatio) on/off
Product-661 No Coherency parameter (mu) on/off
Product-658 No Relative H and V Phase Difference (delta) on/off
Product-662 No Alpha parameter in the compact H/alpha (alpha) on/off
Product-663 No Longitude of Stokes vector 2*psi (phi) on/off

Method 605 - m-chi Decomposition 

"method-605-1": {
    "Category": "600",
    "Method": "605",
    "LabelName": "My m-chi Decomposition",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Product-627": "on",
    "Product-628": "on",
    "Product-629": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.

Output Layer Options:

Parameter Required Description Value
Product-627 No Double (or even) bounce scatterer components (M-Chi 1) on/off
Product-628 No Volume scatterer components (M-Chi 2) on/off
Product-629 No Surface (or single, or odd) bounce scatterer components (M-Chi 3) on/off

Method 606 - m-delta Decomposition 

"method-606-1": {
    "Category": "600",
    "Method": "606",
    "LabelName": "My m-delta Decomposition",
    "FilterSizeX": "5",
    "FilterSizeY": "5",
    "Product-630": "on",
    "Product-631": "on",
    "Product-632": "on"
}
Parameter Required Description Value
FilterSizeX Yes Enter the desired filter size in pixels (X). Integer values entered must be odd and may range from 1 to 17.
FilterSizeY Yes Enter the desired filter size in lines (Y). Integer values entered must be odd and may range from 1 to 17.

Output Layer Options:

Parameter Required Description Value
Product-630 No Double (or even) bounce scatterer components (M-Delta 1) on/off
Product-631 No Volume scatterer components (M-Delta 2) on/off
Product-632 No Surface (or single, or odd) bounce scatterer components (M-Delta 3) on/off

Method 609 - Compact Polarization to Circular Polarization to (RR, RL) 

"method-609-1": {
    "Category": "600",
    "Method": "609",
    "LabelName": "My Compact Polarization to Circular Polarization to (RR, RL)",
    "Product-687": "on",
    "Product-688": "on",
    "Product-641": "on",
    "Product-642": "on"
}

Output Layer Options:

Parameter Required Description Value
Product-687 No RR Circular Polarization component (Intensity) on/off
Product-688 No RL Circular Polarization component (Intensity) on/off
Product-641 No RR Circular Polarization component (Complex Intensity) on/off
Product-642 No RL Circular Polarization component (Complex Intensity) on/off

Method 614 - Quad-Pol. to Compact-Pol. (RH, RV) 

"method-614-1": {
    "Category": "600",
    "Method": "614",
    "LabelName": "My Quad-Pol. to Compact-Pol. (RH, RV)",
    "Product-693": "on",
    "Product-694": "on",
    "Product-643": "on",
    "Product-644": "on"
}

Output Layer Options:

Parameter Required Description Value
Product-693 No RH Compact Polarization component (Intensity) on/off
Product-694 No RV Compact Polarization component (Intensity) on/off
Product-643 No RH Compact Polarization component (Complex Intensity) on/off
Product-644 No RV Compact Polarization component (Complex Intensity) on/off

Method 615 - Quad-Pol to Full Circular (RR, RL, LR, LL) 

"method-615-1": {
    "Category": "600",
    "Method": "615",
    "LabelName": "My Quad-Pol to Full Circular (RR, RL, LR, LL)",
    "Product-689": "on",
    "Product-690": "on",
    "Product-691": "on",
    "Product-692": "on",
    "Product-645": "on",
    "Product-646": "on",
    "Product-647": "on",
    "Product-648": "on"
}

Output Layer Options:

Parameter Required Description Value
Product-689 No RR Circular Polarization component (Intensity) on/off
Product-690 No RL Circular Polarization component (Intensity) on/off
Product-691 No LR Circular Polarization component (Intensity) on/off
Product-692 No LL Circular Polarization component (Intensity) on/off
Product-645 No RR Circular Polarization component (Complex Intensity) on/off
Product-646 No RL Circular Polarization component (Complex Intensity) on/off
Product-647 No LR Circular Polarization component (Complex Intensity) on/off
Product-648 No LL Circular Polarization component (Complex Intensity) on/off

Category 700 - Interferometry

Method 701 - Ground Deformation 

"method-701-1": {
    "Category": "700",
    "Method": "701",
    "LabelName": "My Ground Deformation",
    "SpatialAvg": "3",
    "prodEnh": "2",
    "DemSource": "1",
    "ProcessExtent": "on",
    "ProcessExtentGeometry": "SRID=32663;MULTIPOLYGON(((-122.94525318437299 52.0305410666481,-122.94525318437299 51.868872792529494,-122.64656238847455 51.868872792529494,-122.64656238847455 52.0305410666481,-122.94525318437299 52.0305410666481)))",
    "Product-701": "on",
    "Product-702": "on",
    "Product-703": "on",
    "Product-704": "on",
    "Product-705": "on",
    "Product-706": "on",
    "Product-715": "on",
    "Product-707": "on",
    "Product-708": "on"
}
Parameter Required Description Value
SpatialAvg Yes Specifies a value for the spatial averaging. The following are valid integers:
1 - x1
2 - x2
3 - x4
4 - x8
prodEnh Yes Specifies a level for the product enhancement. The following are valid integers:
1 - Low
2 - Medium
3 - High
DemSource Yes Selects the preferred DEM for processing. The following integers are valid:
1 - CDEM
2 - CDSM (CDEM+SRTM)
3 - SRTM 30m (Canada)
4 - SRTM 90m (World)
6 - ASTER 30m (World)
7 - SRTM 30m (World)
ProcessExtent No Specifies a sub-region for processing. on/off
ProcessExtentGeometry Yes if ProcessExtent is on Process Specific Extent Geometry. A WKT geometry.

Output Layer Options:

Parameter Required Description Value
Product-701 No Digital elevation model on/off
Product-702 No Coregistered intensity on/off
Product-703 No Coherence on/off
Product-704 No Coherence (filtered) on/off
Product-705 No Wrapped phase on/off
Product-706 No Wrapped phase (filtered) on/off
Product-715 No Unwrapped phase on/off
Product-707 No Range displacements on/off
Product-708 No Range displacements time series and rates on/off

Method 702 - Very Large Ground Deformation 

"method-702-1": {
    "Category": "700",
    "Method": "702",
    "LabelName": "My Very Large Ground Deformation",
    "SpatialAvg": "3",
    "prodEnh": "2",
    "DemSource": "1",
    "ProcessExtent": "on",
    "ProcessExtentGeometry": "SRID=32663;MULTIPOLYGON(((-122.94525318437299 52.0305410666481,-122.94525318437299 51.868872792529494,-122.64656238847455 51.868872792529494,-122.64656238847455 52.0305410666481,-122.94525318437299 52.0305410666481)))",
    "Product-709": "on",
    "Product-710": "on",
    "Product-711": "on",
    "Product-712": "on",
    "Product-713": "on",
    "Product-714": "on"
}
Parameter Required Description Value
SpatialAvg Yes Specifies a value for the spatial averaging. The following are valid integers:
1 - x1
2 - x2
3 - x4
4 - x8
prodEnh Yes Specifies a level for the product enhancement. The following are valid integers:
1 - Low
2 - Medium
3 - High
DemSource Yes Selects the preferred DEM for processing. The following integers are valid:
1 - CDEM
2 - CDSM (CDEM+SRTM)
3 - SRTM 30m (Canada)
4 - SRTM 90m (World)
6 - ASTER 30m (World)
7 - SRTM 30m (World)
ProcessExtent No Specifies a sub-region for processing. on/off
ProcessExtentGeometry Yes if ProcessExtent is on Process Specific Extent Geometry. A WKT geometry.

Output Layer Options:

Parameter Required Description Value
Product-709 No Digital elevation model on/off
Product-710 No Coregistered intensity on/off
Product-711 No Azimuth/range displacements on/off
Product-712 No Azimuth/range displacements time series and rates on/off
Product-713 No 3D displacements (surface parallel flow) on/off
Product-714 No 3D displacements time series and rates (surface parallel flow) on/off

Home

EODMS CLI

How It Works

Configuration

Script Parameters

Processes

SAR Toolbox JSON Request

Clone this wiki locally