Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
calc_histogram [2012/11/23 19:39]
admin
calc_histogram [2015/10/12 00:42] (current)
admin
Line 7: Line 7:
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^  
-| Map  | [[Map Type|Map]]  | Any map  |+| Map  | [[Map Type]] ​ | Any map  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  
-| Interval Width  | [[Double ​Type|Double]] | The width of the histogram interval. ​ | 1.0  | +| Interval Width  | [[Real Value Type]] ​ | The width of the histogram interval. ​ | 1.0  | 
-| Cumulative ​ | [[Bool Type|Bool]]  | If true, the calculated histogram is cumulative. ​ | False  | +| Cumulative ​ | [[Boolean Value Type]] ​ | If true, the calculated histogram is cumulative. ​ | False  | 
-| Relative ​ | [[Bool Type|Bool]]  | If true, the values in the histogram are normalized by the total number of occurrences. | False  |+| Relative ​ | [[Boolean Value Type]] ​ | If true, the values in the histogram are normalized by the total number of occurrences. ​ | False  |
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^+^ Name  ^ Type  ^ Description ​ ^
 | Histogram ​ | [[Lookup Table Type|Lookup Table]] ​ | The calculated histogram. ​ | | Histogram ​ | [[Lookup Table Type|Lookup Table]] ​ | The calculated histogram. ​ |
  
 ===== Notes ===== ===== Notes =====
  
-It is possible to calculate a relative ​histogram ​of the accumulated ​values ​setting ​both inputs ​"​Cumulative"​ and "​Relative" ​to true.+It also possible to calculate a histogram ​relative to the cumulative ​values. To do this, set both input flags ("​Cumulative"​ and "​Relative"​).
  
-When the interval width is different from zero, the input values are remapped ​into new values ​according to the expression below to speed up the histogram ​calculation.+When the "​Interval Width" ​is different from one, the input values are remapped according to the expression below to speed up the calculation.
  
-<m>value´=delim{|}{value/​width}{|}*width</​m> ​ +<m>value2 ​=delim{|}{value/​width}{|}*width</​m>​, where //value2// is the resulting value, //value// is the value present in the input map and //width// is the "​Interval Width"​.
  
-where //value´// is the remapped value//value// is the value present ​in the input map and //width// is the width of the interval. +Because of the remapping, the lower limit of the resulting histogram can be lower than the minimum ​value in the input map. The upper limit of the histogram ​can be greater than the maximum value in the input map.
- +
-Because the input values are remapped this way, the lower and upper limits present in the resulting ​histogram ​may be lower and greater, respectively, ​than the lower and upper limits present ​in the input map.   ​+
  
 ===== Group ===== ===== Group =====