fdtdx.ModeOverlapDetector
=========================

.. currentmodule:: fdtdx

.. autoclass:: ModeOverlapDetector
   :show-inheritance:

Quick Reference
---------------



.. rubric:: Attributes





* :attr:`~ModeOverlapDetector.bend_axis`



* :attr:`~ModeOverlapDetector.bend_radius`



* :attr:`~ModeOverlapDetector.color`



* :attr:`~ModeOverlapDetector.components`



* :attr:`~ModeOverlapDetector.direction`



* :attr:`~ModeOverlapDetector.dtype`



* :attr:`~ModeOverlapDetector.exact_interpolation`



* :attr:`~ModeOverlapDetector.filter_pol`



* :attr:`~ModeOverlapDetector.grid_shape`



* :attr:`~ModeOverlapDetector.grid_slice`



* :attr:`~ModeOverlapDetector.grid_slice_tuple`



* :attr:`~ModeOverlapDetector.if_inverse_plot_backwards`



* :attr:`~ModeOverlapDetector.inverse`



* :attr:`~ModeOverlapDetector.max_random_grid_offsets`



* :attr:`~ModeOverlapDetector.max_random_real_offsets`



* :attr:`~ModeOverlapDetector.mode_index`



* :attr:`~ModeOverlapDetector.name`



* :attr:`~ModeOverlapDetector.num_time_steps_recorded`



* :attr:`~ModeOverlapDetector.num_video_workers`



* :attr:`~ModeOverlapDetector.partial_grid_shape`



* :attr:`~ModeOverlapDetector.partial_real_position`



* :attr:`~ModeOverlapDetector.partial_real_shape`



* :attr:`~ModeOverlapDetector.plot`



* :attr:`~ModeOverlapDetector.plot_dpi`



* :attr:`~ModeOverlapDetector.plot_interpolation`



* :attr:`~ModeOverlapDetector.propagation_axis`



* :attr:`~ModeOverlapDetector.real_shape`



* :attr:`~ModeOverlapDetector.reduce_volume`



* :attr:`~ModeOverlapDetector.scaling_mode`



* :attr:`~ModeOverlapDetector.switch`



* :attr:`~ModeOverlapDetector.wave_characters`






.. rubric:: Methods





* :attr:`~ModeOverlapDetector.apply`



* :attr:`~ModeOverlapDetector.aset`



* :attr:`~ModeOverlapDetector.check_overlap`



* :attr:`~ModeOverlapDetector.compute_overlap`



* :attr:`~ModeOverlapDetector.compute_overlap_to_mode`



* :attr:`~ModeOverlapDetector.draw_plot`



* :attr:`~ModeOverlapDetector.extend_to`



* :attr:`~ModeOverlapDetector.face_to_face_negative_direction`



* :attr:`~ModeOverlapDetector.face_to_face_positive_direction`



* :attr:`~ModeOverlapDetector.get_class_fields`



* :attr:`~ModeOverlapDetector.get_public_fields`



* :attr:`~ModeOverlapDetector.init_state`



* :attr:`~ModeOverlapDetector.place_above`



* :attr:`~ModeOverlapDetector.place_at_center`



* :attr:`~ModeOverlapDetector.place_below`



* :attr:`~ModeOverlapDetector.place_on_grid`



* :attr:`~ModeOverlapDetector.place_relative_to`



* :attr:`~ModeOverlapDetector.same_position`



* :attr:`~ModeOverlapDetector.same_position_and_size`



* :attr:`~ModeOverlapDetector.same_size`



* :attr:`~ModeOverlapDetector.set_grid_coordinates`



* :attr:`~ModeOverlapDetector.size_relative_to`



* :attr:`~ModeOverlapDetector.update`







Attributes
==========





.. autoattribute:: ModeOverlapDetector.bend_axis



.. autoattribute:: ModeOverlapDetector.bend_radius



.. autoattribute:: ModeOverlapDetector.color



.. autoattribute:: ModeOverlapDetector.components



.. autoattribute:: ModeOverlapDetector.direction



.. autoattribute:: ModeOverlapDetector.dtype



.. autoattribute:: ModeOverlapDetector.exact_interpolation



.. autoattribute:: ModeOverlapDetector.filter_pol



.. autoattribute:: ModeOverlapDetector.grid_shape



.. autoattribute:: ModeOverlapDetector.grid_slice



.. autoattribute:: ModeOverlapDetector.grid_slice_tuple



.. autoattribute:: ModeOverlapDetector.if_inverse_plot_backwards



.. autoattribute:: ModeOverlapDetector.inverse



.. autoattribute:: ModeOverlapDetector.max_random_grid_offsets



.. autoattribute:: ModeOverlapDetector.max_random_real_offsets



.. autoattribute:: ModeOverlapDetector.mode_index



.. autoattribute:: ModeOverlapDetector.name



.. autoattribute:: ModeOverlapDetector.num_time_steps_recorded



.. autoattribute:: ModeOverlapDetector.num_video_workers



.. autoattribute:: ModeOverlapDetector.partial_grid_shape



.. autoattribute:: ModeOverlapDetector.partial_real_position



.. autoattribute:: ModeOverlapDetector.partial_real_shape



.. autoattribute:: ModeOverlapDetector.plot



.. autoattribute:: ModeOverlapDetector.plot_dpi



.. autoattribute:: ModeOverlapDetector.plot_interpolation



.. autoattribute:: ModeOverlapDetector.propagation_axis



.. autoattribute:: ModeOverlapDetector.real_shape



.. autoattribute:: ModeOverlapDetector.reduce_volume



.. autoattribute:: ModeOverlapDetector.scaling_mode



.. autoattribute:: ModeOverlapDetector.switch



.. autoattribute:: ModeOverlapDetector.wave_characters








Methods
==========








.. automethod:: ModeOverlapDetector.apply





.. automethod:: ModeOverlapDetector.aset





.. automethod:: ModeOverlapDetector.check_overlap





.. automethod:: ModeOverlapDetector.compute_overlap





.. automethod:: ModeOverlapDetector.compute_overlap_to_mode





.. automethod:: ModeOverlapDetector.draw_plot





.. automethod:: ModeOverlapDetector.extend_to





.. automethod:: ModeOverlapDetector.face_to_face_negative_direction





.. automethod:: ModeOverlapDetector.face_to_face_positive_direction





.. automethod:: ModeOverlapDetector.get_class_fields





.. automethod:: ModeOverlapDetector.get_public_fields





.. automethod:: ModeOverlapDetector.init_state





.. automethod:: ModeOverlapDetector.place_above





.. automethod:: ModeOverlapDetector.place_at_center





.. automethod:: ModeOverlapDetector.place_below





.. automethod:: ModeOverlapDetector.place_on_grid





.. automethod:: ModeOverlapDetector.place_relative_to





.. automethod:: ModeOverlapDetector.same_position





.. automethod:: ModeOverlapDetector.same_position_and_size





.. automethod:: ModeOverlapDetector.same_size





.. automethod:: ModeOverlapDetector.set_grid_coordinates





.. automethod:: ModeOverlapDetector.size_relative_to





.. automethod:: ModeOverlapDetector.update






If you find any errors in the documentation, please report them in the `Github Issues <https://github.com/ymahlau/fdtdx/issues>`_!