improver.nbhood package

Submodules

• improver.nbhood.nbhood module
  • BaseNeighbourhoodProcessing
    • BaseNeighbourhoodProcessing.__init__()
    • BaseNeighbourhoodProcessing._abc_impl
    • BaseNeighbourhoodProcessing._find_radii()
    • BaseNeighbourhoodProcessing.process()
  • GeneratePercentilesFromANeighbourhood
    • GeneratePercentilesFromANeighbourhood.__init__()
    • GeneratePercentilesFromANeighbourhood._abc_impl
    • GeneratePercentilesFromANeighbourhood.make_percentile_cube()
    • GeneratePercentilesFromANeighbourhood.pad_and_unpad_cube()
    • GeneratePercentilesFromANeighbourhood.process()
  • NeighbourhoodProcessing
    • NeighbourhoodProcessing.__init__()
    • NeighbourhoodProcessing._abc_impl
    • NeighbourhoodProcessing._calculate_neighbourhood()
    • NeighbourhoodProcessing._do_nbhood_sum()
    • NeighbourhoodProcessing.process()
  • check_radius_against_distance()
  • circular_kernel()
• improver.nbhood.recursive_filter module
  • RecursiveFilter
    • RecursiveFilter.__init__()
    • RecursiveFilter._abc_impl
    • RecursiveFilter._pad_coefficients()
    • RecursiveFilter._recurse_backward()
    • RecursiveFilter._recurse_forward()
    • RecursiveFilter._run_recursion()
    • RecursiveFilter._update_coefficients_from_mask()
    • RecursiveFilter._validate_coefficients()
    • RecursiveFilter.process()
• improver.nbhood.use_nbhood module
  • ApplyNeighbourhoodProcessingWithAMask
    • ApplyNeighbourhoodProcessingWithAMask.__init__()
    • ApplyNeighbourhoodProcessingWithAMask._abc_impl
    • ApplyNeighbourhoodProcessingWithAMask.collapse_mask_coord()
    • ApplyNeighbourhoodProcessingWithAMask.process()

Module contents

init for nbhood

radius_by_lead_time(radii, lead_times=None)

Parse radii and lead_times provided to CLIs that use neighbourhooding. If no lead times are provided, return the first radius for use at all lead times. If lead times are provided, ensure there are sufficient radii to assign one to each lead time. If so return two lists, else raise an exception.

Parameters:

• radii (List[str]) – Radii as a list provided by clize.

• lead_times (Optional[List[str]]) – Lead times as a list provided by clize, or None if not set.

Return type:

Tuple[Union[float, List[float], List[int], None]]

Returns:

• Radii as a float or list of floats.

• Lead times in hours as a list of ints or None.

Raises:

• ValueError – If multiple radii are provided without any lead times.

• ValueError – If radii and lead_times lists are on unequal lengths.