FoldOptLib package

Subpackages

• FoldOptLib.examples package
  • Submodules
  • FoldOptLib.examples.misc_functions module
    • sample_random_dataset()
  • Module contents
• FoldOptLib.fold_modelling package
  • Submodules
  • FoldOptLib.fold_modelling.base_fold_frame_builder module
    • BaseFoldFrameBuilder
      • BaseFoldFrameBuilder.build_fold_frame()
      • BaseFoldFrameBuilder.initialise_model()
  • FoldOptLib.fold_modelling.engine module
    • FoldModel
      • FoldModel.data
      • FoldModel.bounding_box
      • FoldModel.model
      • FoldModel.gradient_data
      • FoldModel.points
      • FoldModel.kwargs
      • FoldModel.axial_surface
      • FoldModel.scaled_points
      • FoldModel.build_fold_frame()
      • FoldModel.calculate_folded_foliation_vectors()
      • FoldModel.calculate_svariogram()
      • FoldModel.create_and_build_fold_event()
      • FoldModel.fit_fourier_series()
      • FoldModel.get_predicted_foliation()
      • FoldModel.initialise_model()
      • FoldModel.process_axial_surface_proposition()
    • fold_function()
  • FoldOptLib.fold_modelling.simple_fold_frame_builder module
  • Module contents
• FoldOptLib.from_loopstructural package
  • Module contents
• FoldOptLib.helper package
  • Submodules
  • FoldOptLib.helper.utils module
    • axial_plane_stereonet()
    • calculate_intersection_lineation()
    • calculate_semivariogram()
    • clean_knowledge_dict()
    • create_dataset()
    • create_dict()
    • create_fold_frame_dataset()
    • create_gradient_dict()
    • fourier_series()
    • fourier_series_x_intercepts()
    • get_fold_curves()
    • get_predicted_rotation_angle()
    • get_wavelength_guesses()
    • normal_vector_to_strike_and_dip()
    • objective_wrapper()
    • rotate_vector()
    • save_load_object()
    • strike_dip_to_vector()
    • strike_dip_to_vectors()
  • Module contents
• FoldOptLib.input package
  • Submodules
  • FoldOptLib.input.input_data_checker module
    • CheckInputData
      • CheckInputData.folded_foliation_data
      • CheckInputData.bounding_box
      • CheckInputData.knowledge_constraints
      • CheckInputData.check_bounding_box()
      • CheckInputData.check_foliation_data()
      • CheckInputData.check_input_data()
      • CheckInputData.check_input_geological_knowledge()
  • FoldOptLib.input.input_data_processor module
    • InputDataProcessor
      • InputDataProcessor.process_data()
  • Module contents
• FoldOptLib.ipywidgets_interface package
  • Submodules
  • FoldOptLib.ipywidgets_interface.knowledge_input module
    • create_mu_widgets()
    • create_value_widgets()
    • display_dict_selection()
    • on_add_button_click()
    • on_constraint_change()
    • on_sub_constraint_change()
  • Module contents
• FoldOptLib.objective_functions package
  • Submodules
  • FoldOptLib.objective_functions.axial_plane module
    • is_axial_plane_compatible()
  • FoldOptLib.objective_functions.gaussian module
    • gaussian_log_likelihood()
    • loglikelihood()
    • loglikelihood_axial_surface()
    • loglikelihood_fourier_series()
  • FoldOptLib.objective_functions.geological_knowledge module
    • GeologicalKnowledgeFunctions
      • GeologicalKnowledgeFunctions.asymmetry_objective_function()
      • GeologicalKnowledgeFunctions.axial_surface_objective_function()
      • GeologicalKnowledgeFunctions.axial_trace_objective_function()
      • GeologicalKnowledgeFunctions.fold_axis_wavelength_objective_function()
      • GeologicalKnowledgeFunctions.hinge_angle_objective_function()
      • GeologicalKnowledgeFunctions.setup_objective_functions()
      • GeologicalKnowledgeFunctions.setup_objective_functions_for_restricted_mode()
      • GeologicalKnowledgeFunctions.tightness_objective_function()
      • GeologicalKnowledgeFunctions.wavelength_objective_function()
    • check_fourier_parameters()
  • FoldOptLib.objective_functions.lambda_objective_function module
    • LambdaObjectiveFunction
      • LambdaObjectiveFunction.make_objective_function()
  • FoldOptLib.objective_functions.least_squares module
    • LeastSquaresFunctions
      • LeastSquaresFunctions.rotation_angle
      • LeastSquaresFunctions.fold_frame
      • LeastSquaresFunctions.knowledge_constraints
      • LeastSquaresFunctions.kwargs
      • LeastSquaresFunctions.square_residuals()
      • LeastSquaresFunctions.huber_loss()
      • LeastSquaresFunctions.soft_l1_loss()
      • LeastSquaresFunctions.cost()
      • LeastSquaresFunctions.cost()
      • LeastSquaresFunctions.huber_loss()
      • LeastSquaresFunctions.soft_l1_loss()
      • LeastSquaresFunctions.square_residuals()
  • FoldOptLib.objective_functions.von_mises_fisher module
    • VonMisesFisher
      • VonMisesFisher.draw_samples()
      • VonMisesFisher.logpdf()
      • VonMisesFisher.pdf()
  • Module contents
• FoldOptLib.optimisers package
  • Submodules
  • FoldOptLib.optimisers.axial_surface_optimiser module
    • AxialSurfaceOptimiser
      • AxialSurfaceOptimiser.angle_optimisation()
      • AxialSurfaceOptimiser.generate_initial_guess()
      • AxialSurfaceOptimiser.loglikelihood()
      • AxialSurfaceOptimiser.mle_optimisation()
      • AxialSurfaceOptimiser.optimise()
      • AxialSurfaceOptimiser.setup_optimisation()
    • calculate_intersection_lineation()
  • FoldOptLib.optimisers.base_optimiser module
  • FoldOptLib.optimisers.fold_optimiser module
    • FoldOptimiser
      • FoldOptimiser.generate_initial_guess()
      • FoldOptimiser.optimise()
      • FoldOptimiser.optimise_with_differential_evolution()
      • FoldOptimiser.optimise_with_trust_region()
      • FoldOptimiser.prepare_and_setup_knowledge_constraints()
      • FoldOptimiser.setup_optimisation()
  • FoldOptLib.optimisers.fourier_optimiser module
    • FourierSeriesOptimiser
      • FourierSeriesOptimiser.fold_frame_coordinate
      • FourierSeriesOptimiser.rotation_angle
      • FourierSeriesOptimiser.knowledge_constraints
      • FourierSeriesOptimiser.x
      • FourierSeriesOptimiser.kwargs
      • FourierSeriesOptimiser.generate_initial_guess()
      • FourierSeriesOptimiser.optimise()
      • FourierSeriesOptimiser.setup_optimisation()
  • Module contents
• FoldOptLib.splot package
  • Submodules
  • FoldOptLib.splot.splot_processor module
    • SPlotProcessor
      • SPlotProcessor.calculate_asymmetry()
      • SPlotProcessor.calculate_splot()
      • SPlotProcessor.calculate_tightness()
      • SPlotProcessor.find_amax_amin()
  • Module contents
• FoldOptLib.visualisation package
  • Module contents

Submodules

FoldOptLib.version module

Module contents