Image Action Set: Syntax

Provides actions for image processing

compareImages Action

Compares images in one CAS table with those in another.

CASL Syntax

image.compareImages <result=results> <status=rc> /

casOut={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

threadBlockSize=64-bit-integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

maximum=double,

method="PSNR" | "SSIM",

minimum=double,

pairAll=TRUE | FALSE,

pairOnPath=TRUE | FALSE,

pairReferenceOn="variable-name",

pairSourceOn="variable-name",

referenceImages={

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table={

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars={{

format="string",

formattedLength=integer,

label="string",

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, ...>}

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

name="table-name"

singlePass=TRUE | FALSE

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

type="variable-name"

separateChannels=TRUE | FALSE,

sourceImages={

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table={

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars={{

format="string",

formattedLength=integer,

label="string",

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, ...>}

name="table-name"

singlePass=TRUE | FALSE

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

type="variable-name"

}

;

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterreferenceImages	required parametertable	specifies the parameter list of the input image table that contains reference images.
required parametersourceImages	required parametertable	specifies the list of parameters for the input image table that contains source images.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
required parametercasOut	—	specifies the settings for an output table.

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).

Alias	outputComparisons

maximum=double

specifies the maximum comparison value to report.

Default	MACBIG

method="PSNR" | "SSIM"

specifies the name of the image comparison method.

Default	SSIM

PSNR

uses the peak signal-to-noise ratio method

SSIM

uses the structural similarity index method

minimum=double

specifies the minimum comparison value to report.

Default	-MACBIG

pairAll=TRUE | FALSE

when set to True, compares all images from the source table with all images from the reference table.

Default	FALSE

pairOnPath=TRUE | FALSE

when set to True, specifies that the pairing variables are file paths.

Alias	isPairVariablePath
Default	TRUE

pairReferenceOn="variable-name"

specifies the name of the column in the reference images table that contains the pairing variable.

Alias	referencePairVariable
Default	"_path_"

pairSourceOn="variable-name"

specifies the name of the column in the source images table that contains the pairing variable.

Alias	sourcePairVariable
Default	"_path_"

* referenceImages={imageTableIn}

specifies the parameter list of the input image table that contains reference images.

Alias	referenceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table={castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	FALSE

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

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	FALSE

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.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

separateChannels=TRUE | FALSE

when set to True, compares each channel separately.

Default	TRUE

* sourceImages={imageTableIn}

specifies the list of parameters for the input image table that contains source images.

Alias	sourceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table={castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	FALSE

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.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

compareImages Action

Compares images in one CAS table with those in another.

Lua Syntax

results, info = s:image_compareImages{

casOut={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

onDemand=true | false,

promote=true | false,

replace=true | false,

replication=integer,

threadBlockSize=64-bit-integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

maximum=double,

method="PSNR" | "SSIM",

minimum=double,

pairAll=true | false,

pairOnPath=true | false,

pairReferenceOn="variable-name",

pairSourceOn="variable-name",

referenceImages={

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table={

caslib="string"

computedOnDemand=true | false

computedVars={{

format="string",

formattedLength=integer,

label="string",

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, ...>}

name="table-name"

singlePass=true | false

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

type="variable-name"

separateChannels=true | false,

sourceImages={

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table={

caslib="string"

computedOnDemand=true | false

computedVars={{

format="string",

formattedLength=integer,

label="string",

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, ...>}

name="table-name"

singlePass=true | false

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

type="variable-name"

}

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterreferenceImages	required parametertable	specifies the parameter list of the input image table that contains reference images.
required parametersourceImages	required parametertable	specifies the list of parameters for the input image table that contains source images.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
required parametercasOut	—	specifies the settings for an output table.

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).

Alias	outputComparisons

maximum=double

specifies the maximum comparison value to report.

Default	MACBIG

method="PSNR" | "SSIM"

specifies the name of the image comparison method.

Default	SSIM

PSNR

uses the peak signal-to-noise ratio method

SSIM

uses the structural similarity index method

minimum=double

specifies the minimum comparison value to report.

Default	-MACBIG

pairAll=true | false

when set to True, compares all images from the source table with all images from the reference table.

Default	false

pairOnPath=true | false

when set to True, specifies that the pairing variables are file paths.

Alias	isPairVariablePath
Default	true

pairReferenceOn="variable-name"

specifies the name of the column in the reference images table that contains the pairing variable.

Alias	referencePairVariable
Default	"_path_"

pairSourceOn="variable-name"

specifies the name of the column in the source images table that contains the pairing variable.

Alias	sourcePairVariable
Default	"_path_"

* referenceImages={imageTableIn}

specifies the parameter list of the input image table that contains reference images.

Alias	referenceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table={castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	false

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

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	false

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.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

separateChannels=true | false

when set to True, compares each channel separately.

Default	true

* sourceImages={imageTableIn}

specifies the list of parameters for the input image table that contains source images.

Alias	sourceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table={castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	false

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

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	false

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.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

compareImages Action

Compares images in one CAS table with those in another.

Python Syntax

results= s.image.compareImages(

casOut={

"caslib":"string",

"compress":True | False,

"indexVars":["variable-name-1" <, "variable-name-2", ...>],

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"onDemand":True | False,

"promote":True | False,

"replace":True | False,

"replication":integer,

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

"where":["string-1" <, "string-2", ...>]

maximum=double,

method="PSNR" | "SSIM",

minimum=double,

pairAll=True | False,

pairOnPath=True | False,

pairReferenceOn="variable-name",

pairSourceOn="variable-name",

referenceImages={

"dimension":"variable-name",

"id":"variable-name",

"image":"variable-name",

"imageFormat":"variable-name",

"label":"variable-name",

"path":"variable-name",

"resolution":"variable-name",

"size":"variable-name",

"table":{

"caslib":"string"

"computedOnDemand"=True | False

"computedVars"=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"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}, ...>}

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

"name":"table-name"

"singlePass":True | False

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

"whereTable":{

"casLib":"string"

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

"type":"variable-name"

separateChannels=True | False,

sourceImages={

"dimension":"variable-name",

"id":"variable-name",

"image":"variable-name",

"imageFormat":"variable-name",

"label":"variable-name",

"path":"variable-name",

"resolution":"variable-name",

"size":"variable-name",

"table":{

"caslib":"string"

"computedOnDemand"=True | False

"computedVars"=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"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}, ...>}

"name":"table-name"

"singlePass":True | False

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

"type":"variable-name"

}

)

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterreferenceImages	required parametertable	specifies the parameter list of the input image table that contains reference images.
required parametersourceImages	required parametertable	specifies the list of parameters for the input image table that contains source images.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
required parametercasOut	—	specifies the settings for an output table.

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).

Alias	outputComparisons

maximum=double

specifies the maximum comparison value to report.

Default	MACBIG

method="PSNR" | "SSIM"

specifies the name of the image comparison method.

Default	SSIM

PSNR

uses the peak signal-to-noise ratio method

SSIM

uses the structural similarity index method

minimum=double

specifies the minimum comparison value to report.

Default	-MACBIG

pairAll=True | False

when set to True, compares all images from the source table with all images from the reference table.

Default	False

pairOnPath=True | False

when set to True, specifies that the pairing variables are file paths.

Alias	isPairVariablePath
Default	True

pairReferenceOn="variable-name"

specifies the name of the column in the reference images table that contains the pairing variable.

Alias	referencePairVariable
Default	"_path_"

pairSourceOn="variable-name"

specifies the name of the column in the source images table that contains the pairing variable.

Alias	sourcePairVariable
Default	"_path_"

* referenceImages={imageTableIn}

specifies the parameter list of the input image table that contains reference images.

Alias	referenceImage

The imageTableIn value can be one or more of the following:

"dimension":"variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

"id":"variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

"image":"variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

"imageFormat":"variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

"label":"variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

"path":"variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

"resolution":"variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

"size":"variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* "table":{castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	False

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

Alias	compVars

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

"computedVarsProgram":"string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import_

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

* "name":"table-name"

specifies the name of the input table.

"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.

Default	False

"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.

"whereTable":{groupbytable}

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import_

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

* "name":"table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

"type":"variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

separateChannels=True | False

when set to True, compares each channel separately.

Default	True

* sourceImages={imageTableIn}

specifies the list of parameters for the input image table that contains source images.

Alias	sourceImage

The imageTableIn value can be one or more of the following:

"dimension":"variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

"id":"variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

"image":"variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

"imageFormat":"variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

"label":"variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

"path":"variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

"resolution":"variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

"size":"variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* "table":{castable}

specifies the input table that contains image data.

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	False

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

Alias	compVars

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

"computedVarsProgram":"string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import_

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

* "name":"table-name"

specifies the name of the input table.

"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.

Default	False

"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.

"whereTable":{groupbytable}

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import_

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

* "name":"table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

"type":"variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

compareImages Action

Compares images in one CAS table with those in another.

R Syntax

results <– cas.image.compareImages(s,

casOut=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

threadBlockSize=64-bit-integer,

timeStamp="string",

where=list("string-1" <, "string-2", ...>)

maximum=double,

method="PSNR" | "SSIM",

minimum=double,

pairAll=TRUE | FALSE,

pairOnPath=TRUE | FALSE,

pairReferenceOn="variable-name",

pairSourceOn="variable-name",

referenceImages=list(

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table=list(

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

computedVarsProgram="string"

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

name="table-name"

singlePass=TRUE | FALSE

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

type="variable-name"

separateChannels=TRUE | FALSE,

sourceImages=list(

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

path="variable-name",

resolution="variable-name",

size="variable-name",

table=list(

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

computedVarsProgram="string"

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

name="table-name"

singlePass=TRUE | FALSE

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

type="variable-name"

)

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterreferenceImages	required parametertable	specifies the parameter list of the input image table that contains reference images.
required parametersourceImages	required parametertable	specifies the list of parameters for the input image table that contains source images.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
required parametercasOut	—	specifies the settings for an output table.

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).

Alias	outputComparisons

maximum=double

specifies the maximum comparison value to report.

Default	MACBIG

method="PSNR" | "SSIM"

specifies the name of the image comparison method.

Default	SSIM

PSNR

uses the peak signal-to-noise ratio method

SSIM

uses the structural similarity index method

minimum=double

specifies the minimum comparison value to report.

Default	-MACBIG

pairAll=TRUE | FALSE

when set to True, compares all images from the source table with all images from the reference table.

Default	FALSE

pairOnPath=TRUE | FALSE

when set to True, specifies that the pairing variables are file paths.

Alias	isPairVariablePath
Default	TRUE

pairReferenceOn="variable-name"

specifies the name of the column in the reference images table that contains the pairing variable.

Alias	referencePairVariable
Default	"_path_"

pairSourceOn="variable-name"

specifies the name of the column in the source images table that contains the pairing variable.

Alias	sourcePairVariable
Default	"_path_"

* referenceImages=list(imageTableIn)

specifies the parameter list of the input image table that contains reference images.

Alias	referenceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table=list(castable)

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	FALSE

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.

whereTable=list(groupbytable)

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

separateChannels=TRUE | FALSE

when set to True, compares each channel separately.

Default	TRUE

* sourceImages=list(imageTableIn)

specifies the list of parameters for the input image table that contains source images.

Alias	sourceImage

The imageTableIn value can be one or more of the following:

dimension="variable-name"

specifies the name of the column that contains dimensions of images.

Alias	dimensionVar
Default	"_dimension_"

id="variable-name"

specifies the name of the variable that identifies each image.

Alias	idVar
Default	"_id_"

image="variable-name"

specifies the name of the column that contains image binaries.

Alias	imageVar
Default	"_image_"

imageFormat="variable-name"

specifies the name of the column that contains formats of image binaries.

Alias	imageFormatVar
Default	"_imageFormat_"

label="variable-name"

specifies the name of the column that contains labels of images.

Alias	labelVar
Default	"_label_"

path="variable-name"

specifies the name of the column that contains file paths.

Alias	pathVar
Default	"_path_"

resolution="variable-name"

specifies the name of the column that contains resolutions of images.

Alias	resolutionVar
Default	"_resolution_"

size="variable-name"

specifies the name of the column that contains byte lengths of image binaries.

Alias	sizeVar
Default	"_size_"

* table=list(castable)

specifies the input table that contains image data.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input 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.

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Alias	options, dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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.

Default	FALSE

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.

whereTable=list(groupbytable)

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Alias	options, dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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 data from the filter table.

type="variable-name"

specifies the name of the column that contains the image type, which is shown as jpg, bmp, and so on.

Alias	typeVar
Default	"_type_"

Last updated: November 11, 2020