Basics
Histogram - CreateHistogram_CreateFromArray
Constructs a new Histogram from an existing distribution.
IN
| Name | Type | Description |
|---|---|---|
| InValues | DoubleArray | Bin values. |
| InStartIndex | Int | Index of the first array bin from which to copy the values. Range: 〔0, +inf）. |
| InDomainStart | Float | Domain start. |
| InBinSize | Float | Bin size. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The Histogram instance. |
| Error | ErrorState | Gets the execution error message |
Histogram - CreateHistogram_CreateFromData
Constructs a new Histogram object from existing data.
IN
| Name | Type | Description |
|---|---|---|
| InDomainStart | Float | Start value. |
| InBinSize | Float | Bin size. Range: （0, +inf）. |
| InData | DoubleArray | Data pointer. |
| InBinCount | Int | Number of bins. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The Histogram instance. |
| Error | ErrorState | Gets the execution error message |
Histogram - CreateHistogram_CreateFromDomain
Constructs a new Histogram object, given start and end values for the domain and the bins' width.
IN
| Name | Type | Description |
|---|---|---|
| InDomainStart | Float | Start value. |
| InDomainEnd | Float | End value. |
| InBinSize | Float | Bin size. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The Histogram instance. |
| Error | ErrorState | Gets the execution error message |
Histogram - CreateHistogram_CreateFromValue
Constructs a new Histogram object, given the domain and the number of bins.
IN
| Name | Type | Description |
|---|---|---|
| InDomainStart | Float | Start value. |
| InBinSize | Float | Bin size. |
| InBinCount | Int | Number of bins. Range: 〔1, +inf）. |
| InValue | Double | Default value for all bins. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The Histogram instance. |
| Error | ErrorState | Gets the execution error message |
Histogram - CreateHistogram_CreateFromWeightedArray
Creates a new Histogram object given an array of values and their relative weights.
IN
| Name | Type | Description |
|---|---|---|
| InValues | FloatArray | Array from which histogram will be generated. |
| InBinSize | Float | Bin size. Range: （0, +inf）. |
| InCyclic | Bool | Whether to consider the input data as cyclic. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The Histogram instance. |
| Error | ErrorState | Gets the execution error message |
Histogram - Deserialize
De-serialize a Histogram buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetBinCount
Returns the number of bins.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Bins. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetBinEnd
Returns the upper bound of a specific histogram bar.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InIndex | Int | Bin index. Range: 〔0, +inf）. |
| InCyclic | Bool | Whether to consider the histogram as cyclic. |
| InInverse | Bool | Whether to start searching from the end. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Upper bound of the bin. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetBinSize
Returns the bin size.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | float Bin size. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetBinStart
Returns the lower bound of a specific histogram bar.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InIndex | Int | Bin index. Range: 〔0, +inf）. |
| InCyclic | Bool | Whether to consider the histogram as cyclic. |
| InInverse | Bool | Whether to start searching from the end. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Lower bound of the bin. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetBinValue
Returns the value of the bin of which inBin is part.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InBin | Float | Value in the histogram domain used to select the bin. |
| InCyclic | Bool | Whether to consider the histogram as cyclic. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutDouble | Double | Bin's value. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetData
Returns the pointer to the array's values.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutDouble | DoubleArray | Pointer to the distribution. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetDomainEnd
Returns the domain end.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | float Domain end. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetDomainLength
Returns the domain length.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | float Domain length. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetDomainStart
Returns the domain starting value.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | float Domain start. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetIndices
Returns the array of indices for the histogram (increasing values starting from 0).
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArray | Output indices. |
| Error | ErrorState | Gets the execution error message |
Histogram - GetSize
Returns the number of histogram bins.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Number of bins. |
| Error | ErrorState | Gets the execution error message |
Histogram - HasSameDomain
Checks if two histograms have the same domain.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram1 | Histogram | The input Histogram |
| InHistogram2 | Histogram | Another Histogram object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | If the two have the same domain. |
| Error | ErrorState | Gets the execution error message |
Histogram - Serialize
Serialize the Histogram object using flatbuffers.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBin
Sets the value of a specific bin.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InIndex | Int | Input bin index. Range: 〔0, +inf）. |
| InValue | Double | Input value. |
| InCyclic | Bool | Whether to consider the histogram as cyclic. |
| InInverse | Bool | Whether to start searching from the end. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBinCount
Sets a new number of bins.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InBinCount | Int | Bins. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBinCountOf
Sets the same bin count of another Histogram.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram1 | Histogram | The input Histogram |
| InHistogram2 | Histogram | Another Histogram object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram1 | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBinSize
Sets a new bin size.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InBinSize | Float | Bin size. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBinSizeOf
Sets the same bin size as another Histogram.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram1 | Histogram | The input Histogram |
| InHistogram2 | Histogram | Another Histogram object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram1 | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetBinValue
Sets the value of the bin of which inBinValue is part.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InBin | Float | Value in the histogram domain used to select the bin. |
| InValue | Double | Input value for the bin. |
| InCyclic | Bool | Whether to consider the histogram as cyclic. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetDomainStart
Sets the domain starting value.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram | Histogram | The input Histogram |
| InDomainStart | Float | Domain start. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |
Histogram - SetDomainStartOf
Sets the domain start value from another Histogram starting value.
IN
| Name | Type | Description |
|---|---|---|
| InHistogram1 | Histogram | The input Histogram |
| InHistogram2 | Histogram | Another Histogram object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram1 | Histogram | The modified Core.Data.Types.Histogram |
| Error | ErrorState | Gets the execution error message |