Image Action Set
Provides actions for image processing
loadImages Action
Loads images.
Summary: Output 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 parametercasOut |
— |
specifies the settings for an output table. |
Parameter Descriptions
addColumns={"CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"} | {extendedAddColumnsParms}
specifies extra columns to add to the output table.
The extendedAddColumnsParms value can be one or more of the following:
dicomAttributes={dicomAttributesParms}
specifies parameters related to DICOM attributes.
The dicomAttributesParms value can be one or more of the following:
keywords={"string-1" <, "string-2", ...>}
specifies DICOM keywords.
| Requirement | The specified values must be unique. |
|---|
tags={"string-1" <, "string-2", ...>}
specifies DICOM tags.
| Requirement | The specified values must be unique. |
|---|
general={"CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"}
specifies general columns applicable across image formats.
| Range | 1–9 values |
|---|---|
| Default | {''} |
| Requirement | The specified values must be unique. |
caslib="string"
specifies the name of the caslib to load images from.
* 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).
| Aliases | outputImages |
|---|---|
| outputImage |
decode=TRUE | FALSE
when set to True, writes decoded images and metadata to the output table.
| Alias | decompress |
|---|---|
| Default | FALSE |
distribution={type="RANDOM" | "ROUNDROBIN", type-specific-parameters}
specifies the algorithm and parameters to be used to distribute loaded data to worker nodes.
The value that you specify for the type parameter determines the other parameters that apply.
| Default | ROUNDROBIN |
|---|
labelLevels=integer
specifies the maximum number of directory levels to include in the label.
| Default | 0 |
|---|
path="string"
specifies the file or directory path to load images from.
pathIsList=TRUE | FALSE
when set to True, the path parameter specifies a list of paths to image files.
| Default | FALSE |
|---|
quiet=TRUE | FALSE
when set to True, suppresses notes and warnings for successful operations.
| Alias | silent |
|---|---|
| Default | FALSE |
recurse=TRUE | FALSE
when set to True, loads images in subdirectories recursively.
| Default | FALSE |
|---|
repeat=TRUE | FALSE
when set to True, duplicates identical table rows on all worker nodes.
| Alias | duplicate |
|---|---|
| Default | FALSE |
series={loadSeriesParms}
specifies the parameters to be used to load directory trees as image series.
The loadSeriesParms value can be one or more of the following:
dicom=TRUE | FALSE
when set to True, loads directory trees as DICOM series.
| Default | FALSE |
|---|
reverse=TRUE | FALSE
when set to True, reverses the order of the image series.
| Default | FALSE |
|---|
Parameters for type="RANDOM"
seed=integer
specifies the seed for the pseudorandom number generator.
| Default | TKZ_NEW_SEED |
|---|
Parameters for type="ROUNDROBIN"
No parameters apply when you specify ROUNDROBIN.
loadImages Action
Loads images.
Summary: Output 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 parametercasOut |
— |
specifies the settings for an output table. |
Parameter Descriptions
addColumns={"CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"} | {extendedAddColumnsParms}
specifies extra columns to add to the output table.
The extendedAddColumnsParms value can be one or more of the following:
dicomAttributes={dicomAttributesParms}
specifies parameters related to DICOM attributes.
The dicomAttributesParms value can be one or more of the following:
keywords={"string-1" <, "string-2", ...>}
specifies DICOM keywords.
| Requirement | The specified values must be unique. |
|---|
tags={"string-1" <, "string-2", ...>}
specifies DICOM tags.
| Requirement | The specified values must be unique. |
|---|
general={"CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"}
specifies general columns applicable across image formats.
| Range | 1–9 values |
|---|---|
| Default | {''} |
| Requirement | The specified values must be unique. |
caslib="string"
specifies the name of the caslib to load images from.
* 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).
| Aliases | outputImages |
|---|---|
| outputImage |
decode=true | false
when set to True, writes decoded images and metadata to the output table.
| Alias | decompress |
|---|---|
| Default | false |
distribution={type="RANDOM" | "ROUNDROBIN", type-specific-parameters}
specifies the algorithm and parameters to be used to distribute loaded data to worker nodes.
The value that you specify for the type parameter determines the other parameters that apply.
| Default | ROUNDROBIN |
|---|
labelLevels=integer
specifies the maximum number of directory levels to include in the label.
| Default | 0 |
|---|
path="string"
specifies the file or directory path to load images from.
pathIsList=true | false
when set to True, the path parameter specifies a list of paths to image files.
| Default | false |
|---|
quiet=true | false
when set to True, suppresses notes and warnings for successful operations.
| Alias | silent |
|---|---|
| Default | false |
recurse=true | false
when set to True, loads images in subdirectories recursively.
| Default | false |
|---|
repeat=true | false
when set to True, duplicates identical table rows on all worker nodes.
| Alias | duplicate |
|---|---|
| Default | false |
series={loadSeriesParms}
specifies the parameters to be used to load directory trees as image series.
The loadSeriesParms value can be one or more of the following:
dicom=true | false
when set to True, loads directory trees as DICOM series.
| Default | false |
|---|
reverse=true | false
when set to True, reverses the order of the image series.
| Default | false |
|---|
Parameters for type="RANDOM"
seed=integer
specifies the seed for the pseudorandom number generator.
| Default | TKZ_NEW_SEED |
|---|
Parameters for type="ROUNDROBIN"
No parameters apply when you specify ROUNDROBIN.
loadImages Action
Loads images.
Summary: Output 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 parametercasOut |
— |
specifies the settings for an output table. |
Parameter Descriptions
addColumns=["CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"] | {extendedAddColumnsParms}
specifies extra columns to add to the output table.
The extendedAddColumnsParms value can be one or more of the following:
"dicomAttributes":{dicomAttributesParms}
specifies parameters related to DICOM attributes.
The dicomAttributesParms value can be one or more of the following:
"keywords":["string-1" <, "string-2", ...>]
specifies DICOM keywords.
| Requirement | The specified values must be unique. |
|---|
"tags":["string-1" <, "string-2", ...>]
specifies DICOM tags.
| Requirement | The specified values must be unique. |
|---|
"general":["CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH"]
specifies general columns applicable across image formats.
| Range | 1–9 values |
|---|---|
| Default | {''} |
| Requirement | The specified values must be unique. |
caslib="string"
specifies the name of the caslib to load images from.
* 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).
| Aliases | outputImages |
|---|---|
| outputImage |
decode=True | False
when set to True, writes decoded images and metadata to the output table.
| Alias | decompress |
|---|---|
| Default | False |
distribution={"type":"RANDOM" | "ROUNDROBIN", type-specific-parameters}
specifies the algorithm and parameters to be used to distribute loaded data to worker nodes.
The value that you specify for the type parameter determines the other parameters that apply.
| Default | ROUNDROBIN |
|---|
labelLevels=integer
specifies the maximum number of directory levels to include in the label.
| Default | 0 |
|---|
path="string"
specifies the file or directory path to load images from.
pathIsList=True | False
when set to True, the path parameter specifies a list of paths to image files.
| Default | False |
|---|
quiet=True | False
when set to True, suppresses notes and warnings for successful operations.
| Alias | silent |
|---|---|
| Default | False |
recurse=True | False
when set to True, loads images in subdirectories recursively.
| Default | False |
|---|
repeat=True | False
when set to True, duplicates identical table rows on all worker nodes.
| Alias | duplicate |
|---|---|
| Default | False |
series={loadSeriesParms}
specifies the parameters to be used to load directory trees as image series.
The loadSeriesParms value can be one or more of the following:
"dicom":True | False
when set to True, loads directory trees as DICOM series.
| Default | False |
|---|
"reverse":True | False
when set to True, reverses the order of the image series.
| Default | False |
|---|
Parameters for type="RANDOM"
"seed":integer
specifies the seed for the pseudorandom number generator.
| Default | TKZ_NEW_SEED |
|---|
Parameters for type="ROUNDROBIN"
No parameters apply when you specify ROUNDROBIN.
loadImages Action
Loads images.
Summary: Output 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 parametercasOut |
— |
specifies the settings for an output table. |
Parameter Descriptions
addColumns=list("CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH") | {extendedAddColumnsParms}
specifies extra columns to add to the output table.
The extendedAddColumnsParms value can be one or more of the following:
dicomAttributes=list(dicomAttributesParms)
specifies parameters related to DICOM attributes.
The dicomAttributesParms value can be one or more of the following:
keywords=list("string-1" <, "string-2", ...>)
specifies DICOM keywords.
| Requirement | The specified values must be unique. |
|---|
tags=list("string-1" <, "string-2", ...>)
specifies DICOM tags.
| Requirement | The specified values must be unique. |
|---|
general=list("CHANNELCOUNT", "CHANNELTYPE", "DEPTH", "HEIGHT", "ORIENTATION", "POSITION", "SPACING", "SPAN", "WIDTH")
specifies general columns applicable across image formats.
| Range | 1–9 values |
|---|---|
| Default | {''} |
| Requirement | The specified values must be unique. |
caslib="string"
specifies the name of the caslib to load images from.
* 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).
| Aliases | outputImages |
|---|---|
| outputImage |
decode=TRUE | FALSE
when set to True, writes decoded images and metadata to the output table.
| Alias | decompress |
|---|---|
| Default | FALSE |
distribution=list(type="RANDOM" | "ROUNDROBIN", type-specific-parameters)
specifies the algorithm and parameters to be used to distribute loaded data to worker nodes.
The value that you specify for the type parameter determines the other parameters that apply.
| Default | ROUNDROBIN |
|---|
labelLevels=integer
specifies the maximum number of directory levels to include in the label.
| Default | 0 |
|---|
path="string"
specifies the file or directory path to load images from.
pathIsList=TRUE | FALSE
when set to True, the path parameter specifies a list of paths to image files.
| Default | FALSE |
|---|
quiet=TRUE | FALSE
when set to True, suppresses notes and warnings for successful operations.
| Alias | silent |
|---|---|
| Default | FALSE |
recurse=TRUE | FALSE
when set to True, loads images in subdirectories recursively.
| Default | FALSE |
|---|
repeat=TRUE | FALSE
when set to True, duplicates identical table rows on all worker nodes.
| Alias | duplicate |
|---|---|
| Default | FALSE |
series=list(loadSeriesParms)
specifies the parameters to be used to load directory trees as image series.
The loadSeriesParms value can be one or more of the following:
dicom=TRUE | FALSE
when set to True, loads directory trees as DICOM series.
| Default | FALSE |
|---|
reverse=TRUE | FALSE
when set to True, reverses the order of the image series.
| Default | FALSE |
|---|
Parameters for type="RANDOM"
seed=integer
specifies the seed for the pseudorandom number generator.
| Default | TKZ_NEW_SEED |
|---|
Parameters for type="ROUNDROBIN"
No parameters apply when you specify ROUNDROBIN.