BioMedImage Action Set: Syntax

Provides actions for biomedical image processing

buildSurface Action

Builds surfaces from 3-D biomedical images.

CASL Syntax

bioMedImage.buildSurface <result=results> <status=rc> /
required parameter 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",
required parameter table={
caslib="string"
computedOnDemand=TRUE | FALSE
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter 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}
required parameter name="table-name"
onDemand=TRUE | FALSE
singlePass=TRUE | FALSE
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
},
type="variable-name"
}
intensities={double-1 <, double-2, ...>}
required parameter outputFaces={
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", ...>}
}
required parameter outputVertices={
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", ...>}
}
thresholds={{
high=double,
low=double
}, {...}}
;

Parameter Descriptions

* images={biomedimageTableIn}

specifies the parameter list of input image table.

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

intensities={double-1 <, double-2, ...>}

specifies the intensity values of desired regions.

* outputFaces={casouttable}

specifies the output table containing surface faces.

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

* outputVertices={casouttable}

specifies the output table containing surface vertices.

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

smoothing={binarySmoothingParms}

specifies the parameters for smoothing.

iterations=integer

specifies the maximum number of smoothing iterations.

Default0
Minimum value1
relaxationFactor=double

specifies the degree of smoothing in each iteration.

Default1
Range0–1

thresholds={{buildSurfaceThresholds-1} <, {buildSurfaceThresholds-2}, ...>}

specifies the threshold values of desired regions.

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

high=double

specifies the high threshold.

DefaultMACBIG
low=double

specifies the low threshold.

Default-MACBIG

buildSurface Action

Builds surfaces from 3-D biomedical images.

Lua Syntax

results, info = s:bioMedImage_buildSurface{
required parameter 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",
required parameter table={
caslib="string"
computedOnDemand=true | false
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter 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}
required parameter name="table-name"
onDemand=true | false
singlePass=true | false
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
},
type="variable-name"
},
intensities={double-1 <, double-2, ...>},
required parameter outputFaces={
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", ...>}
},
required parameter outputVertices={
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", ...>}
},
thresholds={{
high=double,
low=double
}, {...}}
}

Parameter Descriptions

* images={biomedimageTableIn}

specifies the parameter list of input image table.

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

intensities={double-1 <, double-2, ...>}

specifies the intensity values of desired regions.

* outputFaces={casouttable}

specifies the output table containing surface faces.

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

* outputVertices={casouttable}

specifies the output table containing surface vertices.

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

smoothing={binarySmoothingParms}

specifies the parameters for smoothing.

iterations=integer

specifies the maximum number of smoothing iterations.

Default0
Minimum value1
relaxationFactor=double

specifies the degree of smoothing in each iteration.

Default1
Range0–1

thresholds={{buildSurfaceThresholds-1} <, {buildSurfaceThresholds-2}, ...>}

specifies the threshold values of desired regions.

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

high=double

specifies the high threshold.

DefaultMACBIG
low=double

specifies the low threshold.

Default-MACBIG

buildSurface Action

Builds surfaces from 3-D biomedical images.

Python Syntax

results= s.bioMedImage.buildSurface(
required parameter 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",
required parameter "table":{
"caslib":"string"
"computedOnDemand"=True | False
"computedVars"=[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "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}
required parameter "name":"table-name"
"onDemand":True | False
"singlePass":True | False
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
},
"type":"variable-name"
},
intensities=[double-1 <, double-2, ...>],
required parameter outputFaces={
"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", ...>]
},
required parameter outputVertices={
"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", ...>]
},
smoothing={
"iterations":integer,
},
thresholds=[{
"high":double,
"low":double
}<, {...}>]
)

Parameter Descriptions

* images={biomedimageTableIn}

specifies the parameter list of input image table.

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

intensities=[double-1 <, double-2, ...>]

specifies the intensity values of desired regions.

* outputFaces={casouttable}

specifies the output table containing surface faces.

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

* outputVertices={casouttable}

specifies the output table containing surface vertices.

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

smoothing={binarySmoothingParms}

specifies the parameters for smoothing.

"iterations":integer

specifies the maximum number of smoothing iterations.

Default0
Minimum value1
"relaxationFactor":double

specifies the degree of smoothing in each iteration.

Default1
Range0–1

thresholds=[{buildSurfaceThresholds-1} <, {buildSurfaceThresholds-2}, ...>]

specifies the threshold values of desired regions.

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

"high":double

specifies the high threshold.

DefaultMACBIG
"low":double

specifies the low threshold.

Default-MACBIG

buildSurface Action

Builds surfaces from 3-D biomedical images.

R Syntax

results <– cas.bioMedImage.buildSurface(s,
required parameter 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",
required parameter table=list(
caslib="string"
computedOnDemand=TRUE | FALSE
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter 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), ...>)
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
onDemand=TRUE | FALSE
singlePass=TRUE | FALSE
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
),
type="variable-name"
),
intensities=list(double-1 <, double-2, ...>),
required parameter outputFaces=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", ...>)
),
required parameter outputVertices=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", ...>)
),
smoothing=list(
iterations=integer,
),
thresholds=list( list(
high=double,
low=double
) <, list(...)>)
)

Parameter Descriptions

* images=list(biomedimageTableIn)

specifies the parameter list of input image table.

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

intensities=list(double-1 <, double-2, ...>)

specifies the intensity values of desired regions.

* outputFaces=list(casouttable)

specifies the output table containing surface faces.

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

* outputVertices=list(casouttable)

specifies the output table containing surface vertices.

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

smoothing=list(binarySmoothingParms)

specifies the parameters for smoothing.

iterations=integer

specifies the maximum number of smoothing iterations.

Default0
Minimum value1
relaxationFactor=double

specifies the degree of smoothing in each iteration.

Default1
Range0–1

thresholds=list( list(buildSurfaceThresholds-1) <, list(buildSurfaceThresholds-2), ...>)

specifies the threshold values of desired regions.

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

high=double

specifies the high threshold.

DefaultMACBIG
low=double

specifies the low threshold.

Default-MACBIG
Last updated: June 07, 2018