Differences

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

Link to this comparison view

Next revision
Previous revision
create_lookup_table [2011/07/31 17:36]
hermann created
create_lookup_table [2026/08/28 03:17] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Create Lookup Table ====== ​+====== Create Lookup Table ======
  
 ===== Description ===== ===== Description =====
  
-This functor creates ​custom ​lookup table filled in with specified value.+Creates ​a lookup table populated between an initial and final key, interpolating the values assigned to each.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Initial Key  | [[ Double ​Type|Double  ​]]  | The initial ​key.  | +| Initial Key  | [[Real Value Type]] ​ | Initial (first) ​key of the resulting lookup table.  | 
-| Final Key  | [[Double ​Type|Double  ​]]  | The final key.  |+| Final Key  | [[Real Value Type]] ​ | Final (last) ​key of the resulting lookup table.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  
-| Initial Value  | [[Double ​Type|Double  ​]]  | The initial value.  | 0.0  | +| Initial Value  | [[Real Value Type]] ​ | Value assigned to Initial Key.  | 0.0  | 
-| Final Value  | [[Double ​Type|Double  ​]]  | The final value.  | 0.0  | +| Final Value  | [[Real Value Type]] ​ | Value assigned to Final Key.  | 0.0  | 
-| Increment ​ | [[Double ​Type|Double  ​]]  | Increment ​between keys.  | 1.0  | +| Increment ​ | [[Real Value Type]] ​ | Interval ​between ​consecutive ​keys of the resulting lookup table.  | 1.0  | 
-| Key Name  | [[Name Type|Name  ​]]  | Name of keys.  | "​Key" ​ | +| Key Name  | [[Name Type]] ​ | Name given to the lookup table'​s key column. This is an advanced port.  | "​Key" ​ | 
-| Value Name  | [[Name Type|Name  ​]]  | Name of values.  | "​Value" ​ |+| Value Name  | [[Name Type]] ​ | Name given to the lookup table'​s value column. This is an advanced port.  | "​Value" ​ |
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Result ​ | [[ Lookup Table Type|Lookup Table  ​]] | The resulting lookup table. ​ |+| Result ​ | [[Lookup Table Type]] ​ | The resulting lookup table. ​ |
  
 ===== Group ===== ===== Group =====
  
-[[Functor List#Table | Table]]+[[Functor List#Lookup ​Table | Lookup ​Table]]
  
-===== Notes ===== +===== Notes =====
  
-===== Internal Name ===== +The values between Initial Key and Final Key are linearly interpolated between Initial Value and Final Value. 
 + 
 +Final Key is included in the resulting lookup table only if the interval between it and the immediately preceding key is compatible with Increment. 
 + 
 +===== Internal Name =====
  
 CreateLookupTable CreateLookupTable