scopesim.effects.effects_utils.z_order_in_range

scopesim.effects.effects_utils.z_order_in_range#

scopesim.effects.effects_utils.z_order_in_range(z_eff, z_range: range) bool#

Return True if any of the z_orders in z_eff is in the given range.

The z_range parameter can be constructed as range(z_min, z_max).

Parameters:
  • z_eff (int or list of ints) – z_order(s) of the effect.

  • z_range (range) – range object of allowed z_order values.

Returns:

True if at least one z_order is in range, False otherwise.

Return type:

bool