Image Action Set: Syntax
Provides actions for image processing
fetchImages Action
Fetch images for displaying.
CASL Syntax
Summary: Input 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the table name, caslib, and other common parameters. |
Parameter Descriptions
fetchImagesVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the variables to copy from the input table to the output table.
| Alias | fetchVars |
|---|
from=64-bit-integer
specifies the ordinal position of the first row to return.
| Default | 0 |
|---|
image="variable-name"
specifies the name of the column that contains image binaries.
| Alias | imageVar |
|---|---|
| Default | "_image_" |
seed=64-bit-integer
specifies a seed for writing images randomly.
| Default | 0 |
|---|
sortBy={{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>}
specifies the variables and variable settings for sorting results.
| Alias | orderBy |
|---|
The fetchorderbyelement value can be one or more of the following:
formatted="FORMATTED" | "RAW"
specifies whether the variables are formatted or use raw values.
| Default | RAW |
|---|
* name="variable-name"
specifies the name of the variable to use for sorting.
order="ASCENDING" | "DESCENDING"
specifies whether the variables are ordered in ascending or descending order.
| Default | ASCENDING |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
| Alias | imageTable |
|---|
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.
to=64-bit-integer
specifies the ordinal position of the last image row to return.
| Default | 20 |
|---|---|
| Minimum value | 0 |
fetchImages Action
Fetch images for displaying.
Lua Syntax
Summary: Input 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the table name, caslib, and other common parameters. |
Parameter Descriptions
fetchImagesVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the variables to copy from the input table to the output table.
| Alias | fetchVars |
|---|
from=64-bit-integer
specifies the ordinal position of the first row to return.
| Default | 0 |
|---|
image="variable-name"
specifies the name of the column that contains image binaries.
| Alias | imageVar |
|---|---|
| Default | "_image_" |
seed=64-bit-integer
specifies a seed for writing images randomly.
| Default | 0 |
|---|
sortBy={{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>}
specifies the variables and variable settings for sorting results.
| Alias | orderBy |
|---|
The fetchorderbyelement value can be one or more of the following:
formatted="FORMATTED" | "RAW"
specifies whether the variables are formatted or use raw values.
| Default | RAW |
|---|
* name="variable-name"
specifies the name of the variable to use for sorting.
order="ASCENDING" | "DESCENDING"
specifies whether the variables are ordered in ascending or descending order.
| Default | ASCENDING |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
| Alias | imageTable |
|---|
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.
to=64-bit-integer
specifies the ordinal position of the last image row to return.
| Default | 20 |
|---|---|
| Minimum value | 0 |
fetchImages Action
Fetch images for displaying.
Python Syntax
Summary: Input 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the table name, caslib, and other common parameters. |
Parameter Descriptions
fetchImagesVars=["variable-name-1" <, "variable-name-2", ...>]
specifies the variables to copy from the input table to the output table.
| Alias | fetchVars |
|---|
from_=64-bit-integer
specifies the ordinal position of the first row to return.
| Default | 0 |
|---|
image="variable-name"
specifies the name of the column that contains image binaries.
| Alias | imageVar |
|---|---|
| Default | "_image_" |
seed=64-bit-integer
specifies a seed for writing images randomly.
| Default | 0 |
|---|
sortBy=[{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>]
specifies the variables and variable settings for sorting results.
| Alias | orderBy |
|---|
The fetchorderbyelement value can be one or more of the following:
"formatted":"FORMATTED" | "RAW"
specifies whether the variables are formatted or use raw values.
| Default | RAW |
|---|
* "name":"variable-name"
specifies the name of the variable to use for sorting.
"order":"ASCENDING" | "DESCENDING"
specifies whether the variables are ordered in ascending or descending order.
| Default | ASCENDING |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={"name":"table-name"} |
|---|---|
| Shortcut form | table="table-name" |
| Alias | imageTable |
|---|
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.
to=64-bit-integer
specifies the ordinal position of the last image row to return.
| Default | 20 |
|---|---|
| Minimum value | 0 |
fetchImages Action
Fetch images for displaying.
R Syntax
Summary: Input 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the table name, caslib, and other common parameters. |
Parameter Descriptions
fetchImagesVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the variables to copy from the input table to the output table.
| Alias | fetchVars |
|---|
from=64-bit-integer
specifies the ordinal position of the first row to return.
| Default | 0 |
|---|
image="variable-name"
specifies the name of the column that contains image binaries.
| Alias | imageVar |
|---|---|
| Default | "_image_" |
seed=64-bit-integer
specifies a seed for writing images randomly.
| Default | 0 |
|---|
sortBy=list( list(fetchorderbyelement-1) <, list(fetchorderbyelement-2), ...>)
specifies the variables and variable settings for sorting results.
| Alias | orderBy |
|---|
The fetchorderbyelement value can be one or more of the following:
formatted="FORMATTED" | "RAW"
specifies whether the variables are formatted or use raw values.
| Default | RAW |
|---|
* name="variable-name"
specifies the name of the variable to use for sorting.
order="ASCENDING" | "DESCENDING"
specifies whether the variables are ordered in ascending or descending order.
| Default | ASCENDING |
|---|
* table=list(castable)
specifies the table name, caslib, and other common parameters.
| Long form | table=list(name="table-name") |
|---|---|
| Shortcut form | table="table-name" |
| Alias | imageTable |
|---|
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), ...>)
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=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)
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=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.
to=64-bit-integer
specifies the ordinal position of the last image row to return.
| Default | 20 |
|---|---|
| Minimum value | 0 |