API documentation (for running calculations)

Contents:

• Module mjoindices.omi.omi_calculator
  • calc_eofs_for_doy()
  • calc_eofs_for_doy_using_eofs_package()
  • calc_eofs_from_olr()
  • calc_eofs_from_preprocessed_olr()
  • calculate_pcs_from_olr()
  • calculate_pcs_from_olr_original_conditions()
  • initiate_eof_post_processing()
  • preprocess_olr()
  • regress_3dim_data_onto_eofs()
  • regress_vector_onto_eofs()
• Module mjoindices.olr_handling
  • OLRData
    • OLRData.close()
    • OLRData.extract_olr_matrix_for_doy_range()
    • OLRData.get_olr_for_date()
    • OLRData.lat
    • OLRData.long
    • OLRData.olr
    • OLRData.save_to_npzfile()
    • OLRData.time
  • interpolate_spatial_grid()
  • interpolate_spatial_grid_to_original()
  • load_noaa_interpolated_olr()
  • load_noaa_interpolated_olr_netcdf4()
  • plot_olr_map_for_date()
  • remove_leap_years()
  • restore_from_npzfile()
  • restrict_time_coverage()
• Module mjoindices.omi.postprocessing_original_kiladis2014
  • correct_spontaneous_sign_changes_in_eof_series()
  • interpolate_eofs_between_doys()
  • post_process_eofs_original_kiladis_approach()
• Module mjoindices.omi.postprocessing_rotation_approach
  • angle_between_eofs()
  • angle_btwn_vectors()
  • calculate_angle_from_discontinuity()
  • normalize_eofs()
  • post_process_eofs_rotation()
  • rotate_each_eof_by_delta()
  • rotate_eofs()
  • rotation_matrix()

API documentation (for working with results)

Contents:

• Module mjoindices.principal_components
  • PCData
    • PCData.pc1
    • PCData.pc2
    • PCData.save_pcs_to_txt_file()
    • PCData.time
  • load_original_pcs_from_txt_file()
  • load_pcs_from_txt_file()
• Module mjoindices.empirical_orthogonal_functions
  • EOFData
    • EOFData.close()
    • EOFData.eigenvalue_eof1
    • EOFData.eigenvalue_eof2
    • EOFData.eigenvalues
    • EOFData.eof1map
    • EOFData.eof1vector
    • EOFData.eof2map
    • EOFData.eof2vector
    • EOFData.explained_variance_eof1
    • EOFData.explained_variance_eof2
    • EOFData.explained_variances
    • EOFData.lat
    • EOFData.long
    • EOFData.no_observations
    • EOFData.reshape_to_map()
    • EOFData.reshape_to_vector()
    • EOFData.save_eofs_to_txt_file()
    • EOFData.sum_of_explained_variances
  • EOFDataForAllDOYs
    • EOFDataForAllDOYs.eigenvalue1_for_all_doys()
    • EOFDataForAllDOYs.eigenvalue2_for_all_doys()
    • EOFDataForAllDOYs.eof1vector_for_doy()
    • EOFDataForAllDOYs.eof2vector_for_doy()
    • EOFDataForAllDOYs.eof_list
    • EOFDataForAllDOYs.eofdata_for_doy()
    • EOFDataForAllDOYs.explained_variance1_for_all_doys()
    • EOFDataForAllDOYs.explained_variance2_for_all_doys()
    • EOFDataForAllDOYs.lat
    • EOFDataForAllDOYs.len_eof_list
    • EOFDataForAllDOYs.long
    • EOFDataForAllDOYs.no_leap_years
    • EOFDataForAllDOYs.no_observations_for_all_doys()
    • EOFDataForAllDOYs.save_all_eofs_to_dir()
    • EOFDataForAllDOYs.save_all_eofs_to_npzfile()
    • EOFDataForAllDOYs.total_explained_variance_for_all_doys()
  • load_all_eofs_from_directory()
  • load_all_original_eofs_from_directory()
  • load_original_eofs_for_doy()
  • load_single_eofs_from_txt_file()
  • plot_eigenvalues_for_all_doys()
  • plot_explained_variance_for_all_doys()
  • plot_individual_eof_map()
  • plot_individual_eof_map_from_file()
  • plot_individual_explained_variance_all_eofs()
  • plot_original_individual_eof_map()
  • restore_all_eofs_from_npzfile()

API documentation (minor relevance for users)

Contents:

• Module mjoindices.omi.wheeler_kiladis_mjo_filter
  • WKFilter
    • WKFilter.perform_2dim_spectral_filtering()
  • detrend_vector()
  • filter_olr_for_mjo_eof_calculation()
  • filter_olr_for_mjo_pc_calculation()
  • filter_olr_temporally()
  • filter_olr_temporally_and_longitudinally()
  • taper_vector_to_zero()
• Module mjoindices.omi.quick_temporal_filter
  • filter_olr_for_mjo_pc_calculation_1d_spectral_smoothing()
  • filter_olr_temporally_1d_spectral_smoothing()
• Module mjoindices.tools
  • calc_day_of_year()
  • doy_list()
  • find_doy_ranges_in_dates()
• Module mjoindices.evaluation_tools
  • calc_comparison_stats_for_eofs_all_doys()
  • calc_comparison_stats_for_explained_variance()
  • calc_timeseries_agreement()
  • calc_vector_agreement()
  • compute_vector_difference_quantity()
  • load_omi_explained_variance()
  • plot_comparison_orig_calc_pcs()
  • plot_comparison_stats_for_eofs_all_doys()
  • plot_comparison_stats_for_explained_variance()
  • plot_correlation_for_eofs_all_doys()
  • plot_individual_eof_map_comparison()
  • plot_timeseries_agreement()
  • plot_vector_agreement()