Libraries.Compute.Statistics.Charts.HistogramCreator Documentation

This class is used to create a histogram for use in an application. By default, it uses the Freedman-Diaconis rule for bin widths, which provides a reasonable looking histogram in most cases. More information can be found at: https://en.wikipedia.org/wiki/Freedman%E2%80%93Diaconis_rule

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Charts.HistogramCreator

    DataFrame frame
    frame:Load("Data/Data.csv")

    //Create a Bar Chart and set some properties
    DataFrame frame
    frame:Load("Data/Data.csv")

    HistogramCreator creator
    creator:SetValueColumn("DRT")

    Chart chart = frame:CreateChart(creator)

    chart:SetTitle("Histogram")
    chart:SetYAxisTitle("Frequency")
    chart:SetXAxisTitle("DT")

    //we might then add this chart to a gam

Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddColumn(integer column)This action adds a value to the end of the input.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Create(Libraries.Compute.Statistics.DataFrame frame)
EmptyColumns()This action empty's the list, clearing out all of the items contained within i
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetBinWidth()Obtains what the bin width wa
GetColumn()Returns the name of the value column specifie
GetColumn(integer index)This action gets the item at a given location in an array.
GetColumnIterator()This action gets an iterator for the object and returns that iterator.
GetColumnSize()This action gets the size of the array.
GetHashCode()This action gets the hash code for an object.
GetTicks()This returns the number of ticks to present on the chart.
IsEmptyColumns()This action returns a boolean value, true if the container is empty and false if it contains any items.
RemoveColumn(integer column)This action removes the first occurrence of an item that is found in the Addable object.
RemoveColumnAt(integer index)This action removes an item from an indexed object and returns that item.
SetBinWidth(number binWidthOverride)Manually changes the bin widt
SetColumn(integer column)Sets the name of the name column specifie
SetTicks(integer ticks)This sets the number of ticks to present on the chart.

Actions Documentation

AddColumn(integer column)

This action adds a value to the end of the input.

Parameters

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.

Create(Libraries.Compute.Statistics.DataFrame frame)

Parameters

Return

Libraries.Interface.Controls.Charts.Chart

EmptyColumns()

This action empty's the list, clearing out all of the items contained within i

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.

GetBinWidth()

Obtains what the bin width wa

Return

number:

GetColumn()

Returns the name of the value column specifie

Return

integer:

GetColumn(integer index)

This action gets the item at a given location in an array.

Parameters

Return

integer: The item at the given locatio

GetColumnIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an objec

GetColumnSize()

This action gets the size of the array.

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.

GetTicks()

This returns the number of ticks to present on the chart.

Return

integer: the number of tic

IsEmptyColumns()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is no

RemoveColumn(integer column)

This action removes the first occurrence of an item that is found in the Addable object.

Parameters

Return

boolean: Returns true if the item was removed and false if it was not remove

RemoveColumnAt(integer index)

This action removes an item from an indexed object and returns that item.

Parameters

SetBinWidth(number binWidthOverride)

Manually changes the bin widt

Parameters

SetColumn(integer column)

Sets the name of the name column specifie

Parameters

SetTicks(integer ticks)

This sets the number of ticks to present on the chart.

Parameters