indexFromKLModeNumber

return the linear index into k_wv and l_wv from a mode number

Developer documentation: this item describes internal implementation details.


Declaration

 index = indexFromKLModeNumber(kMode,lMode,jMode)

Parameters

  • kMode integer
  • lMode integer

Returns

  • linearIndex a non-negative integer number

Discussion

This function will return the linear index into the (k_wv,l_wv) arrays, given the mode numbers (kMode,lMode). Note that this will not normalize the mode to the primary mode number, but will throw an error. Scalar and column-vector inputs preserve their shape and ordering.


This site uses Just the Docs, a documentation theme for Jekyll.