lentil.field.insert

lentil.field.insert(field, out, intensity=False, weight=1, indexing='ij')[source]
Parameters
  • field (Field) – Field to insert into out

  • out (ndarray) – Array to insert field into

  • intensity (bool, optional) – If True, compute intensity of field before placing it in out. Default is False.

  • weight (float, optional) – Weight to apply to field before it is inserted into out

  • indexing ('ij', 'xy', optional) – Cartesian (‘xy’) or matrix (‘ij’, default) indexing of output

Returns

out

Return type

ndarray