Audio Action Set

Provides actions for processing audio data

computeFeatures Action

Computes various features for audio files loaded into a CAS table.

CASL Syntax

audio.computeFeatures <result=results> <status=rc> /
audioColumn="string",
required parameter casOut={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
copyVars={"variable-name-1" <, "variable-name-2", ...>},
fbankOptions={
energyFloor=double,
rawEnergy=TRUE | FALSE,
useEnergy=TRUE | FALSE,
useLogFbank=TRUE | FALSE,
usePower=TRUE | FALSE
},
featureScalingMethod="NONE" | "STANDARDIZATION",
frameExtractionOptions={
blackmanCoeff=double,
dither=double,
frameLength=double,
frameShift=double,
preemphCoeff=double,
removeDcOffset=TRUE | FALSE,
roundToPowerOfTwo=TRUE | FALSE,
snipEdges=TRUE | FALSE,
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"
},
melBanksOptions={
highFreq=double,
lowFreq=double,
nBins=integer
},
mfccOptions={
cepstralLifter=double,
energyFloor=double,
nCeps=integer,
rawEnergy=TRUE | FALSE,
useEnergy=TRUE | FALSE
},
nContextFrames=integer,
nOutputFrames=integer,
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="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
singlePass=TRUE | FALSE,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
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}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
}
;
indicates a required parameter

Summary: Input and 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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parametercasOut

—

specifies the settings for an output table.

Parameter Descriptions

audioColumn="string"

specifies the name of the column in the input table that contains the audio data.

* casOut={casouttable}

specifies the settings for an output table.

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

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

specifies the list of variables to transfer from the input table to the output table.

Requirement The specified values must be unique.

fbankOptions={fbankOptions}

specifies the settings to use to determine how to perform the FBank feature computations.

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

energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the FBank feature computations.

Default 0
Minimum value 0
rawEnergy=TRUE | FALSE

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default TRUE
useEnergy=TRUE | FALSE

when set to True, specifies that an extra dimension containing the computed energy should be appended to each FBank feature frame.

Default FALSE
useLogFbank=TRUE | FALSE

when set to True, specifies that the output should contain log-filterbank values (otherwise, the output values are linear).

Default TRUE
usePower=TRUE | FALSE

when set to True, specifies that power should be used in the FBank feature computations (otherwise, the magnitude is used).

Default TRUE

featureScalingMethod="NONE" | "STANDARDIZATION"

specifies the feature scaling method to apply to the computed feature vectors.

Default NONE
NONE

specifies that no feature scaling method should be applied to the computed feature vectors.

STANDARDIZATION

specifies that the set containing the same coefficient across all frames in an audio file should be scaled so that the resulting set has a mean of zero and unit variance.

frameExtractionOptions={frameExtractionOptions}

specifies the settings to use to determine how to break the audio file into frames.

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

blackmanCoeff=double

specifies the constant coefficient to use for the generalized Blackman window (this value is ignored for other window types).

Default 0.42
dither=double

specifies the dithering constant (0.0 means no dithering).

Default 1
Minimum value 0
frameLength=double

specifies the length of a frame (in milliseconds).

Default 25
Minimum value (exclusive) 0
frameShift=double

specifies the time difference (in milliseconds) between the beginnings of consecutive frames.

Default 10
Minimum value (exclusive) 0
preemphCoeff=double

specifies the coefficient to use in performing signal preemphasis.

Default 0.97
Range 0–1
removeDcOffset=TRUE | FALSE

when set to True, specifies that the mean of the values in each frame should be subtracted from all values in that frame.

Default TRUE
roundToPowerOfTwo=TRUE | FALSE

when set to True, specifies that the window size should be rounded to the next power of two.

Default TRUE
snipEdges=TRUE | FALSE

when set to True, specifies that end effects should be handled by outputting only frames that completely fit the data.

Default TRUE
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"

specifies the type of window to apply to each frame upon extraction.

Default RECTANGULAR
BLACKMAN

specifies that a Blackman window should be applied when extracting frames.

HAMMING

specifies that a Hamming window should be applied when extracting frames.

HANNING

specifies that a Hanning window should be applied when extracting frames.

POVEY

specifies that a Povey window should be applied when extracting frames.

RECTANGULAR

specifies that a rectangular window should be applied when extracting frames.

melBanksOptions={melBanksOptions}

specifies the settings to use to determine the mel-frequency banks.

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

highFreq=double

specifies the high cutoff frequency for the mel-frequency bins (if negative, the value is added to the Nyquist frequency, which is determined from the sampling rate of the audio).

Default 0
lowFreq=double

specifies the low cutoff frequency for the mel-frequency bins.

Default 20
nBins=integer

specifies the number of triangular mel-frequency bins.

Default 23
Minimum value 1

mfccOptions={mfccOptions}

specifies the settings to use to determine how to perform the MFCC feature computations.

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

cepstralLifter=double

specifies the constant that controls the scaling of the MFCC feature values.

Default 22
energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the MFCC feature computations.

Default 0
Minimum value 0
nCeps=integer

specifies the number of cepstral coefficients in each MFCC feature frame (including C0).

Default 13
Minimum value 1
rawEnergy=TRUE | FALSE

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default TRUE
useEnergy=TRUE | FALSE

when set to True, specifies that energy (not C0) should be used in the MFCC feature computations.

Default TRUE

nContextFrames=integer

specifies the number of context frames to append before and after the current audio frame.

Default 0
Minimum value 0

nOutputFrames=integer

specifies the exact number of frames to include in the output table (extra frames are dropped and missing frames are padded with zeros).

Minimum value 1

* table={castable}

specifies the settings for an input table.

Long form table={name="table-name"}
Shortcut form table="table-name"

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

caslib="string"

specifies the caslib for the input 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. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

Aliases options
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the input table.

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.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

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

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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 data from the filter table.

computeFeatures Action

Computes various features for audio files loaded into a CAS table.

Lua Syntax

results, info = s:audio_computeFeatures{
audioColumn="string",
required parameter casOut={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
copyVars={"variable-name-1" <, "variable-name-2", ...>},
fbankOptions={
energyFloor=double,
rawEnergy=true | false,
useEnergy=true | false,
useLogFbank=true | false,
usePower=true | false
},
featureScalingMethod="NONE" | "STANDARDIZATION",
frameExtractionOptions={
blackmanCoeff=double,
dither=double,
frameLength=double,
frameShift=double,
preemphCoeff=double,
removeDcOffset=true | false,
roundToPowerOfTwo=true | false,
snipEdges=true | false,
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"
},
melBanksOptions={
highFreq=double,
lowFreq=double,
nBins=integer
},
mfccOptions={
cepstralLifter=double,
energyFloor=double,
nCeps=integer,
rawEnergy=true | false,
useEnergy=true | false
},
nContextFrames=integer,
nOutputFrames=integer,
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="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
singlePass=true | false,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
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}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
}
}
indicates a required parameter

Summary: Input and 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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parametercasOut

—

specifies the settings for an output table.

Parameter Descriptions

audioColumn="string"

specifies the name of the column in the input table that contains the audio data.

* casOut={casouttable}

specifies the settings for an output table.

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

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

specifies the list of variables to transfer from the input table to the output table.

Requirement The specified values must be unique.

fbankOptions={fbankOptions}

specifies the settings to use to determine how to perform the FBank feature computations.

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

energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the FBank feature computations.

Default 0
Minimum value 0
rawEnergy=true | false

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default true
useEnergy=true | false

when set to True, specifies that an extra dimension containing the computed energy should be appended to each FBank feature frame.

Default false
useLogFbank=true | false

when set to True, specifies that the output should contain log-filterbank values (otherwise, the output values are linear).

Default true
usePower=true | false

when set to True, specifies that power should be used in the FBank feature computations (otherwise, the magnitude is used).

Default true

featureScalingMethod="NONE" | "STANDARDIZATION"

specifies the feature scaling method to apply to the computed feature vectors.

Default NONE
NONE

specifies that no feature scaling method should be applied to the computed feature vectors.

STANDARDIZATION

specifies that the set containing the same coefficient across all frames in an audio file should be scaled so that the resulting set has a mean of zero and unit variance.

frameExtractionOptions={frameExtractionOptions}

specifies the settings to use to determine how to break the audio file into frames.

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

blackmanCoeff=double

specifies the constant coefficient to use for the generalized Blackman window (this value is ignored for other window types).

Default 0.42
dither=double

specifies the dithering constant (0.0 means no dithering).

Default 1
Minimum value 0
frameLength=double

specifies the length of a frame (in milliseconds).

Default 25
Minimum value (exclusive) 0
frameShift=double

specifies the time difference (in milliseconds) between the beginnings of consecutive frames.

Default 10
Minimum value (exclusive) 0
preemphCoeff=double

specifies the coefficient to use in performing signal preemphasis.

Default 0.97
Range 0–1
removeDcOffset=true | false

when set to True, specifies that the mean of the values in each frame should be subtracted from all values in that frame.

Default true
roundToPowerOfTwo=true | false

when set to True, specifies that the window size should be rounded to the next power of two.

Default true
snipEdges=true | false

when set to True, specifies that end effects should be handled by outputting only frames that completely fit the data.

Default true
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"

specifies the type of window to apply to each frame upon extraction.

Default RECTANGULAR
BLACKMAN

specifies that a Blackman window should be applied when extracting frames.

HAMMING

specifies that a Hamming window should be applied when extracting frames.

HANNING

specifies that a Hanning window should be applied when extracting frames.

POVEY

specifies that a Povey window should be applied when extracting frames.

RECTANGULAR

specifies that a rectangular window should be applied when extracting frames.

melBanksOptions={melBanksOptions}

specifies the settings to use to determine the mel-frequency banks.

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

highFreq=double

specifies the high cutoff frequency for the mel-frequency bins (if negative, the value is added to the Nyquist frequency, which is determined from the sampling rate of the audio).

Default 0
lowFreq=double

specifies the low cutoff frequency for the mel-frequency bins.

Default 20
nBins=integer

specifies the number of triangular mel-frequency bins.

Default 23
Minimum value 1

mfccOptions={mfccOptions}

specifies the settings to use to determine how to perform the MFCC feature computations.

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

cepstralLifter=double

specifies the constant that controls the scaling of the MFCC feature values.

Default 22
energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the MFCC feature computations.

Default 0
Minimum value 0
nCeps=integer

specifies the number of cepstral coefficients in each MFCC feature frame (including C0).

Default 13
Minimum value 1
rawEnergy=true | false

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default true
useEnergy=true | false

when set to True, specifies that energy (not C0) should be used in the MFCC feature computations.

Default true

nContextFrames=integer

specifies the number of context frames to append before and after the current audio frame.

Default 0
Minimum value 0

nOutputFrames=integer

specifies the exact number of frames to include in the output table (extra frames are dropped and missing frames are padded with zeros).

Minimum value 1

* table={castable}

specifies the settings for an input table.

Long form table={name="table-name"}
Shortcut form table="table-name"

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

caslib="string"

specifies the caslib for the input 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. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

Aliases options
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the input table.

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.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

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

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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 data from the filter table.

computeFeatures Action

Computes various features for audio files loaded into a CAS table.

Python Syntax

results=s.audio.computeFeatures(
audioColumn="string",
required parameter casOut={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
copyVars=["variable-name-1" <, "variable-name-2", ...>],
fbankOptions={
"energyFloor":double,
"rawEnergy":True | False,
"useEnergy":True | False,
"useLogFbank":True | False,
"usePower":True | False
},
featureScalingMethod="NONE" | "STANDARDIZATION",
frameExtractionOptions={
"blackmanCoeff":double,
"dither":double,
"frameLength":double,
"frameShift":double,
"preemphCoeff":double,
"removeDcOffset":True | False,
"roundToPowerOfTwo":True | False,
"snipEdges":True | False,
"windowType":"BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"
},
melBanksOptions={
"highFreq":double,
"lowFreq":double,
"nBins":integer
},
mfccOptions={
"cepstralLifter":double,
"energyFloor":double,
"nCeps":integer,
"rawEnergy":True | False,
"useEnergy":True | False
},
nContextFrames=integer,
nOutputFrames=integer,
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":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"singlePass":True | False,
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
"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}
required parameter "name":"table-name"
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
}
)
indicates a required parameter

Summary: Input and 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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parametercasOut

—

specifies the settings for an output table.

Parameter Descriptions

audioColumn="string"

specifies the name of the column in the input table that contains the audio data.

* casOut={casouttable}

specifies the settings for an output table.

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

copyVars=["variable-name-1" <, "variable-name-2", ...>]

specifies the list of variables to transfer from the input table to the output table.

Requirement The specified values must be unique.

fbankOptions={fbankOptions}

specifies the settings to use to determine how to perform the FBank feature computations.

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

"energyFloor":double

specifies the linear floor on energy (absolute, not relative) for the FBank feature computations.

Default 0
Minimum value 0
"rawEnergy":True | False

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default True
"useEnergy":True | False

when set to True, specifies that an extra dimension containing the computed energy should be appended to each FBank feature frame.

Default False
"useLogFbank":True | False

when set to True, specifies that the output should contain log-filterbank values (otherwise, the output values are linear).

Default True
"usePower":True | False

when set to True, specifies that power should be used in the FBank feature computations (otherwise, the magnitude is used).

Default True

featureScalingMethod="NONE" | "STANDARDIZATION"

specifies the feature scaling method to apply to the computed feature vectors.

Default NONE
NONE

specifies that no feature scaling method should be applied to the computed feature vectors.

STANDARDIZATION

specifies that the set containing the same coefficient across all frames in an audio file should be scaled so that the resulting set has a mean of zero and unit variance.

frameExtractionOptions={frameExtractionOptions}

specifies the settings to use to determine how to break the audio file into frames.

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

"blackmanCoeff":double

specifies the constant coefficient to use for the generalized Blackman window (this value is ignored for other window types).

Default 0.42
"dither":double

specifies the dithering constant (0.0 means no dithering).

Default 1
Minimum value 0
"frameLength":double

specifies the length of a frame (in milliseconds).

Default 25
Minimum value (exclusive) 0
"frameShift":double

specifies the time difference (in milliseconds) between the beginnings of consecutive frames.

Default 10
Minimum value (exclusive) 0
"preemphCoeff":double

specifies the coefficient to use in performing signal preemphasis.

Default 0.97
Range 0–1
"removeDcOffset":True | False

when set to True, specifies that the mean of the values in each frame should be subtracted from all values in that frame.

Default True
"roundToPowerOfTwo":True | False

when set to True, specifies that the window size should be rounded to the next power of two.

Default True
"snipEdges":True | False

when set to True, specifies that end effects should be handled by outputting only frames that completely fit the data.

Default True
"windowType":"BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"

specifies the type of window to apply to each frame upon extraction.

Default RECTANGULAR
BLACKMAN

specifies that a Blackman window should be applied when extracting frames.

HAMMING

specifies that a Hamming window should be applied when extracting frames.

HANNING

specifies that a Hanning window should be applied when extracting frames.

POVEY

specifies that a Povey window should be applied when extracting frames.

RECTANGULAR

specifies that a rectangular window should be applied when extracting frames.

melBanksOptions={melBanksOptions}

specifies the settings to use to determine the mel-frequency banks.

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

"highFreq":double

specifies the high cutoff frequency for the mel-frequency bins (if negative, the value is added to the Nyquist frequency, which is determined from the sampling rate of the audio).

Default 0
"lowFreq":double

specifies the low cutoff frequency for the mel-frequency bins.

Default 20
"nBins":integer

specifies the number of triangular mel-frequency bins.

Default 23
Minimum value 1

mfccOptions={mfccOptions}

specifies the settings to use to determine how to perform the MFCC feature computations.

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

"cepstralLifter":double

specifies the constant that controls the scaling of the MFCC feature values.

Default 22
"energyFloor":double

specifies the linear floor on energy (absolute, not relative) for the MFCC feature computations.

Default 0
Minimum value 0
"nCeps":integer

specifies the number of cepstral coefficients in each MFCC feature frame (including C0).

Default 13
Minimum value 1
"rawEnergy":True | False

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default True
"useEnergy":True | False

when set to True, specifies that energy (not C0) should be used in the MFCC feature computations.

Default True

nContextFrames=integer

specifies the number of context frames to append before and after the current audio frame.

Default 0
Minimum value 0

nOutputFrames=integer

specifies the exact number of frames to include in the output table (extra frames are dropped and missing frames are padded with zeros).

Minimum value 1

* table={castable}

specifies the settings for an input table.

Long form table={"name":"table-name"}
Shortcut form table="table-name"

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

"caslib":"string"

specifies the caslib for the input 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. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of 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.

Aliases options
dataSource
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import_

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

* "name":"table-name"

specifies the name of the input table.

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

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of 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.

"whereTable":{groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

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

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import_

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

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of 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 data from the filter table.

computeFeatures Action

Computes various features for audio files loaded into a CAS table.

R Syntax

results <– cas.audio.computeFeatures(s,
audioColumn="string",
required parameter casOut=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
copyVars=list("variable-name-1" <, "variable-name-2", ...>),
fbankOptions=list(
energyFloor=double,
rawEnergy=TRUE | FALSE,
useEnergy=TRUE | FALSE,
useLogFbank=TRUE | FALSE,
usePower=TRUE | FALSE
),
featureScalingMethod="NONE" | "STANDARDIZATION",
frameExtractionOptions=list(
blackmanCoeff=double,
dither=double,
frameLength=double,
frameShift=double,
preemphCoeff=double,
removeDcOffset=TRUE | FALSE,
roundToPowerOfTwo=TRUE | FALSE,
snipEdges=TRUE | FALSE,
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"
),
melBanksOptions=list(
highFreq=double,
lowFreq=double,
nBins=integer
),
mfccOptions=list(
cepstralLifter=double,
energyFloor=double,
nCeps=integer,
rawEnergy=TRUE | FALSE,
useEnergy=TRUE | FALSE
),
nContextFrames=integer,
nOutputFrames=integer,
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="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
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",
whereTable=list(
casLib="string"
dataSourceOptions=list(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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
)
)
indicates a required parameter

Summary: Input and 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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parametercasOut

—

specifies the settings for an output table.

Parameter Descriptions

audioColumn="string"

specifies the name of the column in the input table that contains the audio data.

* casOut=list(casouttable)

specifies the settings for an output table.

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

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

specifies the list of variables to transfer from the input table to the output table.

Requirement The specified values must be unique.

fbankOptions=list(fbankOptions)

specifies the settings to use to determine how to perform the FBank feature computations.

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

energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the FBank feature computations.

Default 0
Minimum value 0
rawEnergy=TRUE | FALSE

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default TRUE
useEnergy=TRUE | FALSE

when set to True, specifies that an extra dimension containing the computed energy should be appended to each FBank feature frame.

Default FALSE
useLogFbank=TRUE | FALSE

when set to True, specifies that the output should contain log-filterbank values (otherwise, the output values are linear).

Default TRUE
usePower=TRUE | FALSE

when set to True, specifies that power should be used in the FBank feature computations (otherwise, the magnitude is used).

Default TRUE

featureScalingMethod="NONE" | "STANDARDIZATION"

specifies the feature scaling method to apply to the computed feature vectors.

Default NONE
NONE

specifies that no feature scaling method should be applied to the computed feature vectors.

STANDARDIZATION

specifies that the set containing the same coefficient across all frames in an audio file should be scaled so that the resulting set has a mean of zero and unit variance.

frameExtractionOptions=list(frameExtractionOptions)

specifies the settings to use to determine how to break the audio file into frames.

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

blackmanCoeff=double

specifies the constant coefficient to use for the generalized Blackman window (this value is ignored for other window types).

Default 0.42
dither=double

specifies the dithering constant (0.0 means no dithering).

Default 1
Minimum value 0
frameLength=double

specifies the length of a frame (in milliseconds).

Default 25
Minimum value (exclusive) 0
frameShift=double

specifies the time difference (in milliseconds) between the beginnings of consecutive frames.

Default 10
Minimum value (exclusive) 0
preemphCoeff=double

specifies the coefficient to use in performing signal preemphasis.

Default 0.97
Range 0–1
removeDcOffset=TRUE | FALSE

when set to True, specifies that the mean of the values in each frame should be subtracted from all values in that frame.

Default TRUE
roundToPowerOfTwo=TRUE | FALSE

when set to True, specifies that the window size should be rounded to the next power of two.

Default TRUE
snipEdges=TRUE | FALSE

when set to True, specifies that end effects should be handled by outputting only frames that completely fit the data.

Default TRUE
windowType="BLACKMAN" | "HAMMING" | "HANNING" | "POVEY" | "RECTANGULAR"

specifies the type of window to apply to each frame upon extraction.

Default RECTANGULAR
BLACKMAN

specifies that a Blackman window should be applied when extracting frames.

HAMMING

specifies that a Hamming window should be applied when extracting frames.

HANNING

specifies that a Hanning window should be applied when extracting frames.

POVEY

specifies that a Povey window should be applied when extracting frames.

RECTANGULAR

specifies that a rectangular window should be applied when extracting frames.

melBanksOptions=list(melBanksOptions)

specifies the settings to use to determine the mel-frequency banks.

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

highFreq=double

specifies the high cutoff frequency for the mel-frequency bins (if negative, the value is added to the Nyquist frequency, which is determined from the sampling rate of the audio).

Default 0
lowFreq=double

specifies the low cutoff frequency for the mel-frequency bins.

Default 20
nBins=integer

specifies the number of triangular mel-frequency bins.

Default 23
Minimum value 1

mfccOptions=list(mfccOptions)

specifies the settings to use to determine how to perform the MFCC feature computations.

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

cepstralLifter=double

specifies the constant that controls the scaling of the MFCC feature values.

Default 22
energyFloor=double

specifies the linear floor on energy (absolute, not relative) for the MFCC feature computations.

Default 0
Minimum value 0
nCeps=integer

specifies the number of cepstral coefficients in each MFCC feature frame (including C0).

Default 13
Minimum value 1
rawEnergy=TRUE | FALSE

when set to True, specifies that energy should be computed before preemphasis and windowing.

Default TRUE
useEnergy=TRUE | FALSE

when set to True, specifies that energy (not C0) should be used in the MFCC feature computations.

Default TRUE

nContextFrames=integer

specifies the number of context frames to append before and after the current audio frame.

Default 0
Minimum value 0

nOutputFrames=integer

specifies the exact number of frames to include in the output table (extra frames are dropped and missing frames are padded with zeros).

Minimum value 1

* table=list(castable)

specifies the settings for an input table.

Long form table=list(name="table-name")
Shortcut form table="table-name"

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

caslib="string"

specifies the caslib for the input 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. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

Aliases options
dataSource
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the input table.

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.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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.

whereTable=list(groupbytable)

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(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 | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Aliases options
dataSource

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

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias import

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

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of 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 data from the filter table.

Last updated: November 23, 2025