4.4.1. polar2grid package

4.4.1.1. Subpackages

• 4.4.1.1.1. polar2grid.composites package
  • 4.4.1.1.1.1. Submodules
    • 4.4.1.1.1.1.1. polar2grid.composites.enhanced module
      • SingleEnhancedBandCompositor
      • SubBandCompositor
  • 4.4.1.1.1.2. Module contents
• 4.4.1.1.2. polar2grid.core package
  • 4.4.1.1.2.1. Submodules
    • 4.4.1.1.2.1.1. polar2grid.core.containers module
      • GridDefinition
    • 4.4.1.1.2.1.2. polar2grid.core.dtype module
      • clip_to_data_type()
      • dtype_to_str()
      • int_or_float()
      • str_to_dtype()
    • 4.4.1.1.2.1.3. polar2grid.core.script_utils module
      • ArgumentParser
      • BooleanFilterAction
      • ExtendAction
      • ExtendConstAction
      • NumpyDtypeList
      • SatPyWarningFilter
      • ThirdPartyFilter
      • create_basic_parser()
      • create_exc_handler()
      • rename_log_file()
      • setup_logging()
  • 4.4.1.1.2.2. Module contents
• 4.4.1.1.3. polar2grid.enhancements package
  • 4.4.1.1.3.1. Submodules
    • 4.4.1.1.3.1.1. polar2grid.enhancements.shared module
      • _parse_palettes_for_p2g_cmap()
      • colorize()
      • palettize()
      • temperature_difference()
    • 4.4.1.1.3.1.2. polar2grid.enhancements.viirs module
      • _cloud_layers_lmh()
      • cloud_layers_lmh()
  • 4.4.1.1.3.2. Module contents
• 4.4.1.1.4. polar2grid.filters package
  • 4.4.1.1.4.1. Submodules
    • 4.4.1.1.4.1.1. polar2grid.filters._base module
      • BaseFilter
    • 4.4.1.1.4.1.2. polar2grid.filters._filter_scene module
      • _filter_scene_day_only_products()
      • _filter_scene_night_only_products()
      • _get_single_reader_filter_criteria()
      • _merge_filter_critera()
      • filter_scene()
      • get_reader_filter_criteria()
    • 4.4.1.1.4.1.3. polar2grid.filters._utils module
      • _compute_boundary_from_whole_swath()
      • boundary_for_area()
      • polygon_for_area()
    • 4.4.1.1.4.1.4. polar2grid.filters.day_night module
      • DayCoverageFilter
      • NightCoverageFilter
      • SunlightCoverageFilter
      • _get_sunlight_coverage()
      • get_twilight_poly()
      • modpi()
    • 4.4.1.1.4.1.5. polar2grid.filters.resample_coverage module
      • ResampleCoverageFilter
      • _get_intersection_coverage()
  • 4.4.1.1.4.2. Module contents
• 4.4.1.1.5. polar2grid.fonts package
  • 4.4.1.1.5.1. Module contents
• 4.4.1.1.6. polar2grid.grids package
  • 4.4.1.1.6.1. Submodules
    • 4.4.1.1.6.1.1. polar2grid.grids.config_helper module
      • _create_legacy_line()
      • _create_yaml_entry()
      • determine_projection()
      • get_parser()
      • main()
    • 4.4.1.1.6.1.2. polar2grid.grids.manager module
      • GridManager
      • _convert_numeric_parameters_to_floats()
      • _convert_origin_degrees_to_meters_if_needed()
      • _generate_valid_parts_in_config_str()
      • _only_one_specified()
      • _parse_grid_width_and_height()
      • _parse_meter_degree_param()
      • _parse_optional_config_param()
      • _parse_origin_x_y()
      • _parse_pixel_size_x_y()
      • _parse_proj4_str()
      • get_proj4_info()
      • parse_and_convert_proj4_config_line()
      • parse_proj4_config_line()
      • read_grids_config()
      • read_grids_config_str()
  • 4.4.1.1.6.2. Module contents
• 4.4.1.1.7. polar2grid.readers package
  • 4.4.1.1.7.1. Submodules
    • 4.4.1.1.7.1.1. polar2grid.readers._base module
      • ReaderProxyBase
    • 4.4.1.1.7.1.2. polar2grid.readers.abi_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.3. polar2grid.readers.abi_l2_nc module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.4. polar2grid.readers.acspo module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.5. polar2grid.readers.agri_fy4a_l1 module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.6. polar2grid.readers.agri_fy4b_l1 module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.7. polar2grid.readers.ahi_hrit module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.8. polar2grid.readers.ahi_hsd module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.9. polar2grid.readers.ami_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.10. polar2grid.readers.amsr2_l2_gaasp module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.11. polar2grid.readers.avhrr_l1b_aapp module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.12. polar2grid.readers.aws1_mwr_l1b_nc module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.13. polar2grid.readers.clavrx module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.14. polar2grid.readers.fci_l1c_nc module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.15. polar2grid.readers.glm_l2 module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.16. polar2grid.readers.mersi2_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.17. polar2grid.readers.mersi_ll_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.18. polar2grid.readers.mirs module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.19. polar2grid.readers.modis_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.20. polar2grid.readers.modis_l2 module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.21. polar2grid.readers.nucaps module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.22. polar2grid.readers.viirs_edr module
      • ReaderProxy
      • _int_or_none()
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.23. polar2grid.readers.viirs_edr_active_fires module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.24. polar2grid.readers.viirs_edr_flood module
      • ReaderProxy
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.25. polar2grid.readers.viirs_l1b module
      • ReaderProxy
      • _process_legacy_products()
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.26. polar2grid.readers.viirs_sdr module
      • ReaderProxy
      • _process_legacy_and_rad_products()
      • add_reader_argument_groups()
    • 4.4.1.1.7.1.27. polar2grid.readers.virr_l1b module
      • ReaderProxy
      • add_reader_argument_groups()
  • 4.4.1.1.7.2. Module contents
• 4.4.1.1.8. polar2grid.resample package
  • 4.4.1.1.8.1. Submodules
    • 4.4.1.1.8.1.1. polar2grid.resample._resample_scene module
      • AreaDefResolver
      • _areas_to_resample()
      • _crs_equal()
      • _default_grid()
      • _filter_and_resample_scene_to_single_area()
      • _filter_scene_with_grid_coverage()
      • _get_area_def_from_name()
      • _get_default_resampler()
      • _get_groups_to_resample()
      • _get_legacy_and_yaml_areas()
      • _get_preserve_resolution()
      • _hashable_kwargs()
      • _is_native_grid()
      • _products_to_preserve_resolution()
      • _redict_hashable_kwargs()
      • _resample_scene_to_single_area()
      • resample_scene()
    • 4.4.1.1.8.1.2. polar2grid.resample.resample_decisions module
      • ResamplerDecisionTree
  • 4.4.1.1.8.2. Module contents
• 4.4.1.1.9. polar2grid.tests package
  • 4.4.1.1.9.1. Subpackages
    • 4.4.1.1.9.1.1. polar2grid.tests.test_filters package
      • 4.4.1.1.9.1.1.1. Submodules
      • 4.4.1.1.9.1.1.2. Module contents
    • 4.4.1.1.9.1.2. polar2grid.tests.test_grids package
      • 4.4.1.1.9.1.2.1. Submodules
      • 4.4.1.1.9.1.2.2. Module contents
    • 4.4.1.1.9.1.3. polar2grid.tests.test_readers package
      • 4.4.1.1.9.1.3.1. Submodules
      • 4.4.1.1.9.1.3.2. Module contents
    • 4.4.1.1.9.1.4. polar2grid.tests.test_resample package
      • 4.4.1.1.9.1.4.1. Submodules
      • 4.4.1.1.9.1.4.2. Module contents
    • 4.4.1.1.9.1.5. polar2grid.tests.test_utils package
      • 4.4.1.1.9.1.5.1. Submodules
      • 4.4.1.1.9.1.5.2. Module contents
    • 4.4.1.1.9.1.6. polar2grid.tests.test_writers package
      • 4.4.1.1.9.1.6.1. Submodules
      • 4.4.1.1.9.1.6.2. Module contents
  • 4.4.1.1.9.2. Submodules
    • 4.4.1.1.9.2.1. polar2grid.tests._abi_fixtures module
      • abi_l1b_airmass_data_array()
      • abi_l1b_airmass_scene()
      • abi_l1b_c01_data_array()
      • abi_l1b_c01_scene()
      • goes_east_conus_area_def()
    • 4.4.1.1.9.2.2. polar2grid.tests._avhrr_fixtures module
      • avhrr_l1b_1_data_array()
      • avhrr_l1b_1_scene()
      • avhrr_l1b_2_data_array()
      • avhrr_l1b_3a_data_array()
      • avhrr_l1b_4_data_array()
      • avhrr_l1b_5_data_array()
      • avhrr_l1b_swath_def()
    • 4.4.1.1.9.2.3. polar2grid.tests._fixture_utils module
      • _FakeReader
      • _TestingScene
      • generate_lonlat_data()
    • 4.4.1.1.9.2.4. polar2grid.tests._viirs_fixtures module
      • _viirs_sdr_angles_dict()
      • full_viirs_data_array_dict()
      • viirs_sdr_dnb_data_array()
      • viirs_sdr_dnb_dict()
      • viirs_sdr_dnb_swath_def()
      • viirs_sdr_full_scene()
      • viirs_sdr_i01_data_array()
      • viirs_sdr_i01_scene()
      • viirs_sdr_i04_data_array()
      • viirs_sdr_i_dict()
      • viirs_sdr_i_swath_def()
      • viirs_sdr_m01_data_array()
      • viirs_sdr_m12_data_array()
      • viirs_sdr_m_dict()
      • viirs_sdr_m_swath_def()
    • 4.4.1.1.9.2.5. polar2grid.tests.conftest module
      • _forbid_pyspectral_downloads()
      • builtin_grids_yaml()
      • builtin_test_grids_conf()
      • chtmpdir()
      • clear_cached_functions()
      • ensure_logging_framework_not_altered()
      • pytest_configure()
    • 4.4.1.1.9.2.6. polar2grid.tests.test_add_coastlines module
      • _check_exp_image_colors()
      • _check_used_colormap()
      • _create_csv_cmap_and_extra_tags()
      • _create_fake_l_geotiff()
      • _create_fake_l_geotiff_colormap()
      • _create_fake_rgb_geotiff()
      • _shared_fake_geotiff_kwargs()
      • _shared_fake_l_geotiff_data()
      • _shared_fake_rgb_geotiff_data()
      • mocked_pydecorate_add_scale()
      • test_add_coastlines_bad_output_filenames()
      • test_add_coastlines_basic()
      • test_add_coastlines_help()
      • test_add_coastlines_multiple_inputs()
    • 4.4.1.1.9.2.7. polar2grid.tests.test_add_colormap module
      • test_add_colormap_basic_l()
      • test_add_colormap_help()
    • 4.4.1.1.9.2.8. polar2grid.tests.test_compare module
      • _can_generate_thumbnails()
      • _check_html_output()
      • _check_num_diff_files()
      • _create_awips_tiled()
      • _create_binaries()
      • _create_geotiffs()
      • _create_hdf5()
      • _create_hdf5_with_groups()
      • _files_per_variable()
      • _get_exp_num_png_files()
      • _is_multivar_format()
      • _nonvariable_png_files()
      • test_basic_compare()
    • 4.4.1.1.9.2.9. polar2grid.tests.test_configs module
      • pytest_generate_tests()
      • test_valid_yaml_files()
    • 4.4.1.1.9.2.10. polar2grid.tests.test_dtype module
      • test_dtype_to_str()
      • test_str_to_dtype()
    • 4.4.1.1.9.2.11. polar2grid.tests.test_enhancements module
      • TestP2GEnhancements
      • easy_cwd()
    • 4.4.1.1.9.2.12. polar2grid.tests.test_glue module
      • TestGlueFakeScene
      • TestGlueWithVIIRS
      • _create_empty_viirs_sdrs()
      • _create_fake_comp()
      • _create_fake_comp_enh()
      • extra_viirs_comp_and_enh()
      • extra_viirs_composite_path()
      • extra_viirs_enhancement_file()
      • prepare_glue_exec()
      • set_env()
      • test_geo2grid_help()
      • test_polar2grid_help()
      • test_polar2grid_help_unknown_writer()
    • 4.4.1.1.9.2.13. polar2grid.tests.test_main module
      • test_call_main_script()
      • test_main_call()
  • 4.4.1.1.9.3. Module contents
• 4.4.1.1.10. polar2grid.utils package
  • 4.4.1.1.10.1. Submodules
    • 4.4.1.1.10.1.1. polar2grid.utils.config module
      • _is_editable_installation()
      • add_polar2grid_config_paths()
      • get_polar2grid_etc()
      • get_polar2grid_home()
      • recursive_dict_update()
    • 4.4.1.1.10.1.2. polar2grid.utils.convert_grids_conf_to_yaml module
      • _add_origin()
      • _add_resolution()
      • _add_shape()
      • _conf_to_yaml_dict()
      • _remove_unnecessary_proj_params()
      • crs_to_proj_dict()
      • get_parser()
      • grid_info_to_yaml_dict()
      • main()
      • ordered_dump()
    • 4.4.1.1.10.1.3. polar2grid.utils.create_awips_debug_tiles module
      • _gradient_data()
      • _valid_range_for_idtype()
      • add_fake_awips_template()
      • main()
    • 4.4.1.1.10.1.4. polar2grid.utils.dynamic_imports module
      • _get_component_attr()
      • get_reader_attr()
      • get_writer_attr()
    • 4.4.1.1.10.1.5. polar2grid.utils.legacy_compat module
      • AliasHandler
      • _generate_old_p2g_date_formats()
      • _get_matching_satpy_id()
      • _warn_on_format_replaced()
      • convert_p2g_pattern_to_satpy()
      • get_sensor_alias()
    • 4.4.1.1.10.1.6. polar2grid.utils.search_noaa_s3_viirs module
      • _convert_file_times_to_datetimes()
      • _filter_by_start_end()
      • _generate_glob_patterns()
      • _glob_s3_fs()
      • _overlaps_time_range()
      • _print_uris()
      • band_to_prefix()
      • build_parser()
      • file_start_end_time()
      • iter_day_prefixes()
      • main()
      • parse_band()
      • parse_datetime()
    • 4.4.1.1.10.1.7. polar2grid.utils.warnings module
      • ignore_no_georef()
      • ignore_pyproj_proj_warnings()
  • 4.4.1.1.10.2. Module contents
• 4.4.1.1.11. polar2grid.writers package
  • 4.4.1.1.11.1. Submodules
    • 4.4.1.1.11.1.1. polar2grid.writers.awips_tiled module
      • 4.4.1.1.11.1.1.1. Numbered versus Lettered Grids
      • add_writer_argument_groups()
    • 4.4.1.1.11.1.2. polar2grid.writers.binary module
      • FlatBinaryWriter
      • add_writer_argument_groups()
    • 4.4.1.1.11.1.3. polar2grid.writers.cf module
      • add_writer_argument_groups()
    • 4.4.1.1.11.1.4. polar2grid.writers.geotiff module
      • _check_tags()
      • add_writer_argument_groups()
    • 4.4.1.1.11.1.5. polar2grid.writers.hdf5 module
      • FakeHDF5
      • HDF5Writer
      • add_writer_argument_groups()
      • all_equal()
  • 4.4.1.1.11.2. Module contents

4.4.1.2. Submodules

• 4.4.1.2.1. polar2grid.__main__ module
  • g2g_main()
  • p2g_main()
• 4.4.1.2.2. polar2grid._glue_argparser module
  • GlueArgumentParser
    • GlueArgumentParser._parse_one_writer_args()
    • GlueArgumentParser._parse_reader_args()
    • GlueArgumentParser._separate_scene_init_load_args()
  • _add_common_arguments()
  • _add_component_parser_args()
  • _args_to_dict()
  • _convert_reader_name()
  • _convert_writer_name()
  • _filenames_from_local()
  • _fsfiles_for_s3()
  • _main_args()
  • _retitle_optional_arguments()
  • _supported_readers()
  • _supported_writers()
  • _validate_reader_writer_args()
  • add_resample_argument_groups()
  • add_scene_argument_groups()
  • add_writer_argument_groups()
  • float_or_false()
  • get_default_output_filename()
  • get_input_files()
  • get_p2g_defaults_env_var()
  • get_reader_parser_function()
  • get_writer_parser_function()
• 4.4.1.2.3. polar2grid.add_coastlines module
  • _add_borders_arguments()
  • _add_coastlines_arguments()
  • _add_colorbar_arguments()
  • _add_colorbar_to_image()
  • _add_global_arguments()
  • _add_grid_arguments()
  • _add_rivers_arguments()
  • _apply_decorator_alignment()
  • _args_to_borders_dict()
  • _args_to_coastlines_dict()
  • _args_to_colorbar_kwargs()
  • _args_to_grid_dict()
  • _args_to_pycoast_dict()
  • _args_to_rivers_dict()
  • _convert_scale_offset_to_float()
  • _convert_table_to_cmap_or_default_bw()
  • _get_colorbar_vmin_vmax()
  • _get_colormap_object()
  • _get_rio_colormap()
  • _process_one_image()
  • _vmin_vmax_from_scale_offset()
  • find_font()
  • get_parser()
  • main()
• 4.4.1.2.4. polar2grid.add_colormap module
  • add_colortable()
  • create_colortable()
  • get_parser()
  • load_color_table_file_to_colormap()
  • main()
• 4.4.1.2.5. polar2grid.compare module
  • ArrayComparisonResult
    • ArrayComparisonResult.almost_equal
    • ArrayComparisonResult.diff_percentage
    • ArrayComparisonResult.different_shape
    • ArrayComparisonResult.failed
    • ArrayComparisonResult.num_diff_pixels
    • ArrayComparisonResult.total_pixels
  • CompareHelper
    • CompareHelper.compare()
    • CompareHelper.compare_dirs()
    • CompareHelper.compare_files()
  • FileComparisonResults
    • FileComparisonResults.any_failed
    • FileComparisonResults.file1
    • FileComparisonResults.file2
    • FileComparisonResults.files_missing
    • FileComparisonResults.sub_results
    • FileComparisonResults.unknown_file_type
  • FlatArrayComparisonResult
    • FlatArrayComparisonResult.dtype1
    • FlatArrayComparisonResult.dtype2
    • FlatArrayComparisonResult.shape1
    • FlatArrayComparisonResult.shape2
  • VariableComparisonResult
    • VariableComparisonResult.failed
    • VariableComparisonResult.variable
    • VariableComparisonResult.variable_missing
  • _compare_gtiff_colormaps()
  • _file_type()
  • _generate_html_summary()
  • _generate_matplotlib_1d_thumbnail()
  • _generate_matplotlib_thumbnail()
  • _generate_pillow_thumbnail()
  • _generate_subresult_table_row()
  • _generate_table_rows()
  • _generate_thumbnail()
  • _generate_thumbnail_html()
  • _get_binary_array()
  • _get_geotiff_array()
  • _get_geotiff_colormap()
  • _get_hdf5_array()
  • _get_hdf5_variables()
  • _get_image_array()
  • _get_mpl_figsize()
  • _get_netcdf_array()
  • _get_thumbnail_array()
  • _tranpose_for_thumbnail_if_multiband_array()
  • compare_array()
  • compare_binary()
  • compare_geotiff()
  • compare_hdf5()
  • compare_image()
  • compare_netcdf()
  • isclose_array()
  • main()
  • num_failed_files()
  • plot_array()
• 4.4.1.2.6. polar2grid.debug_data module
  • main()
• 4.4.1.2.7. polar2grid.glue module
  • _GlueProcessor
    • _GlueProcessor._handle_extra_config_paths()
    • _GlueProcessor._run_processing()
    • _GlueProcessor.cleanup()
  • _add_extra_config_paths()
  • _assign_default_native_area_id()
  • _check_valid_config_paths()
  • _create_profile_html_if()
  • _create_scene()
  • _create_tmp_enhancement_config_dir()
  • _get_glue_name()
  • _get_platform_name_alias()
  • _handle_missing_deps_keyerror()
  • _overwrite_platform_name_with_aliases()
  • _overwrite_sensor_with_aliases()
  • _persist_swath_definition_in_scene()
  • _prepare_initial_logging()
  • _print_list_products()
  • _resample_scene_to_grids()
  • _save_scenes()
  • _set_preferred_chunk_size()
  • _swaths_to_persist()
  • _write_scene()
  • _write_scene_with_writer()
  • main()

4.4.1.3. Module contents

Polar2Grid main package.