Image Action Set: Syntax

Provides actions for image processing

processImages Action

Performs core image processing functions.

CASL Syntax

image.processImages <result=results> <status=rc> /
required parameter casOut={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
maxMemSize=64-bit-integer,
name="table-name",
onDemand=TRUE | FALSE,
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
}
copyVars={"variable-name-1" <, "variable-name-2", ...>}
decode=TRUE | FALSE
image="variable-name"
imageFunctions={{
functionOptions={functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
}, {...}}
required parameter table={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=TRUE | FALSE,
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=TRUE | FALSE,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression"
}
;

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter (Appendix A: Common Parameters).

copyVars={"variable-name-1" <, "variable-name-2", ...>}

specifies the variables to be copy from the input table to the output table.

AliascopyVar

decode=TRUE | FALSE

when set to True, writes decompressed images and metadata to the output table.

Aliasdecompress
DefaultFALSE

image="variable-name"

specifies the name of the column that contains image binaries.

imageFunctions={{imcorefunctiondesc-1} <, {imcorefunctiondesc-2}, ...>}

lists image functions.

Aliassteps
functionOptions={functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
Aliasoptions, stepParameters

The value that you specify for functionType determines the other parameters that apply.

* table={castable}

specifies the table name, caslib, and other common parameters.

AliasimageTable
Long formtable={name="table-name"}
Shortcut formtable="table-name"
caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFALSE
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

AliascompVars
format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliasoptions, dataSource
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the variables to use for grouping results.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

group the data without sorting on each machine, and then group the data again on the controller.

REDISTRIBUTE

transfer rows between nodes to guarantee ordering within groups. This method is slower.

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=TRUE | FALSE

This parameter is deprecated.

DefaultTRUE
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFALSE
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for functionType="ADD_CONSTANT"

b=double

specifies a constant value for the B channel.

Default0
g=double

specifies a constant value for the G channel.

Default0
r=double

specifies a constant value for the R channel.

Default0

Parameters for functionType="BILATERAL_FILTER"

diameter=64-bit-integer

specifies the diameter of each pixel neighborhood.

sigmaColor=double

specifies the filter sigma in the color space. Larger values affect the farthest colors.

sigmaSpace=double

specifies the filter sigma in the coordinate space. Larger values affect the farthest colors.

Parameters for functionType="BOX_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="BUILD_PYRAMID"

pyrUpDown="PYR_DOWN" | "PYR_UP" | 64-bit-integer

specifies the type of the pyramid operation, downward or upward.

Parameters for functionType="CANNY_EDGE"

highThreshold=double

specifies the upper bound for the threshold.

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
Default3
lowThreshold=double

specifies the lower bound for the threshold.

Parameters for functionType="CONTOURS"

approximate=TRUE | FALSE

when set to True, applies approximation to contours.

DefaultFALSE
boundingBox=TRUE | FALSE

when set to True, creates bounding boxes on contours.

DefaultFALSE
groupBoxes=TRUE | FALSE

when set to True, groups bounding boxes.

DefaultFALSE

Parameters for functionType="CONVERT_COLOR"

type="BGR2HSV" | "BGR2RGB" | "BGR2YUV" | "COLOR2GRAY" | "GRAY2COLOR" | "HSV2BGR" | "RGB2BGR" | "YUV2BGR" | 64-bit-integer

specifies the color conversion code.

Parameters for functionType="CUSTOM_FILTER"

border="BORDER_BLACK" | "BORDER_REFLECT" | "BORDER_REFLECT101" | "BORDER_REPLICATE" | 64-bit-integer

specifies the border method in the convolution.

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelValues={double-1 <, double-2, ...>}

specifies values for the custom filter.

kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GAUSSIAN_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GET_PATCH"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw
x=64-bit-integer

specifies the X location.

Default0
y=64-bit-integer

specifies the Y location.

Default0

Parameters for functionType="HIST_EQUALIZATION"

method="ADAPTIVE" | "GLOBAL" | 64-bit-integer

specifies the histogram equalization method.

Parameters for functionType="LAPLACIAN"

delta=double

specifies the delta value.

Default0
kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="LINEAR_TRANSFORMATION"

method="LOCAL_CONTRAST_NORM" | "STANDARDIZATION" | "WHITENING_PCA" | "WHITENING_ZCA" | 64-bit-integer

specifies the linear transformation method.

Parameters for functionType="MEDIAN_FILTER"

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize

Parameters for functionType="MORPHOLOGY"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw
method="BLACKHAT" | "CLOSE" | "DILATE" | "ERODE" | "GRADIENT" | "HITMISS" | "OPEN" | "TOPHAT"

specifies the operation to be used in the morphology transformation.

shape="CROSS" | "ELLIPSE" | "RECT"

specifies the shape of the kernel used in the morphology transformation.

Parameters for functionType="MUTATIONS"

type="COLOR_JITTERING" | "COLOR_SHIFTING" | "DARKEN" | "HORIZONTAL_FLIP" | "INVERT_PIXELS" | "LIGHTEN" | "ROTATE_LEFT" | "ROTATE_RIGHT" | "SHARPEN" | "VERTICAL_FLIP" | 64-bit-integer

specifies the mutation type.

Parameters for functionType="NORMALIZE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="HAMMING" | "HAMMING2" | "INF" | "L1" | "L2" | "L2SQR" | "MINMAX" | "RELATIVE" | 64-bit-integer

specifies the function used in normalization.

Parameters for functionType="RESCALE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="TO_32F" | "TO_64F" | "TO_8U"

specifies the code for determining rescale.

Parameters for functionType="RESIZE"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw

Parameters for functionType="SOBEL"

delta=double

specifies the delta value.

Default0
dx=64-bit-integer

specifies the order of the derivative X.

dy=64-bit-integer

specifies the order of the derivative Y.

kernelSize="SIZE1" | "SIZE3" | "SIZE5" | "SIZE7" | 64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="THRESHOLD"

type="BINARY" | "BINARY_INVERSE" | "OTSU" | "TO_ZERO" | "TO_ZERO_INVERSE" | "TRIANGLE" | "TRUNCATE" | 64-bit-integer

specifies the function used in thresholding.

value=double

specifies the threshold value.

processImages Action

Performs core image processing functions.

Lua Syntax

results, info = s:image_processImages{
required parameter casOut={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
maxMemSize=64-bit-integer,
name="table-name",
onDemand=true | false,
promote=true | false,
replace=true | false,
replication=integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
copyVars={"variable-name-1" <, "variable-name-2", ...>},
decode=true | false,
image="variable-name",
imageFunctions={{
functionOptions={functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
}, {...}},
required parameter table={
caslib="string",
computedOnDemand=true | false,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=true | false,
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=true | false,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression"
}
}

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter (Appendix A: Common Parameters).

copyVars={"variable-name-1" <, "variable-name-2", ...>}

specifies the variables to be copy from the input table to the output table.

AliascopyVar

decode=true | false

when set to True, writes decompressed images and metadata to the output table.

Aliasdecompress
Defaultfalse

image="variable-name"

specifies the name of the column that contains image binaries.

imageFunctions={{imcorefunctiondesc-1} <, {imcorefunctiondesc-2}, ...>}

lists image functions.

Aliassteps
functionOptions={functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
Aliasoptions, stepParameters

The value that you specify for functionType determines the other parameters that apply.

* table={castable}

specifies the table name, caslib, and other common parameters.

AliasimageTable
Long formtable={name="table-name"}
Shortcut formtable="table-name"
caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
Defaultfalse
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

AliascompVars
format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliasoptions, dataSource
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the variables to use for grouping results.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

group the data without sorting on each machine, and then group the data again on the controller.

REDISTRIBUTE

transfer rows between nodes to guarantee ordering within groups. This method is slower.

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=true | false

This parameter is deprecated.

Defaulttrue
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

singlePass=true | false

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Defaultfalse
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for functionType="ADD_CONSTANT"

b=double

specifies a constant value for the B channel.

Default0
g=double

specifies a constant value for the G channel.

Default0
r=double

specifies a constant value for the R channel.

Default0

Parameters for functionType="BILATERAL_FILTER"

diameter=64-bit-integer

specifies the diameter of each pixel neighborhood.

sigmaColor=double

specifies the filter sigma in the color space. Larger values affect the farthest colors.

sigmaSpace=double

specifies the filter sigma in the coordinate space. Larger values affect the farthest colors.

Parameters for functionType="BOX_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="BUILD_PYRAMID"

pyrUpDown="PYR_DOWN" | "PYR_UP" | 64-bit-integer

specifies the type of the pyramid operation, downward or upward.

Parameters for functionType="CANNY_EDGE"

highThreshold=double

specifies the upper bound for the threshold.

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
Default3
lowThreshold=double

specifies the lower bound for the threshold.

Parameters for functionType="CONTOURS"

approximate=true | false

when set to True, applies approximation to contours.

Defaultfalse
boundingBox=true | false

when set to True, creates bounding boxes on contours.

Defaultfalse
groupBoxes=true | false

when set to True, groups bounding boxes.

Defaultfalse

Parameters for functionType="CONVERT_COLOR"

type="BGR2HSV" | "BGR2RGB" | "BGR2YUV" | "COLOR2GRAY" | "GRAY2COLOR" | "HSV2BGR" | "RGB2BGR" | "YUV2BGR" | 64-bit-integer

specifies the color conversion code.

Parameters for functionType="CUSTOM_FILTER"

border="BORDER_BLACK" | "BORDER_REFLECT" | "BORDER_REFLECT101" | "BORDER_REPLICATE" | 64-bit-integer

specifies the border method in the convolution.

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelValues={double-1 <, double-2, ...>}

specifies values for the custom filter.

kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GAUSSIAN_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GET_PATCH"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw
x=64-bit-integer

specifies the X location.

Default0
y=64-bit-integer

specifies the Y location.

Default0

Parameters for functionType="HIST_EQUALIZATION"

method="ADAPTIVE" | "GLOBAL" | 64-bit-integer

specifies the histogram equalization method.

Parameters for functionType="LAPLACIAN"

delta=double

specifies the delta value.

Default0
kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="LINEAR_TRANSFORMATION"

method="LOCAL_CONTRAST_NORM" | "STANDARDIZATION" | "WHITENING_PCA" | "WHITENING_ZCA" | 64-bit-integer

specifies the linear transformation method.

Parameters for functionType="MEDIAN_FILTER"

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize

Parameters for functionType="MORPHOLOGY"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw
method="BLACKHAT" | "CLOSE" | "DILATE" | "ERODE" | "GRADIENT" | "HITMISS" | "OPEN" | "TOPHAT"

specifies the operation to be used in the morphology transformation.

shape="CROSS" | "ELLIPSE" | "RECT"

specifies the shape of the kernel used in the morphology transformation.

Parameters for functionType="MUTATIONS"

type="COLOR_JITTERING" | "COLOR_SHIFTING" | "DARKEN" | "HORIZONTAL_FLIP" | "INVERT_PIXELS" | "LIGHTEN" | "ROTATE_LEFT" | "ROTATE_RIGHT" | "SHARPEN" | "VERTICAL_FLIP" | 64-bit-integer

specifies the mutation type.

Parameters for functionType="NORMALIZE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="HAMMING" | "HAMMING2" | "INF" | "L1" | "L2" | "L2SQR" | "MINMAX" | "RELATIVE" | 64-bit-integer

specifies the function used in normalization.

Parameters for functionType="RESCALE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="TO_32F" | "TO_64F" | "TO_8U"

specifies the code for determining rescale.

Parameters for functionType="RESIZE"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw

Parameters for functionType="SOBEL"

delta=double

specifies the delta value.

Default0
dx=64-bit-integer

specifies the order of the derivative X.

dy=64-bit-integer

specifies the order of the derivative Y.

kernelSize="SIZE1" | "SIZE3" | "SIZE5" | "SIZE7" | 64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="THRESHOLD"

type="BINARY" | "BINARY_INVERSE" | "OTSU" | "TO_ZERO" | "TO_ZERO_INVERSE" | "TRIANGLE" | "TRUNCATE" | 64-bit-integer

specifies the function used in thresholding.

value=double

specifies the threshold value.

processImages Action

Performs core image processing functions.

Python Syntax

results= s.image.processImages(
required parameter casOut={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"maxMemSize":64-bit-integer,
"name":"table-name",
"onDemand":True | False,
"promote":True | False,
"replace":True | False,
"replication":integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
copyVars=["variable-name-1" <, "variable-name-2", ...>],
decode=True | False,
image="variable-name",
imageFunctions=[{
"functionOptions":{"functionType":"ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
}<, {...}>],
required parameter table={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"computedVarsProgram":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"groupBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"importOptions":{"fileType":"AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"onDemand":True | False,
"orderBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"singlePass":True | False,
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"where":"where-expression"
}
)

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter (Appendix A: Common Parameters).

copyVars=["variable-name-1" <, "variable-name-2", ...>]

specifies the variables to be copy from the input table to the output table.

AliascopyVar

decode=True | False

when set to True, writes decompressed images and metadata to the output table.

Aliasdecompress
DefaultFalse

image="variable-name"

specifies the name of the column that contains image binaries.

imageFunctions=[{imcorefunctiondesc-1} <, {imcorefunctiondesc-2}, ...>]

lists image functions.

Aliassteps
"functionOptions":{functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
Aliasoptions, stepParameters

The value that you specify for functionType determines the other parameters that apply.

* table={castable}

specifies the table name, caslib, and other common parameters.

AliasimageTable
Long formtable={"name":"table-name"}
Shortcut formtable="table-name"
"caslib":"string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFalse
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

AliascompVars
"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of format field plus the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliasoptions, dataSource
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the variables to use for grouping results.

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of format field plus the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"groupByMode":"NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

group the data without sorting on each machine, and then group the data again on the controller.

REDISTRIBUTE

transfer rows between nodes to guarantee ordering within groups. This method is slower.

"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport_

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the table to use.

"onDemand":True | False

This parameter is deprecated.

DefaultTrue
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

"singlePass":True | False

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFalse
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

"where":"where-expression"

specifies an expression for subsetting the input data.

Parameters for functionType="ADD_CONSTANT"

"b":double

specifies a constant value for the B channel.

Default0
"g":double

specifies a constant value for the G channel.

Default0
"r":double

specifies a constant value for the R channel.

Default0

Parameters for functionType="BILATERAL_FILTER"

"diameter":64-bit-integer

specifies the diameter of each pixel neighborhood.

"sigmaColor":double

specifies the filter sigma in the color space. Larger values affect the farthest colors.

"sigmaSpace":double

specifies the filter sigma in the coordinate space. Larger values affect the farthest colors.

Parameters for functionType="BOX_FILTER"

"kernelHeight":64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
"kernelWidth":64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="BUILD_PYRAMID"

"pyrUpDown":"PYR_DOWN" | "PYR_UP" | 64-bit-integer

specifies the type of the pyramid operation, downward or upward.

Parameters for functionType="CANNY_EDGE"

"highThreshold":double

specifies the upper bound for the threshold.

"kernelSize":64-bit-integer

specifies the size of the square kernel.

Aliassize
Default3
"lowThreshold":double

specifies the lower bound for the threshold.

Parameters for functionType="CONTOURS"

"approximate":True | False

when set to True, applies approximation to contours.

DefaultFalse
"boundingBox":True | False

when set to True, creates bounding boxes on contours.

DefaultFalse
"groupBoxes":True | False

when set to True, groups bounding boxes.

DefaultFalse

Parameters for functionType="CONVERT_COLOR"

"type":"BGR2HSV" | "BGR2RGB" | "BGR2YUV" | "COLOR2GRAY" | "GRAY2COLOR" | "HSV2BGR" | "RGB2BGR" | "YUV2BGR" | 64-bit-integer

specifies the color conversion code.

Parameters for functionType="CUSTOM_FILTER"

"border":"BORDER_BLACK" | "BORDER_REFLECT" | "BORDER_REFLECT101" | "BORDER_REPLICATE" | 64-bit-integer

specifies the border method in the convolution.

"kernelHeight":64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
"kernelValues":[double-1 <, double-2, ...>]

specifies values for the custom filter.

"kernelWidth":64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GAUSSIAN_FILTER"

"kernelHeight":64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
"kernelWidth":64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GET_PATCH"

"height":64-bit-integer

specifies the height of an image (number of rows).

Aliash
"width":64-bit-integer

specifies the width of an image (number of columns).

Aliasw
"x":64-bit-integer

specifies the X location.

Default0
"y":64-bit-integer

specifies the Y location.

Default0

Parameters for functionType="HIST_EQUALIZATION"

"method":"ADAPTIVE" | "GLOBAL" | 64-bit-integer

specifies the histogram equalization method.

Parameters for functionType="LAPLACIAN"

"delta":double

specifies the delta value.

Default0
"kernelSize":64-bit-integer

specifies the size of the square kernel.

Aliassize
"scale":double

specifies the scale value.

Default1

Parameters for functionType="LINEAR_TRANSFORMATION"

"method":"LOCAL_CONTRAST_NORM" | "STANDARDIZATION" | "WHITENING_PCA" | "WHITENING_ZCA" | 64-bit-integer

specifies the linear transformation method.

Parameters for functionType="MEDIAN_FILTER"

"kernelSize":64-bit-integer

specifies the size of the square kernel.

Aliassize

Parameters for functionType="MORPHOLOGY"

"kernelHeight":64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
"kernelWidth":64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw
"method":"BLACKHAT" | "CLOSE" | "DILATE" | "ERODE" | "GRADIENT" | "HITMISS" | "OPEN" | "TOPHAT"

specifies the operation to be used in the morphology transformation.

"shape":"CROSS" | "ELLIPSE" | "RECT"

specifies the shape of the kernel used in the morphology transformation.

Parameters for functionType="MUTATIONS"

"type":"COLOR_JITTERING" | "COLOR_SHIFTING" | "DARKEN" | "HORIZONTAL_FLIP" | "INVERT_PIXELS" | "LIGHTEN" | "ROTATE_LEFT" | "ROTATE_RIGHT" | "SHARPEN" | "VERTICAL_FLIP" | 64-bit-integer

specifies the mutation type.

Parameters for functionType="NORMALIZE"

"alpha":double

specifies the alpha value.

Default1
"beta":double

specifies the beta value.

Default0
"type":"HAMMING" | "HAMMING2" | "INF" | "L1" | "L2" | "L2SQR" | "MINMAX" | "RELATIVE" | 64-bit-integer

specifies the function used in normalization.

Parameters for functionType="RESCALE"

"alpha":double

specifies the alpha value.

Default1
"beta":double

specifies the beta value.

Default0
"type":"TO_32F" | "TO_64F" | "TO_8U"

specifies the code for determining rescale.

Parameters for functionType="RESIZE"

"height":64-bit-integer

specifies the height of an image (number of rows).

Aliash
"width":64-bit-integer

specifies the width of an image (number of columns).

Aliasw

Parameters for functionType="SOBEL"

"delta":double

specifies the delta value.

Default0
"dx":64-bit-integer

specifies the order of the derivative X.

"dy":64-bit-integer

specifies the order of the derivative Y.

"kernelSize":"SIZE1" | "SIZE3" | "SIZE5" | "SIZE7" | 64-bit-integer

specifies the size of the square kernel.

Aliassize
"scale":double

specifies the scale value.

Default1

Parameters for functionType="THRESHOLD"

"type":"BINARY" | "BINARY_INVERSE" | "OTSU" | "TO_ZERO" | "TO_ZERO_INVERSE" | "TRIANGLE" | "TRUNCATE" | 64-bit-integer

specifies the function used in thresholding.

"value":double

specifies the threshold value.

processImages Action

Performs core image processing functions.

R Syntax

results <– cas.image.processImages(s,
required parameter casOut=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
maxMemSize=64-bit-integer,
name="table-name",
onDemand=TRUE | FALSE,
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
copyVars=list("variable-name-1" <, "variable-name-2", ...>),
decode=TRUE | FALSE,
image="variable-name",
imageFunctions=list( list(
functionOptions=list(functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters)
) <, list(...)>),
required parameter table=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
groupBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
onDemand=TRUE | FALSE,
orderBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
singlePass=TRUE | FALSE,
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
where="where-expression"
)
)

Parameter Descriptions

* casOut=list(casouttable)

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter (Appendix A: Common Parameters).

copyVars=list("variable-name-1" <, "variable-name-2", ...>)

specifies the variables to be copy from the input table to the output table.

AliascopyVar

decode=TRUE | FALSE

when set to True, writes decompressed images and metadata to the output table.

Aliasdecompress
DefaultFALSE

image="variable-name"

specifies the name of the column that contains image binaries.

imageFunctions=list( list(imcorefunctiondesc-1) <, list(imcorefunctiondesc-2), ...>)

lists image functions.

Aliassteps
functionOptions={functionType="ADD_CONSTANT" | "BILATERAL_FILTER" | "BOX_FILTER" | "BUILD_PYRAMID" | "CANNY_EDGE" | "CONTOURS" | "CONVERT_COLOR" | "CUSTOM_FILTER" | "GAUSSIAN_FILTER" | "GET_PATCH" | "HIST_EQUALIZATION" | "LAPLACIAN" | "LINEAR_TRANSFORMATION" | "MEDIAN_FILTER" | "MORPHOLOGY" | "MUTATIONS" | "NORMALIZE" | "RESCALE" | "RESIZE" | "SOBEL" | "THRESHOLD", functionType-specific-parameters}
Aliasoptions, stepParameters

The value that you specify for functionType determines the other parameters that apply.

* table=list(castable)

specifies the table name, caslib, and other common parameters.

AliasimageTable
Long formtable=list(name="table-name")
Shortcut formtable="table-name"
caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFALSE
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

AliascompVars
format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliasoptions, dataSource
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the variables to use for grouping results.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

group the data without sorting on each machine, and then group the data again on the controller.

REDISTRIBUTE

transfer rows between nodes to guarantee ordering within groups. This method is slower.

importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Aliasimport

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=TRUE | FALSE

This parameter is deprecated.

DefaultTRUE
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFALSE
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for functionType="ADD_CONSTANT"

b=double

specifies a constant value for the B channel.

Default0
g=double

specifies a constant value for the G channel.

Default0
r=double

specifies a constant value for the R channel.

Default0

Parameters for functionType="BILATERAL_FILTER"

diameter=64-bit-integer

specifies the diameter of each pixel neighborhood.

sigmaColor=double

specifies the filter sigma in the color space. Larger values affect the farthest colors.

sigmaSpace=double

specifies the filter sigma in the coordinate space. Larger values affect the farthest colors.

Parameters for functionType="BOX_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="BUILD_PYRAMID"

pyrUpDown="PYR_DOWN" | "PYR_UP" | 64-bit-integer

specifies the type of the pyramid operation, downward or upward.

Parameters for functionType="CANNY_EDGE"

highThreshold=double

specifies the upper bound for the threshold.

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
Default3
lowThreshold=double

specifies the lower bound for the threshold.

Parameters for functionType="CONTOURS"

approximate=TRUE | FALSE

when set to True, applies approximation to contours.

DefaultFALSE
boundingBox=TRUE | FALSE

when set to True, creates bounding boxes on contours.

DefaultFALSE
groupBoxes=TRUE | FALSE

when set to True, groups bounding boxes.

DefaultFALSE

Parameters for functionType="CONVERT_COLOR"

type="BGR2HSV" | "BGR2RGB" | "BGR2YUV" | "COLOR2GRAY" | "GRAY2COLOR" | "HSV2BGR" | "RGB2BGR" | "YUV2BGR" | 64-bit-integer

specifies the color conversion code.

Parameters for functionType="CUSTOM_FILTER"

border="BORDER_BLACK" | "BORDER_REFLECT" | "BORDER_REFLECT101" | "BORDER_REPLICATE" | 64-bit-integer

specifies the border method in the convolution.

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelValues=list(double-1 <, double-2, ...>)

specifies values for the custom filter.

kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GAUSSIAN_FILTER"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw

Parameters for functionType="GET_PATCH"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw
x=64-bit-integer

specifies the X location.

Default0
y=64-bit-integer

specifies the Y location.

Default0

Parameters for functionType="HIST_EQUALIZATION"

method="ADAPTIVE" | "GLOBAL" | 64-bit-integer

specifies the histogram equalization method.

Parameters for functionType="LAPLACIAN"

delta=double

specifies the delta value.

Default0
kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="LINEAR_TRANSFORMATION"

method="LOCAL_CONTRAST_NORM" | "STANDARDIZATION" | "WHITENING_PCA" | "WHITENING_ZCA" | 64-bit-integer

specifies the linear transformation method.

Parameters for functionType="MEDIAN_FILTER"

kernelSize=64-bit-integer

specifies the size of the square kernel.

Aliassize

Parameters for functionType="MORPHOLOGY"

kernelHeight=64-bit-integer

specifies the height of a kernel (number of rows).

Aliash
kernelWidth=64-bit-integer

specifies the width of a kernel (number of columns).

Aliasw
method="BLACKHAT" | "CLOSE" | "DILATE" | "ERODE" | "GRADIENT" | "HITMISS" | "OPEN" | "TOPHAT"

specifies the operation to be used in the morphology transformation.

shape="CROSS" | "ELLIPSE" | "RECT"

specifies the shape of the kernel used in the morphology transformation.

Parameters for functionType="MUTATIONS"

type="COLOR_JITTERING" | "COLOR_SHIFTING" | "DARKEN" | "HORIZONTAL_FLIP" | "INVERT_PIXELS" | "LIGHTEN" | "ROTATE_LEFT" | "ROTATE_RIGHT" | "SHARPEN" | "VERTICAL_FLIP" | 64-bit-integer

specifies the mutation type.

Parameters for functionType="NORMALIZE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="HAMMING" | "HAMMING2" | "INF" | "L1" | "L2" | "L2SQR" | "MINMAX" | "RELATIVE" | 64-bit-integer

specifies the function used in normalization.

Parameters for functionType="RESCALE"

alpha=double

specifies the alpha value.

Default1
beta=double

specifies the beta value.

Default0
type="TO_32F" | "TO_64F" | "TO_8U"

specifies the code for determining rescale.

Parameters for functionType="RESIZE"

height=64-bit-integer

specifies the height of an image (number of rows).

Aliash
width=64-bit-integer

specifies the width of an image (number of columns).

Aliasw

Parameters for functionType="SOBEL"

delta=double

specifies the delta value.

Default0
dx=64-bit-integer

specifies the order of the derivative X.

dy=64-bit-integer

specifies the order of the derivative Y.

kernelSize="SIZE1" | "SIZE3" | "SIZE5" | "SIZE7" | 64-bit-integer

specifies the size of the square kernel.

Aliassize
scale=double

specifies the scale value.

Default1

Parameters for functionType="THRESHOLD"

type="BINARY" | "BINARY_INVERSE" | "OTSU" | "TO_ZERO" | "TO_ZERO_INVERSE" | "TRIANGLE" | "TRUNCATE" | 64-bit-integer

specifies the function used in thresholding.

value=double

specifies the threshold value.

Last updated: June 07, 2018