Image Action Set: Syntax
Provides actions for image processing
fetchImages Action
Fetch images for displaying.
CASL Syntax
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.
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.
The fetchorderbyelement value can be one or more of the following:
| Alias | orderBy |
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.
| Alias | imageTable |
| Long form | table={name="table-name"} |
| Shortcut form | table="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.
| 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.
| Alias | compVars |
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.
| 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 |
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"
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.
| Alias | import |
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.
| Default | TRUE |
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.
| 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.
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
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.
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.
The fetchorderbyelement value can be one or more of the following:
| Alias | orderBy |
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.
| Alias | imageTable |
| Long form | table={name="table-name"} |
| Shortcut form | table="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.
| 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.
| Alias | compVars |
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.
| 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 |
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"
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.
| Alias | import |
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.
| Default | true |
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.
| 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.
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
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.
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.
The fetchorderbyelement value can be one or more of the following:
| Alias | orderBy |
"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.
| Alias | imageTable |
| Long form | table={"name":"table-name"} |
| Shortcut form | table="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.
| 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.
| Alias | compVars |
"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.
| 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 |
"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"
"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.
| Alias | import_ |
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.
| Default | True |
"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.
| 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.
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
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.
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.
The fetchorderbyelement value can be one or more of the following:
| Alias | orderBy |
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.
| Alias | imageTable |
| Long form | table=list(name="table-name") |
| Shortcut form | table="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.
| 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.
| Alias | compVars |
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.
| 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 |
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"
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.
| Alias | import |
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.
| Default | TRUE |
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.
| 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.
to=64-bit-integer
specifies the ordinal position of the last image row to return.
| Default | 20 |
| Minimum value | 0 |