finesse.utilities package

Submodules

• finesse.utilities.aberrations module
  • spherical_surface()
• finesse.utilities.blockdiag module
  • display_blockdiag_output()
  • display_loops_blockdiag()
  • get_loops_blockdiag_code()
• finesse.utilities.bug_report module
  • SourceType
  • bug_report()
  • get_formatted_argv()
  • get_formatted_source()
  • get_formatted_traceback()
  • get_package_versions()
  • get_source()
  • get_source_type()
  • ipynb_to_md()
  • wrap_block()
• finesse.utilities.collections module
  • OrderedSet
• finesse.utilities.components module
  • names_to_nodes()
  • refractive_index()
• finesse.utilities.control module
  • zpk_fresp()
• finesse.utilities.cyomp module
  • determine_nthreads_even()
• finesse.utilities.docs module
  • class_to_url()
  • get_docs_url()
• finesse.utilities.frequency_response module
  • set_DC_fields()
• finesse.utilities.functools module
  • flagdispatchmethod
  • valuedispatchmethod
• finesse.utilities.graph module
  • class_graph()
  • class_graph_from_module_graph()
  • copy_graph()
  • default_key()
  • flip_dict()
  • get_orphan_nodes()
  • get_sink_nodes()
  • get_source_nodes()
  • module_graph()
  • remove_orphans()
  • remove_sinks()
  • remove_sources()
• finesse.utilities.homs module
  • HG_to_LG()
  • HG_to_LG_matrix()
  • insert_modes()
  • jacobi_real_x()
  • lens_diopt_to_f()
  • make_modes()
  • make_modes_LG()
  • remove_modes()
  • surface_diopt_to_roc()
• finesse.utilities.logging module
  • FinesseStreamHandler
  • logs()
  • tracebacks()
• finesse.utilities.maps module
  • BinaryReader
  • BinaryReaderEOFException
  • circular_aperture()
  • make_coordinates()
  • overlap_1D_curvature_coefficients()
  • overlap_1D_piston_coefficient()
  • overlap_1D_tilt_coefficients()
  • overlap_curvature_coefficients()
  • overlap_piston_coefficient()
  • overlap_tilt_coefficients()
  • read_metropro_file()
  • read_metropro_header()
  • rms()
  • surface_point_absorber()
• finesse.utilities.misc module
  • calltracker()
  • check_name()
  • doc_element_parameter_table()
  • find()
  • find_nearest()
  • graph_layouts()
  • graphviz_layouts()
  • inheritors()
  • is_iterable()
  • networkx_layouts()
  • opened_file()
  • pairwise()
  • reduce_getattr()
  • track_particles()
  • valid_name()
• finesse.utilities.network_filter module
  • ComponentNetworkFilter
  • FullNetworkFilter
  • NetworkFilterBase
  • NetworkType
  • NodeNetworkFilter
  • OpticalNetworkFilter
  • PortNetworkFilter
• finesse.utilities.numbers module
  • clip_with_tolerance()
• finesse.utilities.polyfit module
  • polyfit2d()
  • polyfit2d_eval()
  • polyfit2d_index()
  • polyfit2d_indices()
• finesse.utilities.storage module
  • create_object_dataset()
  • dict_to_json()
  • dump_solution_hdf()
  • load()
  • load_solution_hdf()
  • np_dtype_from_json()
  • np_dtype_to_json()
  • object_to_hdf()
  • save()
  • str_array_to_hdf()
  • to_generic_hdf()
  • type_from_json()
  • type_to_json()
• finesse.utilities.tables module
  • NumberTable
  • Table
• finesse.utilities.text module
  • add_linenos()
  • format_bullet_list()
  • format_section()
  • get_close_matches()
  • ngettext()
  • option_list()
  • rewrite_lines()
  • scale_si()
  • stringify()
  • stringify_graph_gml()
• finesse.utilities.types module
  • issubtype()
• finesse.utilities.units module
  • SI
  • get_SI_value()
• finesse.utilities.wigner module
  • D_hg()
  • D_hg_full()
  • E_1D_to_2D()
  • WignerMomentsHG
  • X_hg()
  • X_hg_full()
  • gauss_norm()
  • herm()
  • q2w()
  • q2w0()
  • wigner_moments_2D_hg()

Module contents

Useful common utility functions and classes used throughout the Finesse package.