Image Action Set: Syntax

Provides actions for image processing

extractDetectedObjects Action

Extracts object detections..

CASL Syntax

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

casOut={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

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

}

coordType="COCO" | "RECT" | "YOLO"

extractType="CROP" | "HIGHLIGHT"

image="variable-name"

maxObjects=64-bit-integer

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS"

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="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=TRUE | FALSE,

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

}

;

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

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

coordType="COCO" | "RECT" | "YOLO"

specifies the type of input format to use for the bounding boxes around the detected objects.

Default

RECT

COCO

uses the Common Objects in Context format for the coordinates of a bounding box around an object detection.

RECT

uses the rectangular format for the coordinates of a bounding box around an object detection.

YOLO

uses the "you only look once" format for the coordinates of a bounding box around an object detection.

extractType="CROP" | "HIGHLIGHT"

specifies the type of extract action to perform.

Default

HIGHLIGHT

CROP

performs the crop action while extracting object detections.

HIGHLIGHT

performs the highlight action while extracting object detections.

image="variable-name"

specifies the name of the column that contains image binaries.

maxObjects=64-bit-integer

specifies the maximum number of detected objects to extract from the image data in the input table.

Default	10
Minimum value	0

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS"

specifies whether to save the cropped detections from a single image in multiple columns and one row or in one column and multiple rows in the output table.

Default

MULTIPLE_ROWS

MULTIPLE_COLUMNS

saves the cropped object detections in multiple columns and one row in the output table.

MULTIPLE_ROWS

saves the cropped object detections in one column and multiple rows in the output table.

* 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

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

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.

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.

where="where-expression"

specifies an expression for subsetting the input data.

extractDetectedObjects Action

Extracts object detections..

Lua Syntax

results, info = s:image_extractDetectedObjects{

casOut={

caslib="string",

compress=true | false,

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

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=true | false,

promote=true | false,

replace=true | false,

replication=integer,

timeStamp="string",

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

coordType="COCO" | "RECT" | "YOLO",

extractType="CROP" | "HIGHLIGHT",

image="variable-name",

maxObjects=64-bit-integer,

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS",

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="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=true | false,

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

}

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

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

coordType="COCO" | "RECT" | "YOLO"

specifies the type of input format to use for the bounding boxes around the detected objects.

Default

RECT

COCO

uses the Common Objects in Context format for the coordinates of a bounding box around an object detection.

RECT

uses the rectangular format for the coordinates of a bounding box around an object detection.

YOLO

uses the "you only look once" format for the coordinates of a bounding box around an object detection.

extractType="CROP" | "HIGHLIGHT"

specifies the type of extract action to perform.

Default

HIGHLIGHT

CROP

performs the crop action while extracting object detections.

HIGHLIGHT

performs the highlight action while extracting object detections.

image="variable-name"

specifies the name of the column that contains image binaries.

maxObjects=64-bit-integer

specifies the maximum number of detected objects to extract from the image data in the input table.

Default	10
Minimum value	0

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS"

specifies whether to save the cropped detections from a single image in multiple columns and one row or in one column and multiple rows in the output table.

Default

MULTIPLE_ROWS

MULTIPLE_COLUMNS

saves the cropped object detections in multiple columns and one row in the output table.

MULTIPLE_ROWS

saves the cropped object detections in one column and multiple rows in the output table.

* 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

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

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.

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.

where="where-expression"

specifies an expression for subsetting the input data.

extractDetectedObjects Action

Extracts object detections..

Python Syntax

results= s.image.extractDetectedObjects(

casOut={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"maxMemSize":64-bit-integer,

"name":"table-name",

"onDemand":True | False,

"promote":True | False,

"replace":True | False,

"replication":integer,

"timeStamp":"string",

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

coordType="COCO" | "RECT" | "YOLO",

extractType="CROP" | "HIGHLIGHT",

image="variable-name",

maxObjects=64-bit-integer,

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS",

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":"AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

"name":"table-name",

"onDemand":True | False,

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression"

}

)

Parameter Descriptions

* casOut={casouttable}

specifies the settings for an output table.

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

coordType="COCO" | "RECT" | "YOLO"

specifies the type of input format to use for the bounding boxes around the detected objects.

Default

RECT

COCO

uses the Common Objects in Context format for the coordinates of a bounding box around an object detection.

RECT

uses the rectangular format for the coordinates of a bounding box around an object detection.

YOLO

uses the "you only look once" format for the coordinates of a bounding box around an object detection.

extractType="CROP" | "HIGHLIGHT"

specifies the type of extract action to perform.

Default

HIGHLIGHT

CROP

performs the crop action while extracting object detections.

HIGHLIGHT

performs the highlight action while extracting object detections.

image="variable-name"

specifies the name of the column that contains image binaries.

maxObjects=64-bit-integer

specifies the maximum number of detected objects to extract from the image data in the input table.

Default	10
Minimum value	0

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS"

specifies whether to save the cropped detections from a single image in multiple columns and one row or in one column and multiple rows in the output table.

Default

MULTIPLE_ROWS

MULTIPLE_COLUMNS

saves the cropped object detections in multiple columns and one row in the output table.

MULTIPLE_ROWS

saves the cropped object detections in one column and multiple rows in the output table.

* 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

"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

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

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

"where":"where-expression"

specifies an expression for subsetting the input data.

extractDetectedObjects Action

Extracts object detections..

R Syntax

results <– cas.image.extractDetectedObjects(s,

casOut=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

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

coordType="COCO" | "RECT" | "YOLO",

extractType="CROP" | "HIGHLIGHT",

image="variable-name",

maxObjects=64-bit-integer,

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS",

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

onDemand=TRUE | FALSE,

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

where="where-expression"

)

Parameter Descriptions

* casOut=list(casouttable)

specifies the settings for an output table.

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

coordType="COCO" | "RECT" | "YOLO"

specifies the type of input format to use for the bounding boxes around the detected objects.

Default

RECT

COCO

uses the Common Objects in Context format for the coordinates of a bounding box around an object detection.

RECT

uses the rectangular format for the coordinates of a bounding box around an object detection.

YOLO

uses the "you only look once" format for the coordinates of a bounding box around an object detection.

extractType="CROP" | "HIGHLIGHT"

specifies the type of extract action to perform.

Default

HIGHLIGHT

CROP

performs the crop action while extracting object detections.

HIGHLIGHT

performs the highlight action while extracting object detections.

image="variable-name"

specifies the name of the column that contains image binaries.

maxObjects=64-bit-integer

specifies the maximum number of detected objects to extract from the image data in the input table.

Default	10
Minimum value	0

outputFormat="MULTIPLE_COLUMNS" | "MULTIPLE_ROWS"

specifies whether to save the cropped detections from a single image in multiple columns and one row or in one column and multiple rows in the output table.

Default

MULTIPLE_ROWS

MULTIPLE_COLUMNS

saves the cropped object detections in multiple columns and one row in the output table.

MULTIPLE_ROWS

saves the cropped object detections in one column and multiple rows in the output table.

* 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

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

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.

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.

where="where-expression"

specifies an expression for subsetting the input data.

Last updated: June 07, 2018