API

• fqpr_convenience module
  • HSTB.kluster.fqpr_convenience Module
    • Functions
      • convert_multibeam
        • convert_multibeam()
      • generate_new_mosaic
        • generate_new_mosaic()
      • generate_new_surface
        • generate_new_surface()
      • get_attributes_from_fqpr
        • get_attributes_from_fqpr()
      • get_attributes_from_zarr_stores
        • get_attributes_from_zarr_stores()
      • import_processed_navigation
        • import_processed_navigation()
      • import_sound_velocity
        • import_sound_velocity()
      • overwrite_raw_navigation
        • overwrite_raw_navigation()
      • perform_all_processing
        • perform_all_processing()
      • points_to_surface
        • points_to_surface()
      • process_multibeam
        • process_multibeam()
      • reload_data
        • reload_data()
      • reload_surface
        • reload_surface()
      • reprocess_sounding_selection
        • reprocess_sounding_selection()
      • return_avg_tables
        • return_avg_tables()
      • return_processed_data_folders
        • return_processed_data_folders()
      • return_svcorr_xyz
        • return_svcorr_xyz()
      • update_surface
        • update_surface()
      • validation_against_xyz88
        • validation_against_xyz88()
• fqpr_generation module
  • HSTB.kluster.fqpr_generation Module
    • Functions
      • get_ping_times
        • get_ping_times()
      • validate_kluster_input_datum
        • validate_kluster_input_datum()
    • Classes
      • Fqpr
        • Fqpr
          • Fqpr.has_sbet
          • Fqpr.input_datum
          • Fqpr.last_operation_date
          • Fqpr.max_time
          • Fqpr.min_time
          • Fqpr.multibeam_extension
          • Fqpr.number_of_heads
          • Fqpr.number_of_pings
          • Fqpr.sbet_navigation
          • Fqpr.sonar_model
          • Fqpr.status
          • Fqpr.total_distance_meters
          • Fqpr.calc_max_var()
          • Fqpr.calc_min_var()
          • Fqpr.calculate_total_uncertainty()
          • Fqpr.close()
          • Fqpr.construct_crs()
          • Fqpr.copy()
          • Fqpr.determine_altitude_corr()
          • Fqpr.determine_induced_heave()
          • Fqpr.export_dataset()
          • Fqpr.export_lines_to_file()
          • Fqpr.export_pings_to_file()
          • Fqpr.export_soundings_to_file()
          • Fqpr.export_tracklines_to_file()
          • Fqpr.export_variable()
          • Fqpr.fix_indices()
          • Fqpr.generate_starter_orientation_vectors()
          • Fqpr.georef_xyz()
          • Fqpr.get_beam_pointing_vectors()
          • Fqpr.get_cluster_params()
          • Fqpr.get_orientation_vectors()
          • Fqpr.get_variable_by_filter()
          • Fqpr.import_post_processed_navigation()
          • Fqpr.import_sound_velocity_files()
          • Fqpr.initial_att_interpolation()
          • Fqpr.initialize_intermediate_data()
          • Fqpr.initialize_log()
          • Fqpr.interp_to_ping_record()
          • Fqpr.intersects()
          • Fqpr.is_processed()
          • Fqpr.line_attributes()
          • Fqpr.line_is_processed()
          • Fqpr.overwrite_raw_navigation()
          • Fqpr.process_backscatter()
          • Fqpr.read_from_source()
          • Fqpr.remove_post_processed_navigation()
          • Fqpr.remove_profile()
          • Fqpr.restore_subset()
          • Fqpr.return_additional_xyz_offsets()
          • Fqpr.return_all_profiles()
          • Fqpr.return_applicable_casts()
          • Fqpr.return_cast_dict()
          • Fqpr.return_cast_idx_nearestindistance()
          • Fqpr.return_cast_idx_nearestindistance_fourhours()
          • Fqpr.return_cast_idx_nearestintime()
          • Fqpr.return_cast_idx_nearestintime_fourhours()
          • Fqpr.return_chunk_indices()
          • Fqpr.return_line_dict()
          • Fqpr.return_line_time()
          • Fqpr.return_line_xyzrph()
          • Fqpr.return_lines_for_times()
          • Fqpr.return_navigation()
          • Fqpr.return_next_action()
          • Fqpr.return_next_unprocessed_line()
          • Fqpr.return_processing_dashboard()
          • Fqpr.return_rounded_frequency()
          • Fqpr.return_runtime_idx_nearestintime()
          • Fqpr.return_soundings_in_polygon()
          • Fqpr.return_total_pings()
          • Fqpr.return_total_soundings()
          • Fqpr.return_unique_mode()
          • Fqpr.run_filter()
          • Fqpr.set_filter_by_polygon()
          • Fqpr.set_variable_by_filter()
          • Fqpr.set_vertical_reference()
          • Fqpr.subset_by_lines()
          • Fqpr.subset_by_time()
          • Fqpr.subset_by_time_and_beam()
          • Fqpr.subset_by_times()
          • Fqpr.subset_variables()
          • Fqpr.subset_variables_by_line()
          • Fqpr.sv_correct()
          • Fqpr.write_attribute_to_ping_records()
          • Fqpr.write_intermediate_futs_to_zarr()
• fqpr_project module
  • HSTB.kluster.fqpr_project Module
    • Functions
      • create_new_project
        • create_new_project()
      • open_project
        • open_project()
      • reprocess_fqprs
        • reprocess_fqprs()
      • return_project_data
        • return_project_data()
    • Classes
      • FqprProject
        • FqprProject
          • FqprProject.absolute_path_from_relative()
          • FqprProject.add_fqpr()
          • FqprProject.add_surface()
          • FqprProject.add_vessel_file()
          • FqprProject.build_visualizations()
          • FqprProject.close()
          • FqprProject.get_dask_client()
          • FqprProject.get_fqpr_by_serial_number()
          • FqprProject.get_fqprs_by_paths()
          • FqprProject.new_project_from_directory()
          • FqprProject.open_project()
          • FqprProject.path_relative_to_project()
          • FqprProject.refresh_fqpr_attribution()
          • FqprProject.regenerate_fqpr_lines()
          • FqprProject.remove_fqpr()
          • FqprProject.remove_surface()
          • FqprProject.retrieve_data_for_time_segments()
          • FqprProject.return_fqpr_instances()
          • FqprProject.return_fqpr_paths()
          • FqprProject.return_line_navigation()
          • FqprProject.return_line_owner()
          • FqprProject.return_lines_in_box()
          • FqprProject.return_project_folder()
          • FqprProject.return_project_lines()
          • FqprProject.return_sorted_line_list()
          • FqprProject.return_soundings_in_polygon()
          • FqprProject.return_surface()
          • FqprProject.return_surface_containers()
          • FqprProject.return_surface_paths()
          • FqprProject.return_vessel_file()
          • FqprProject.run_auto_patch_test()
          • FqprProject.save_project()
          • FqprProject.set_settings()
          • FqprProject.sort_lines_patch_test_pairs()
          • FqprProject.update_surface()
• fqpr_intelligence module
  • HSTB.kluster.fqpr_intelligence Module
    • Functions
      • gather_basic_file_info
        • gather_basic_file_info()
      • gather_exportlogfile_info
        • gather_exportlogfile_info()
      • gather_multibeam_info
        • gather_multibeam_info()
      • gather_naverrorfile_info
        • gather_naverrorfile_info()
      • gather_navfile_info
        • gather_navfile_info()
      • gather_svp_info
        • gather_svp_info()
      • intel_process
        • intel_process()
      • intel_process_service
        • intel_process_service()
      • likelihood_file_name_match
        • likelihood_file_name_match()
      • likelihood_files_are_close
        • likelihood_files_are_close()
      • likelihood_start_end_times_close
        • likelihood_start_end_times_close()
    • Classes
      • FqprIntel
        • FqprIntel
          • FqprIntel.has_actions
          • FqprIntel.add_file()
          • FqprIntel.bind_to_action_update()
          • FqprIntel.clear()
          • FqprIntel.execute_action()
          • FqprIntel.match_multibeam_files_to_project()
          • FqprIntel.match_navigation_files()
          • FqprIntel.match_navigation_files_to_project()
          • FqprIntel.match_svp_files_to_project()
          • FqprIntel.regenerate_actions()
          • FqprIntel.remove_file()
          • FqprIntel.return_intel_modules()
          • FqprIntel.set_auto_processing_mode()
          • FqprIntel.set_designated_surface()
          • FqprIntel.set_settings()
          • FqprIntel.start_folder_monitor()
          • FqprIntel.stop_folder_monitor()
          • FqprIntel.update_actions_client()
          • FqprIntel.update_from_project()
          • FqprIntel.update_intel_for_action_results()
          • FqprIntel.update_matches()
      • IntelModule
        • IntelModule
          • IntelModule.add_dict()
          • IntelModule.clear()
          • IntelModule.remove_file()
      • MultibeamModule
        • MultibeamModule
          • MultibeamModule.file_path_sorted_by_time()
          • MultibeamModule.remove_file()
      • NavErrorModule
        • NavErrorModule
          • NavErrorModule.remove_file()
      • NavExportLogModule
        • NavExportLogModule
          • NavExportLogModule.remove_file()
      • NavigationModule
        • NavigationModule
          • NavigationModule.remove_file()
      • SvpModule
        • SvpModule
          • SvpModule.remove_file()
• fqpr_actions module
  • HSTB.kluster.fqpr_actions Module
    • Functions
      • build_multibeam_action
        • build_multibeam_action()
      • build_nav_action
        • build_nav_action()
      • build_processing_action
        • build_processing_action()
      • build_surface_action
        • build_surface_action()
      • build_svp_action
        • build_svp_action()
      • update_kwargs_for_multibeam
        • update_kwargs_for_multibeam()
      • update_kwargs_for_navigation
        • update_kwargs_for_navigation()
      • update_kwargs_for_processing
        • update_kwargs_for_processing()
      • update_kwargs_for_surface
        • update_kwargs_for_surface()
      • update_kwargs_for_svp
        • update_kwargs_for_svp()
    • Classes
      • FqprAction
        • FqprAction
          • FqprAction.execute()
          • FqprAction.print_summary()
          • FqprAction.set()
      • FqprActionContainer
        • FqprActionContainer
          • FqprActionContainer.add_action()
          • FqprActionContainer.clear()
          • FqprActionContainer.clear_actions_by_type()
          • FqprActionContainer.execute_action()
          • FqprActionContainer.get_next_action()
          • FqprActionContainer.remove_action()
          • FqprActionContainer.return_actions_by_type()
          • FqprActionContainer.update_action()
          • FqprActionContainer.update_action_from_list()
          • FqprActionContainer.update_actions_client()
          • FqprActionContainer.update_unmatched()
• fqpr_vessel module
  • HSTB.kluster.fqpr_vessel Module
    • Functions
      • carry_over_optional
        • carry_over_optional()
      • compare_dict_data
        • compare_dict_data()
      • convert_from_fqpr_xyzrph
        • convert_from_fqpr_xyzrph()
      • convert_from_vessel_xyzrph
        • convert_from_vessel_xyzrph()
      • create_new_vessel_file
        • create_new_vessel_file()
      • get_overlapping_timestamps
        • get_overlapping_timestamps()
      • only_retain_earliest_entry
        • only_retain_earliest_entry()
      • split_by_timestamp
        • split_by_timestamp()
      • trim_xyzrprh_to_times
        • trim_xyzrprh_to_times()
    • Classes
      • VesselFile
        • VesselFile
          • VesselFile.open()
          • VesselFile.return_data()
          • VesselFile.save()
          • VesselFile.update()
• monitor module
  • HSTB.kluster.monitor Module
    • Functions
      • get_file_size
        • get_file_size()
    • Classes
      • DirectoryMonitor
        • DirectoryMonitor
          • DirectoryMonitor.newfile
          • DirectoryMonitor.add_to_buffer()
          • DirectoryMonitor.bind_to()
          • DirectoryMonitor.build_initial_file_state()
          • DirectoryMonitor.push_to_kluster_intelligence()
          • DirectoryMonitor.start()
          • DirectoryMonitor.stop()
      • IntelligenceMonitorHandler
        • IntelligenceMonitorHandler
          • IntelligenceMonitorHandler.on_created()
          • IntelligenceMonitorHandler.on_deleted()
      • WatchBuffer
        • WatchBuffer
          • WatchBuffer.run()
• xarray_conversion module
  • HSTB.kluster.xarray_conversion Module
    • Functions
      • batch_read_configure_options
        • batch_read_configure_options()
      • build_xyzrph
        • build_xyzrph()
      • determine_good_chunksize
        • determine_good_chunksize()
      • gather_dataset_attributes
        • gather_dataset_attributes()
      • get_nearest_runtime
        • get_nearest_runtime()
      • return_chunked_fil
        • return_chunked_fil()
      • return_xyzrph_from_mbes
        • return_xyzrph_from_mbes()
      • return_xyzrph_from_posmv
        • return_xyzrph_from_posmv()
      • simplify_soundvelocity_profile
        • simplify_soundvelocity_profile()
      • sort_and_drop_duplicates
        • sort_and_drop_duplicates()
    • Classes
      • BatchRead
        • BatchRead
          • BatchRead.chunk_size
          • BatchRead.batch_read()
          • BatchRead.build_additional_line_metadata()
          • BatchRead.build_offsets()
          • BatchRead.correct_for_counter_reset()
          • BatchRead.get_nearest_install_parameters()
          • BatchRead.get_nearest_runtime_parameters()
          • BatchRead.initialize_log()
          • BatchRead.is_dual_head()
          • BatchRead.read()
          • BatchRead.read_from_netcdf_fils()
          • BatchRead.read_from_zarr_fils()
          • BatchRead.reload_attituderecords()
          • BatchRead.reload_pingrecords()
          • BatchRead.return_all_profiles()
          • BatchRead.return_nearest_soundspeed_profile()
          • BatchRead.return_ping_counters_at_time()
          • BatchRead.return_prefix_for_rp()
          • BatchRead.return_raw_navigation()
          • BatchRead.return_runtime_and_installation_settings_dicts()
          • BatchRead.return_rx_xyzrph()
          • BatchRead.return_system_time_indexed_array()
          • BatchRead.return_tpu_parameters()
          • BatchRead.return_tx_xyzrph()
          • BatchRead.return_utm_zone_number()
          • BatchRead.return_waterline()
          • BatchRead.return_xyz_prefixes_for_systems()
          • BatchRead.return_xyzrph_sorted_timestamps()
    • Class Inheritance Diagram
• orientation module
  • HSTB.kluster.modules.orientation Module
    • Functions
      • build_orientation_vectors
        • build_orientation_vectors()
      • distrib_run_build_orientation_vectors
        • distrib_run_build_orientation_vectors()
      • get_times
        • get_times()
• beampointingvector module
  • HSTB.kluster.modules.beampointingvector Module
    • Functions
      • build_beam_pointing_vectors
        • build_beam_pointing_vectors()
      • build_geographic_beam_vectors
        • build_geographic_beam_vectors()
      • compute_geo_beam_pointing_angle
        • compute_geo_beam_pointing_angle()
      • compute_relative_azimuth
        • compute_relative_azimuth()
      • construct_array_relative_beamvector
        • construct_array_relative_beamvector()
      • cross
        • cross()
      • distrib_run_build_beam_pointing_vector
        • distrib_run_build_beam_pointing_vector()
      • return_array_geographic_rotation
        • return_array_geographic_rotation()
• svcorrect module
  • HSTB.kluster.modules.svcorrect Module
    • Functions
      • cast_data_from_file
        • cast_data_from_file()
      • distributed_run_sv_correct
        • distributed_run_sv_correct()
      • get_sv_files_from_directory
        • get_sv_files_from_directory()
      • return_supported_casts_from_list
        • return_supported_casts_from_list()
      • run_ray_trace_v2
        • run_ray_trace_v2()
    • Classes
      • SoundSpeedProfile
        • SoundSpeedProfile
          • SoundSpeedProfile.adjust_for_z()
          • SoundSpeedProfile.generate_lookup_table()
          • SoundSpeedProfile.interpolate_extended_casts()
          • SoundSpeedProfile.load_from_profile()
          • SoundSpeedProfile.load_from_xarray()
          • SoundSpeedProfile.run_sv_correct()
• georeference module
  • HSTB.kluster.modules.georeference Module
    • Functions
      • apply_grid_to_soundings
        • apply_grid_to_soundings()
      • clear_vdatum_path
        • clear_vdatum_path()
      • compute_geohash
        • compute_geohash()
      • decode_geohash
        • decode_geohash()
      • distance_between_coordinates
        • distance_between_coordinates()
      • distrib_run_georeference
        • distrib_run_georeference()
      • geohash_to_polygon
        • geohash_to_polygon()
      • georef_by_worker
        • georef_by_worker()
      • new_geohash
        • new_geohash()
      • polygon_to_geohashes
        • polygon_to_geohashes()
      • set_vyperdatum_vdatum_path
        • set_vyperdatum_vdatum_path()
      • transform_ellipse
        • transform_ellipse()
      • transform_vyperdatum
        • transform_vyperdatum()
• tpu module
  • HSTB.kluster.modules.tpu Module
    • Functions
      • calculate_tpu
        • calculate_tpu()
      • calculate_uncertainty_ifremer
        • calculate_uncertainty_ifremer()
      • calculate_uncertainty_kongsberg
        • calculate_uncertainty_kongsberg()
      • distrib_run_calculate_tpu
        • distrib_run_calculate_tpu()
    • Classes
      • Tpu
        • Tpu
          • Tpu.generate_total_uncertainties()
          • Tpu.load_from_data()
          • Tpu.populate_from_dict()
• backscatter module
  • HSTB.kluster.modules.backscatter Module
    • Functions
      • avg_correct
        • avg_correct()
      • distrib_run_process_backscatter
        • distrib_run_process_backscatter()
      • generate_avg_corrector
        • generate_avg_corrector()
      • return_backscatter_settings
        • return_backscatter_settings()
    • Classes
      • Allscatter
        • Allscatter
          • Allscatter.absorption_description
          • Allscatter.fixed_gain
          • Allscatter.near_normal_description
          • Allscatter.pulse_length_description
          • Allscatter.raw_intensity_description
          • Allscatter.rx_beam_width_description
          • Allscatter.tvg
          • Allscatter.tx_beam_width_description
          • Allscatter.return_settings()
      • BScatter
        • BScatter
          • BScatter.absorption_description
          • BScatter.area_correction
          • BScatter.attenuation
          • BScatter.fixed_gain
          • BScatter.pulse_length_description
          • BScatter.raw_intensity_description
          • BScatter.rx_beam_width_description
          • BScatter.spherical_spreading
          • BScatter.transmission_loss
          • BScatter.tvg
          • BScatter.tx_beam_width_description
          • BScatter.plot_backscatter_components()
          • BScatter.process()
          • BScatter.return_settings()
      • Kmallscatter
        • Kmallscatter
          • Kmallscatter.absorption_description
          • Kmallscatter.fixed_gain
          • Kmallscatter.gain_selection_description
          • Kmallscatter.pulse_length_description
          • Kmallscatter.raw_intensity_description
          • Kmallscatter.rx_beam_width_description
          • Kmallscatter.tvg
          • Kmallscatter.tvg_description
          • Kmallscatter.tx_beam_width_description
          • Kmallscatter.return_settings()
      • S7kscatter
        • S7kscatter
          • S7kscatter.absorption_description
          • S7kscatter.fixed_gain
          • S7kscatter.gain_selection_description
          • S7kscatter.power_selection_description
          • S7kscatter.pulse_length_description
          • S7kscatter.raw_intensity_description
          • S7kscatter.rx_beam_width_description
          • S7kscatter.spreading_description
          • S7kscatter.tvg
          • S7kscatter.tx_beam_width_description
          • S7kscatter.return_settings()
• visualizations module
  • HSTB.kluster.modules.visualizations Module
    • Functions
      • save_animation_mpeg
        • save_animation_mpeg()
    • Classes
      • FqprVisualizations
        • FqprVisualizations
          • FqprVisualizations.plot_backscatter_sample()
          • FqprVisualizations.plot_sound_velocity_map()
          • FqprVisualizations.plot_sound_velocity_profiles()
          • FqprVisualizations.plot_surface_sv_vs_profiles()
          • FqprVisualizations.plot_thu_sample()
          • FqprVisualizations.plot_tvu_sample()
          • FqprVisualizations.soundings_plot_2d()
          • FqprVisualizations.soundings_plot_3d()
          • FqprVisualizations.visualize_beam_pointing_vectors()
          • FqprVisualizations.visualize_orientation_vector()
      • Player
        • Player
          • Player.backward()
          • Player.bind_to()
          • Player.clear_observers()
          • Player.close_event()
          • Player.forward()
          • Player.onebackward()
          • Player.oneforward()
          • Player.onestep()
          • Player.play()
          • Player.save_event()
          • Player.set_pos()
          • Player.setup()
          • Player.slowdown()
          • Player.speedup()
          • Player.start()
          • Player.stop()
          • Player.update()
• sat module
  • HSTB.kluster.modules.sat Module
    • Functions
      • accuracy_test
        • accuracy_test()
      • calc_order
        • calc_order()
      • difference_grid_and_soundings
        • difference_grid_and_soundings()
    • Classes
      • BaseTest
        • BaseTest
      • ExtinctionTest
        • ExtinctionTest
          • ExtinctionTest.plot()
          • ExtinctionTest.plotv2()
      • PingPeriodTest
        • PingPeriodTest
          • PingPeriodTest.plot()
• wobble module
  • HSTB.kluster.modules.wobble Module
    • Functions
      • build_highpass_filter_coeff
        • build_highpass_filter_coeff()
      • fit_sin
        • fit_sin()
      • linear_regression
        • linear_regression()
      • return_high_pass_filtered_depth
        • return_high_pass_filtered_depth()
      • return_high_pass_filtered_slope
        • return_high_pass_filtered_slope()
      • return_period_of_signal
        • return_period_of_signal()
      • smooth_signal
        • smooth_signal()
    • Classes
      • WobbleTest
        • WobbleTest
          • WobbleTest.generate_starting_data()
          • WobbleTest.plot_allowable_percent_deviation()
          • WobbleTest.plot_attitude_latency()
          • WobbleTest.plot_attitude_scaling_one()
          • WobbleTest.plot_attitude_scaling_two()
          • WobbleTest.plot_correlation_table()
          • WobbleTest.plot_heave_sound_speed_one()
          • WobbleTest.plot_heave_sound_speed_two()
          • WobbleTest.plot_x_lever_arm_error()
          • WobbleTest.plot_y_lever_arm_error()
          • WobbleTest.plot_yaw_alignment()
• export module
  • HSTB.kluster.modules.export Module
    • Classes
      • FqprExport
        • FqprExport
          • FqprExport.export_dataset_to_csv()
          • FqprExport.export_lines_to_file()
          • FqprExport.export_pings_to_file()
          • FqprExport.export_soundings_to_file()
          • FqprExport.export_tracklines_to_file()
          • FqprExport.export_variable_to_csv()
• subset module
  • HSTB.kluster.modules.subset Module
    • Functions
      • filter_subset_by_detection
        • filter_subset_by_detection()
      • filter_subset_by_polygon
        • filter_subset_by_polygon()
    • Classes
      • FqprSubset
        • FqprSubset
          • FqprSubset.is_subset
          • FqprSubset.get_variable_by_filter()
          • FqprSubset.redo_subset()
          • FqprSubset.restore_subset()
          • FqprSubset.return_soundings_in_polygon()
          • FqprSubset.set_filter_by_polygon()
          • FqprSubset.set_variable_by_filter()
          • FqprSubset.subset_by_lines()
          • FqprSubset.subset_by_time()
          • FqprSubset.subset_by_time_and_beam()
          • FqprSubset.subset_by_times()
          • FqprSubset.subset_variables()
          • FqprSubset.subset_variables_by_line()
• rotations module
  • HSTB.kluster.rotations Module
    • Functions
      • build_mounting_angle_mat
        • build_mounting_angle_mat()
      • build_rot_mat
        • build_rot_mat()
      • combine_rotation_matrix
        • combine_rotation_matrix()
      • return_attitude_rotation_matrix
        • return_attitude_rotation_matrix()
      • return_mounting_rotation_matrix
        • return_mounting_rotation_matrix()
• pdal_entwine module
  • HSTB.kluster.pdal_entwine Module
    • Functions
      • build_entwine_points
        • build_entwine_points()
      • visualize_entwine
        • visualize_entwine()
• dask_helpers module
  • HSTB.kluster.dask_helpers Module
    • Functions
      • client_needs_restart
        • client_needs_restart()
      • dask_close_localcluster
        • dask_close_localcluster()
      • dask_find_or_start_client
        • dask_find_or_start_client()
      • determine_optimal_chunks
        • determine_optimal_chunks()
      • get_max_cluster_allocated_memory
        • get_max_cluster_allocated_memory()
      • get_number_of_workers
        • get_number_of_workers()
      • split_array_by_number_of_workers
        • split_array_by_number_of_workers()
    • Classes
      • DaskProcessSynchronizer
        • DaskProcessSynchronizer
• fqpr_helpers module
  • HSTB.kluster.fqpr_helpers Module
    • Functions
      • build_crs
        • build_crs()
      • epsg_determinator
        • epsg_determinator()
      • haversine
        • haversine()
      • print_progress_bar
        • print_progress_bar()
      • return_directory_from_data
        • return_directory_from_data()
      • return_files_from_path
        • return_files_from_path()
      • seconds_to_formatted_string
        • seconds_to_formatted_string()
• gdal_helpers module
  • HSTB.kluster.gdal_helpers Module
    • Functions
      • crs_to_osgeo
        • crs_to_osgeo()
      • gdal_output_file_exists
        • gdal_output_file_exists()
      • gdal_raster_create
        • gdal_raster_create()
      • get_raster_attribution
        • get_raster_attribution()
      • get_raster_bands
        • get_raster_bands()
      • get_vector_attribution
        • get_vector_attribution()
      • get_vector_layers
        • get_vector_layers()
      • ogr_output_file_exists
        • ogr_output_file_exists()
      • pyproj_crs_to_osgeo
        • pyproj_crs_to_osgeo()
      • return_gdal_version
        • return_gdal_version()
    • Classes
      • VectorLayer
        • VectorLayer
          • VectorLayer.is_virtual
          • VectorLayer.close()
          • VectorLayer.delete_layer()
          • VectorLayer.get_layer_by_name()
          • VectorLayer.hide_layer()
          • VectorLayer.show_layer()
          • VectorLayer.write_to_layer()
• numba_helpers module
  • HSTB.kluster.numba_helpers Module
    • Functions
      • bin1d
        • bin1d()
      • bin2d
        • bin2d()
      • hist2d_numba_seq
        • hist2d_numba_seq()
      • is_inside_sm
        • is_inside_sm()
      • is_inside_sm_parallel
        • is_inside_sm_parallel()
• pydro_helpers module
  • HSTB.kluster.pydro_helpers Module
    • Functions
      • is_pydro
        • is_pydro()
      • retrieve_activate_batch
        • retrieve_activate_batch()
      • retrieve_install_prefix
        • retrieve_install_prefix()
      • retrieve_noaa_folder_path
        • retrieve_noaa_folder_path()
      • retrieve_scripts_folder
        • retrieve_scripts_folder()
      • retrieve_vdatum_folder_path
        • retrieve_vdatum_folder_path()
• xarray_helpers module
  • HSTB.kluster.xarray_helpers Module
    • Functions
      • clear_data_vars_from_dataset
        • clear_data_vars_from_dataset()
      • combine_arrays_to_dataset
        • combine_arrays_to_dataset()
      • combine_xr_attributes
        • combine_xr_attributes()
      • compare_and_find_gaps
        • compare_and_find_gaps()
      • divide_arrays_by_time_index
        • divide_arrays_by_time_index()
      • fix_xarray_dataset_index
        • fix_xarray_dataset_index()
      • get_beamwise_interpolation
        • get_beamwise_interpolation()
      • interp_across_chunks
        • interp_across_chunks()
      • my_open_mfdataset
        • my_open_mfdataset()
      • reform_nan_array
        • reform_nan_array()
      • reload_zarr_records
        • reload_zarr_records()
      • resize_zarr
        • resize_zarr()
      • return_chunk_slices
        • return_chunk_slices()
      • slice_xarray_by_dim
        • slice_xarray_by_dim()
      • stack_nan_array
        • stack_nan_array()
      • xarr_to_netcdf
        • xarr_to_netcdf()
      • xarr_to_zarr
        • xarr_to_zarr()
• utc_helpers module
  • HSTB.kluster.utc_helpers Module
    • Functions
      • DateTimeToUTCs80
        • DateTimeToUTCs80()
      • PyTmHMSXtoS
        • PyTmHMSXtoS()
      • PyTmStoHMSX
        • PyTmStoHMSX()
      • PyTmUTCs80toYDS
        • PyTmUTCs80toYDS()
      • PyTmYDSminusYDS
        • PyTmYDSminusYDS()
      • PyTmYDSplusS
        • PyTmYDSplusS()
      • PyTmYDStoUTCs80
        • PyTmYDStoUTCs80()
      • PyTmYJDtoMD
        • PyTmYJDtoMD()
      • PyTmYMDtoJD
        • PyTmYMDtoJD()
      • UTCs80ToDateTime
        • UTCs80ToDateTime()
      • calendar_day_time_to_utctimestamp
        • calendar_day_time_to_utctimestamp()
      • julian_day_time_to_utctimestamp
        • julian_day_time_to_utctimestamp()
• logging_conf module
  • HSTB.kluster.logging_conf Module
    • Functions
      • add_file_handler
        • add_file_handler()
      • logfile_matches
        • logfile_matches()
      • logger_has_file_handler
        • logger_has_file_handler()
      • logger_remove_file_handlers
        • logger_remove_file_handlers()
      • return_log_name
        • return_log_name()
      • return_logger
        • return_logger()
    • Classes
      • LoggerClass
        • LoggerClass
          • LoggerClass.print_msg()
      • StdErrFilter
        • StdErrFilter
          • StdErrFilter.filter()
      • StdOutFilter
        • StdOutFilter
          • StdOutFilter.filter()