Libraries.Compute.Statistics.Columns.AudioColumn Documentation

AudioColumn is a DataFrameColumn that contains number objects. The AudioColumn must have an AudioSamples object manually loaded into it. Because this column contains AudioSamples objects, which must contain samples at each point, no row can be possibly be undefined. The same representation can be used for multi-channel audio, by setting the channel per column.

Inherits from: Libraries.Compute.Statistics.DataFrameColumn, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Add(text value)Columns may optionally add data from a text representation of that data.
Calculate(Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)This action conducts a calculation on this column.
CanConvertToVector()
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
ConvertToBooleanColumn()Regardless of the type of this column, the system will attempt to convert it to a BooleanColumn.
ConvertToIntegerColumn()Regardless of the type of this column, the system will attempt to convert it to an IntegerColumn.
ConvertToNumberColumn()Regardless of the type of this column, the system will attempt to convert it to a NumberColumn.
ConvertToTextColumn()Regardless of the type of this column, the system will attempt to convert it to a TextColumn.
ConvertToVector()
Copy()
Copy(integer rowStart, integer rowEnd)This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetAsBoolean(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to a boolean.
GetAsInteger(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to an integer.
GetAsNumber(integer index)
GetAsText(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to text.
GetChannel()An AudioColumn uses an underlying AudioSamples object, which cannot have undefined item
GetHashCode()This action gets the hash code for an object.
GetHeader()This gets the header for this colum
GetSamples()
GetSize()
GetUndefinedSize()This action returns the number of items in this column that are undefined.
GetUndefinedText()This action returns a default text string for undefined value
IsBooleanColumn()This action detects whether this column ultimately stores booleans inside of it.
IsIntegerColumn()This action detects whether this column ultimately stores integers inside of it.
IsNumberColumn()
IsTextColumn()This action detects whether this column ultimately stores text inside of it.
IsUndefined(integer row)An AudioColumn uses an underlying AudioSamples object, which cannot have undefined item
Move(integer left, integer right)This action moves the value in row left to the value in row right.
SendValueTo(integer index, Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)
SetAsBoolean(integer index, boolean value)This action sets the index to a boolean if and only if this is a boolean column.
SetAsInteger(integer index, integer value)This action sets the index to an integer if and only if this is an integer column.
SetAsNumber(integer index, number value)
SetAsText(integer index, text value)This action sets the index to text if and only if this is a text column.
SetChannel(integer channel)
SetHeader(text header)This sets the header for this colum
SetSamples(Libraries.Sound.AudioSamples samples)
SetSize(integer size)
Swap(integer left, integer right)
ToText()This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.

Actions Documentation

Add(text value)

Columns may optionally add data from a text representation of that data. This can be in any arbitrary format determined by the column implementor. The Add action does the auto-conversion, while the set values are only accepted if that data type is allowed. The broad purpose is to allow this action to read in from an arbitrary text source and add it to the column.

Parameters

Calculate(Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)

This action conducts a calculation on this column. The calculation begins by issuing a Start action. Then if it is an iterable action, sends each data point to the class for processing. If not, it is asked to conduct the entire operation at once on the full data set. Finally, it issues an end action.

Parameters

CanConvertToVector()

Return

boolean

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

ConvertToBooleanColumn()

Regardless of the type of this column, the system will attempt to convert it to a BooleanColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted colu

Return

Libraries.Compute.Statistics.Columns.BooleanColumn:

ConvertToIntegerColumn()

Regardless of the type of this column, the system will attempt to convert it to an IntegerColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted colu

Return

Libraries.Compute.Statistics.Columns.IntegerColumn:

ConvertToNumberColumn()

Regardless of the type of this column, the system will attempt to convert it to a NumberColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted colu

Return

Libraries.Compute.Statistics.Columns.NumberColumn:

ConvertToTextColumn()

Regardless of the type of this column, the system will attempt to convert it to a TextColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted colu

Return

Libraries.Compute.Statistics.Columns.TextColumn:

ConvertToVector()

Return

Libraries.Compute.Vector

Copy()

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy(integer rowStart, integer rowEnd)

This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.

Parameters

Return

Libraries.Compute.Statistics.DataFrameColumn:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetAsBoolean(integer index)

Regardless of the type of the column, this action attempts to convert the item at the index to a boolean. Attrribute: Parameter index the item to be convert

Parameters

Return

boolean:

GetAsInteger(integer index)

Regardless of the type of the column, this action attempts to convert the item at the index to an integer. Attrribute: Parameter index the item to be convert

Parameters

Return

integer:

GetAsNumber(integer index)

Parameters

Return

number

GetAsText(integer index)

Regardless of the type of the column, this action attempts to convert the item at the index to text. Attrribute: Parameter index the item to be convert

Parameters

Return

text:

GetChannel()

An AudioColumn uses an underlying AudioSamples object, which cannot have undefined item

Return

integer:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

GetHeader()

This gets the header for this colum

Return

text:

GetSamples()

Return

Libraries.Sound.AudioSamples

GetSize()

Return

integer

GetUndefinedSize()

This action returns the number of items in this column that are undefined.

Return

integer: the number of items that are not defin

GetUndefinedText()

This action returns a default text string for undefined value

Return

text:

IsBooleanColumn()

This action detects whether this column ultimately stores booleans inside of it. This type of information is implementation dependent, as arbitrary columns can store these values however they see fit.

Return

boolean: true if this column stores boolea

IsIntegerColumn()

This action detects whether this column ultimately stores integers inside of it. This type of information is implementation dependent, as arbitrary columns can store these values however they see fit.

Return

boolean: true if this column stores intege

IsNumberColumn()

Return

boolean

IsTextColumn()

This action detects whether this column ultimately stores text inside of it. This type of information is implementation dependent, as arbitrary columns can store these values however they see fit.

Return

boolean: true if this column stores te

IsUndefined(integer row)

An AudioColumn uses an underlying AudioSamples object, which cannot have undefined item

Parameters

Return

boolean:

Move(integer left, integer right)

This action moves the value in row left to the value in row right.

Parameters

SendValueTo(integer index, Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)

Parameters

SetAsBoolean(integer index, boolean value)

This action sets the index to a boolean if and only if this is a boolean column. Attrribute: Parameter index the item to be converted

Parameters

SetAsInteger(integer index, integer value)

This action sets the index to an integer if and only if this is an integer column. Attrribute: Parameter index the item to be converted

Parameters

SetAsNumber(integer index, number value)

Parameters

SetAsText(integer index, text value)

This action sets the index to text if and only if this is a text column. Attrribute: Parameter index the item to be converted

Parameters

SetChannel(integer channel)

Parameters

SetHeader(text header)

This sets the header for this colum

Parameters

SetSamples(Libraries.Sound.AudioSamples samples)

Parameters

SetSize(integer size)

Parameters

Swap(integer left, integer right)

Parameters

ToText()

This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.

Return

text: