improver.utilities package

Submodules

• improver.utilities.cli_utilities module
  • load_json_or_none()
  • load_pickle_or_none()
• improver.utilities.common_input_handle module
  • as_cube()
  • as_cubelist()
  • as_iterable()
• improver.utilities.compare module
  • compare_attributes()
  • compare_data()
  • compare_datasets()
  • compare_dims()
  • compare_netcdfs()
  • compare_objects()
  • compare_pickled_forest()
  • compare_vars()
• improver.utilities.complex_conversion module
  • complex_to_deg()
  • deg_to_complex()
• improver.utilities.copy_metadata module
  • CopyMetadata
    • CopyMetadata.__init__()
    • CopyMetadata._abc_impl
    • CopyMetadata.find_common_attributes()
    • CopyMetadata.get_most_recent_history()
    • CopyMetadata.process()
• improver.utilities.cube_checker module
  • assert_spatial_coords_match()
  • assert_time_coords_valid()
  • check_cube_coordinates()
  • check_for_x_and_y_axes()
  • find_dimension_coordinate_mismatch()
  • spatial_coords_match()
  • validate_cube_dimensions()
• improver.utilities.cube_constraints module
  • create_sorted_lambda_constraint()
• improver.utilities.cube_extraction module
  • ExtractLevel
    • ExtractLevel.__init__()
    • ExtractLevel._abc_impl
    • ExtractLevel._make_template_cube()
    • ExtractLevel._one_way_fill()
    • ExtractLevel.coordinate_grid()
    • ExtractLevel.fill_invalid()
    • ExtractLevel.process()
  • ExtractSubCube
    • ExtractSubCube.__init__()
    • ExtractSubCube._abc_impl
    • ExtractSubCube.process()
  • apply_extraction()
  • create_constraint()
  • cubelist_extract()
  • extract_subcube()
  • parse_constraint_list()
  • parse_range_string_to_dict()
  • thin_cube()
• improver.utilities.cube_manipulation module
  • MergeCubes
    • MergeCubes.__init__()
    • MergeCubes._abc_impl
    • MergeCubes._check_time_bounds_ranges()
    • MergeCubes._equalise_cell_methods()
    • MergeCubes.process()
  • add_coordinate_to_cube()
  • clip_cube_data()
  • collapse_realizations()
  • collapse_time()
  • collapsed()
  • compare_ancillary_variables()
  • compare_attributes()
  • compare_coords()
  • convert_aux_coord_to_ancillary_variable()
  • enforce_coordinate_ordering()
  • expand_bounds()
  • filter_realizations()
  • get_ancillary_variable_names()
  • get_coord_names()
  • get_dim_coord_names()
  • get_filtered_attributes()
  • height_of_maximum()
  • manipulate_n_realizations()
  • maximum_in_height()
  • sort_coord_in_cube()
  • strip_var_names()
• improver.utilities.deterministic_realization_selector module
  • DeterministicRealizationSelector
    • DeterministicRealizationSelector.__init__()
    • DeterministicRealizationSelector._abc_impl
    • DeterministicRealizationSelector.extract_cluster_from_cube()
    • DeterministicRealizationSelector.find_target_key()
    • DeterministicRealizationSelector.process()
    • DeterministicRealizationSelector.split_input_cubelist()
• improver.utilities.expand_realization_dimension module
  • ExpandRealizationDimension
    • ExpandRealizationDimension.__init__()
    • ExpandRealizationDimension._abc_impl
    • ExpandRealizationDimension.process()
• improver.utilities.extract_from_table module
  • ExtractValueFromTable
    • ExtractValueFromTable.__init__()
    • ExtractValueFromTable._abc_impl
    • ExtractValueFromTable.convert_dict_to_dataframe()
    • ExtractValueFromTable.extract_table_values()
    • ExtractValueFromTable.nearest_lower_index()
    • ExtractValueFromTable.process()
• improver.utilities.flatten module
  • flatten()
• improver.utilities.forecast_reference_enforcement module
  • EnforceConsistentForecasts
    • EnforceConsistentForecasts.__init__()
    • EnforceConsistentForecasts._abc_impl
    • EnforceConsistentForecasts.calculate_bound()
    • EnforceConsistentForecasts.process()
  • normalise_to_reference()
  • split_cubes_by_name()
• improver.utilities.generalized_additive_models module
  • GAMFit
    • GAMFit.__init__()
    • GAMFit._abc_impl
    • GAMFit.create_pygam_model()
    • GAMFit.process()
  • GAMPredict
    • GAMPredict.__init__()
    • GAMPredict._abc_impl
    • GAMPredict.clip_predictors()
    • GAMPredict.process()
• improver.utilities.gradient_between_vertical_levels module
  • GradientBetweenVerticalLevels
    • GradientBetweenVerticalLevels._abc_impl
    • GradientBetweenVerticalLevels.extract_cube_from_list()
    • GradientBetweenVerticalLevels.gradient_over_vertical_levels()
    • GradientBetweenVerticalLevels.process()
• improver.utilities.indexing_operations module
  • choose()
• improver.utilities.interpolation module
  • InterpolateUsingDifference
    • InterpolateUsingDifference.__init__()
    • InterpolateUsingDifference._abc_impl
    • InterpolateUsingDifference._check_inputs()
    • InterpolateUsingDifference.process()
  • interpolate_missing_data()
• improver.utilities.load module
  • load_baseline_cube()
  • load_cube()
  • load_cubelist()
• improver.utilities.mask module
  • apply_mask()
• improver.utilities.masking module
  • as_masked_array()
• improver.utilities.mathematical_operations module
  • CalculateClimateAnomalies
    • CalculateClimateAnomalies.__init__()
    • CalculateClimateAnomalies._abc_impl
    • CalculateClimateAnomalies._add_reference_epoch_metadata()
    • CalculateClimateAnomalies._create_output_cube()
    • CalculateClimateAnomalies._update_cube_name_and_units()
    • CalculateClimateAnomalies.calculate_anomalies()
    • CalculateClimateAnomalies.process()
    • CalculateClimateAnomalies.verify_units_match()
  • CalculateForecastValueFromClimateAnomaly
    • CalculateForecastValueFromClimateAnomaly.__init__()
    • CalculateForecastValueFromClimateAnomaly._abc_impl
    • CalculateForecastValueFromClimateAnomaly._create_output_cube()
    • CalculateForecastValueFromClimateAnomaly._remove_reference_epoch_metadata()
    • CalculateForecastValueFromClimateAnomaly._update_cube_name_and_units()
    • CalculateForecastValueFromClimateAnomaly.calculate_forecast_value()
    • CalculateForecastValueFromClimateAnomaly.process()
    • CalculateForecastValueFromClimateAnomaly.verify_inputs_for_forecast()
    • CalculateForecastValueFromClimateAnomaly.verify_units_match()
  • Integration
    • Integration.__init__()
    • Integration._abc_impl
    • Integration._create_output_cube()
    • Integration._generate_output_name_and_units()
    • Integration.ensure_monotonic_increase_in_chosen_direction()
    • Integration.perform_integration()
    • Integration.prepare_for_integration()
    • Integration.process()
  • fast_linear_fit()
  • verify_time_coords_match()
• improver.utilities.neighbourhood_tools module
  • boxsum()
  • pad_and_roll()
  • pad_boxsum()
  • rolling_window()
• improver.utilities.pad_spatial module
  • _create_cube_with_padded_data()
  • create_cube_with_halo()
  • pad_coord()
  • pad_cube_with_halo()
  • remove_cube_halo()
  • remove_halo_from_cube()
• improver.utilities.probability_manipulation module
  • comparison_operator_dict()
  • invert_probabilities()
  • to_threshold_inequality()
• improver.utilities.redirect_stdout module
  • redirect_stdout()
• improver.utilities.rescale module
  • apply_double_scaling()
  • rescale()
• improver.utilities.round module
  • round_close()
• improver.utilities.save module
  • _check_metadata()
  • _cube_attributes_for_save()
  • _order_cell_methods()
  • save_netcdf()
• improver.utilities.solar module
  • DayNightMask
    • DayNightMask.__init__()
    • DayNightMask._abc_impl
    • DayNightMask._create_daynight_mask()
    • DayNightMask._daynight_lat_lon_cube()
    • DayNightMask.process()
  • calc_solar_declination()
  • calc_solar_elevation()
  • calc_solar_hour_angle()
  • calc_solar_time()
  • daynight_terminator()
  • get_day_of_year()
  • get_hour_of_day()
• improver.utilities.spatial module
  • BaseDistanceCalculator
    • BaseDistanceCalculator.__init__()
    • BaseDistanceCalculator._abc_impl
    • BaseDistanceCalculator._get_x_distances()
    • BaseDistanceCalculator._get_y_distances()
    • BaseDistanceCalculator.build_distances_cube()
    • BaseDistanceCalculator.get_difference_axes()
    • BaseDistanceCalculator.get_distances()
    • BaseDistanceCalculator.get_midpoints()
  • DifferenceBetweenAdjacentGridSquares
    • DifferenceBetweenAdjacentGridSquares._abc_impl
    • DifferenceBetweenAdjacentGridSquares._axis_wraps_around_meridian()
    • DifferenceBetweenAdjacentGridSquares._update_metadata()
    • DifferenceBetweenAdjacentGridSquares.calculate_difference()
    • DifferenceBetweenAdjacentGridSquares.create_difference_cube()
    • DifferenceBetweenAdjacentGridSquares.process()
  • DistanceBetweenGridSquares
    • DistanceBetweenGridSquares._abc_impl
    • DistanceBetweenGridSquares._cube_xy_dimensions_are_distances()
    • DistanceBetweenGridSquares._get_cube_spatial_type()
    • DistanceBetweenGridSquares._select_distance_calculator()
    • DistanceBetweenGridSquares.process()
  • GradientBetweenAdjacentGridSquares
    • GradientBetweenAdjacentGridSquares.__init__()
    • GradientBetweenAdjacentGridSquares._abc_impl
    • GradientBetweenAdjacentGridSquares._create_output_cube()
    • GradientBetweenAdjacentGridSquares.process()
  • LatLonCubeDistanceCalculator
    • LatLonCubeDistanceCalculator._abc_impl
    • LatLonCubeDistanceCalculator._get_cube_latlon_points()
    • LatLonCubeDistanceCalculator._get_x_distances()
    • LatLonCubeDistanceCalculator._get_y_distances()
  • OccurrenceWithinVicinity
    • OccurrenceWithinVicinity.SUPPORTED_VICINITY_CELL_METHODS
    • OccurrenceWithinVicinity.SUPPORTED_VICINITY_OPERATORS
    • OccurrenceWithinVicinity.__init__()
    • OccurrenceWithinVicinity._abc_impl
    • OccurrenceWithinVicinity.process()
  • ProjectionCubeDistanceCalculator
    • ProjectionCubeDistanceCalculator.__init__()
    • ProjectionCubeDistanceCalculator._abc_impl
    • ProjectionCubeDistanceCalculator._get_x_distances()
    • ProjectionCubeDistanceCalculator._get_y_distances()
  • add_vicinity_coordinate()
  • calculate_grid_spacing()
  • check_if_grid_is_equal_area()
  • create_vicinity_coord()
  • distance_to_number_of_grid_cells()
  • get_grid_y_x_values()
  • lat_lon_determine()
  • maximum_within_vicinity()
  • mean_within_vicinity()
  • minimum_within_vicinity()
  • number_of_grid_cells_to_distance()
  • operator_within_vicinity()
  • rename_vicinity_cube()
  • set_vicinity_cell_method()
  • std_within_vicinity()
  • transform_grid_to_lat_lon()
  • update_name_and_vicinity_coord()
• improver.utilities.statistical module
  • DistributionalParameters
    • DistributionalParameters.__init__()
    • DistributionalParameters._abc_impl
    • DistributionalParameters._gamma_parameters()
    • DistributionalParameters._normal_parameters()
    • DistributionalParameters._truncated_normal_parameters()
    • DistributionalParameters.process()
• improver.utilities.temporal module
  • cycletime_to_datetime()
  • cycletime_to_number()
  • datetime_constraint()
  • datetime_to_cycletime()
  • datetime_to_iris_time()
  • extract_cube_at_time()
  • extract_nearest_time_point()
  • integrate_time()
  • iris_time_to_datetime()
  • relabel_to_period()
  • reset_forecast_reference_time_and_period()
• improver.utilities.temporal_interpolation module
  • DurationSubdivision
    • DurationSubdivision.__init__()
    • DurationSubdivision._compute_renormalisation_factor()
    • DurationSubdivision._make_fidelity_cube()
    • DurationSubdivision._process_target_period()
    • DurationSubdivision.allocate_data_for_target_period()
    • DurationSubdivision.cube_period()
    • DurationSubdivision.process()
  • ForecastTrajectoryGapFiller
    • ForecastTrajectoryGapFiller.__init__()
    • ForecastTrajectoryGapFiller._abc_impl
    • ForecastTrajectoryGapFiller._assemble_final_cubelist()
    • ForecastTrajectoryGapFiller._calculate_target_time()
    • ForecastTrajectoryGapFiller._create_gap_filling_tasks()
    • ForecastTrajectoryGapFiller._create_regeneration_tasks()
    • ForecastTrajectoryGapFiller._extract_cube_for_period()
    • ForecastTrajectoryGapFiller._get_forecast_periods()
    • ForecastTrajectoryGapFiller._identify_gaps()
    • ForecastTrajectoryGapFiller._identify_periods_to_regenerate()
    • ForecastTrajectoryGapFiller._identify_source_transitions()
    • ForecastTrajectoryGapFiller._interpolate_batch_periods()
    • ForecastTrajectoryGapFiller._parse_cluster_sources()
    • ForecastTrajectoryGapFiller._validate_input()
    • ForecastTrajectoryGapFiller.process()
  • GoogleFilmInterpolation
    • GoogleFilmInterpolation.__init__()
    • GoogleFilmInterpolation._abc_impl
    • GoogleFilmInterpolation._apply_clipping()
    • GoogleFilmInterpolation._apply_scaling()
    • GoogleFilmInterpolation._finalise_interpolated_cube()
    • GoogleFilmInterpolation._interpolate_no_extra_dim()
    • GoogleFilmInterpolation._interpolate_with_extra_dim()
    • GoogleFilmInterpolation._reverse_scaling()
    • GoogleFilmInterpolation._run_google_film()
    • GoogleFilmInterpolation.process()
  • TemporalInterpolation
    • TemporalInterpolation.__init__()
    • TemporalInterpolation._abc_impl
    • TemporalInterpolation._calculate_accumulation()
    • TemporalInterpolation.add_bounds()
    • TemporalInterpolation.calc_lats_lons()
    • TemporalInterpolation.calc_sin_phi()
    • TemporalInterpolation.construct_time_list()
    • TemporalInterpolation.daynight_interpolate()
    • TemporalInterpolation.enforce_time_coords_dtype()
    • TemporalInterpolation.process()
    • TemporalInterpolation.solar_interpolate()
  • _as_tuple_if_list()
  • _run_film_chunk()
  • _run_film_chunk_mp()
  • load_model()
• improver.utilities.textural module
  • FieldTexture
    • FieldTexture.__init__()
    • FieldTexture._abc_impl
    • FieldTexture._calculate_ratio()
    • FieldTexture._calculate_transitions()
    • FieldTexture.process()
• improver.utilities.threshold_interpolation module
  • ThresholdInterpolation
    • ThresholdInterpolation.__init__()
    • ThresholdInterpolation._abc_impl
    • ThresholdInterpolation._interpolate_thresholds()
    • ThresholdInterpolation.create_cube_with_thresholds()
    • ThresholdInterpolation.mask_checking()
    • ThresholdInterpolation.process()
• improver.utilities.time_lagging module
  • GenerateTimeLaggedEnsemble
    • GenerateTimeLaggedEnsemble.__init__()
    • GenerateTimeLaggedEnsemble._abc_impl
    • GenerateTimeLaggedEnsemble._check_validity_times_match()
    • GenerateTimeLaggedEnsemble._rebadge_duplicate_realizations()
    • GenerateTimeLaggedEnsemble.add_realization_coord()
    • GenerateTimeLaggedEnsemble.process()

Module contents