Image Action Set

Provides actions for image processing

saveImages Action

Writes images contained in a CAS table to disk.

CASL Syntax

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

caslib="string",

convert=TRUE | FALSE,

images={

bioMedDimension="variable-name",

bioMedId="variable-name",

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

orientation="variable-name",

path="variable-name",

position="variable-name",

resolution="variable-name",

size="variable-name",

sliceIndex="variable-name",

spacing="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"

onDemand=TRUE | FALSE

singlePass=TRUE | FALSE

where="where-expression"

whereTable={

casLib="string"

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-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"

labelLevels=integer,

overwrite=TRUE | FALSE,

prefix="string",

series={

digits=integer,

start=integer

subdirectory="string",

suffix="string",

type="string"

;

indicates a required parameter

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.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterimages	required parametertable	specifies the list of parameters that describe the input image table.

Parameter Descriptions

caslib="string"

specifies the name of the caslib to save images to.

convert=TRUE | FALSE

when set to True, allows image depth to be changed for saving.

Default	TRUE

* images={biomedimageTableIn}

specifies the list of parameters that describe the input image table.

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

Alias	image

labelLevels=integer

specifies the maximum number of directory levels to save from the label.

Default	0

overwrite=TRUE | FALSE

when set to True, allows existing files to be overwritten.

Default	TRUE

prefix="string"

specifies the string to be added as a prefix to file names.

series={saveSeriesParms}

specifies the parameters to be used to save images as series.

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

digits=integer

specifies the minimum number of digits in the numeric part of the series file names.

Default	4
Range	1–BMICORE_SERIES_MAX_DIGITS

start=integer

specifies the starting index for the numeric part of the series file names.

Default	0
Minimum value	0

subdirectory="string"

specifies the name of the subdirectory relative to the caslib root to which to write images.

suffix="string"

specifies the string to be added as a suffix to file names.

type="string"

specifies the type of images to be written such as JPG, PNG, or any other supported format.

saveImages Action

Writes images contained in a CAS table to disk.

Lua Syntax

results, info = s:image_saveImages{

caslib="string",

convert=true | false,

images={

bioMedDimension="variable-name",

bioMedId="variable-name",

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

orientation="variable-name",

path="variable-name",

position="variable-name",

resolution="variable-name",

size="variable-name",

sliceIndex="variable-name",

spacing="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"

onDemand=true | false

singlePass=true | false

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"

labelLevels=integer,

overwrite=true | false,

prefix="string",

series={

digits=integer,

start=integer

subdirectory="string",

suffix="string",

type="string"

}

indicates a required parameter

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.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterimages	required parametertable	specifies the list of parameters that describe the input image table.

Parameter Descriptions

caslib="string"

specifies the name of the caslib to save images to.

convert=true | false

when set to True, allows image depth to be changed for saving.

Default	true

* images={biomedimageTableIn}

specifies the list of parameters that describe the input image table.

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

Alias	image

labelLevels=integer

specifies the maximum number of directory levels to save from the label.

Default	0

overwrite=true | false

when set to True, allows existing files to be overwritten.

Default	true

prefix="string"

specifies the string to be added as a prefix to file names.

series={saveSeriesParms}

specifies the parameters to be used to save images as series.

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

digits=integer

specifies the minimum number of digits in the numeric part of the series file names.

Default	4
Range	1–BMICORE_SERIES_MAX_DIGITS

start=integer

specifies the starting index for the numeric part of the series file names.

Default	0
Minimum value	0

subdirectory="string"

specifies the name of the subdirectory relative to the caslib root to which to write images.

suffix="string"

specifies the string to be added as a suffix to file names.

type="string"

specifies the type of images to be written such as JPG, PNG, or any other supported format.

saveImages Action

Writes images contained in a CAS table to disk.

Python Syntax

results= s.image.saveImages(

caslib="string",

convert=True | False,

images={

"bioMedDimension":"variable-name",

"bioMedId":"variable-name",

"dimension":"variable-name",

"id":"variable-name",

"image":"variable-name",

"imageFormat":"variable-name",

"label":"variable-name",

"orientation":"variable-name",

"path":"variable-name",

"position":"variable-name",

"resolution":"variable-name",

"size":"variable-name",

"sliceIndex":"variable-name",

"spacing":"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"

"onDemand":True | False

"singlePass":True | False

"where":"where-expression"

"whereTable":{

"casLib":"string"

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-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"

labelLevels=integer,

overwrite=True | False,

prefix="string",

series={

"digits":integer,

"start":integer

subdirectory="string",

suffix="string",

type="string"

)

indicates a required parameter

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.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterimages	required parametertable	specifies the list of parameters that describe the input image table.

Parameter Descriptions

caslib="string"

specifies the name of the caslib to save images to.

convert=True | False

when set to True, allows image depth to be changed for saving.

Default	True

* images={biomedimageTableIn}

specifies the list of parameters that describe the input image table.

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

Alias	image

labelLevels=integer

specifies the maximum number of directory levels to save from the label.

Default	0

overwrite=True | False

when set to True, allows existing files to be overwritten.

Default	True

prefix="string"

specifies the string to be added as a prefix to file names.

series={saveSeriesParms}

specifies the parameters to be used to save images as series.

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

"digits":integer

specifies the minimum number of digits in the numeric part of the series file names.

Default	4
Range	1–BMICORE_SERIES_MAX_DIGITS

"start":integer

specifies the starting index for the numeric part of the series file names.

Default	0
Minimum value	0

subdirectory="string"

specifies the name of the subdirectory relative to the caslib root to which to write images.

suffix="string"

specifies the string to be added as a suffix to file names.

type="string"

specifies the type of images to be written such as JPG, PNG, or any other supported format.

saveImages Action

Writes images contained in a CAS table to disk.

R Syntax

results <– cas.image.saveImages(s,

caslib="string",

convert=TRUE | FALSE,

images=list(

bioMedDimension="variable-name",

bioMedId="variable-name",

dimension="variable-name",

id="variable-name",

image="variable-name",

imageFormat="variable-name",

label="variable-name",

orientation="variable-name",

path="variable-name",

position="variable-name",

resolution="variable-name",

size="variable-name",

sliceIndex="variable-name",

spacing="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"

onDemand=TRUE | FALSE

singlePass=TRUE | FALSE

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"

labelLevels=integer,

overwrite=TRUE | FALSE,

prefix="string",

series=list(

digits=integer,

start=integer

subdirectory="string",

suffix="string",

type="string"

)

indicates a required parameter

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.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parameterimages	required parametertable	specifies the list of parameters that describe the input image table.

Parameter Descriptions

caslib="string"

specifies the name of the caslib to save images to.

convert=TRUE | FALSE

when set to True, allows image depth to be changed for saving.

Default	TRUE

* images=list(biomedimageTableIn)

specifies the list of parameters that describe the input image table.

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

Alias	image

labelLevels=integer

specifies the maximum number of directory levels to save from the label.

Default	0

overwrite=TRUE | FALSE

when set to True, allows existing files to be overwritten.

Default	TRUE

prefix="string"

specifies the string to be added as a prefix to file names.

series=list(saveSeriesParms)

specifies the parameters to be used to save images as series.

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

digits=integer

specifies the minimum number of digits in the numeric part of the series file names.

Default	4
Range	1–BMICORE_SERIES_MAX_DIGITS

start=integer

specifies the starting index for the numeric part of the series file names.

Default	0
Minimum value	0

subdirectory="string"

specifies the name of the subdirectory relative to the caslib root to which to write images.

suffix="string"

specifies the string to be added as a suffix to file names.

type="string"

specifies the type of images to be written such as JPG, PNG, or any other supported format.

Last updated: September 15, 2022