fdtdx.ModePlaneSource
=====================

.. currentmodule:: fdtdx

.. autoclass:: ModePlaneSource
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~ModePlaneSource.azimuth_angle`



* :attr:`~ModePlaneSource.azimuth_radians`



* :attr:`~ModePlaneSource.color`



* :attr:`~ModePlaneSource.direction`



* :attr:`~ModePlaneSource.elevation_angle`



* :attr:`~ModePlaneSource.elevation_radians`



* :attr:`~ModePlaneSource.filter_pol`



* :attr:`~ModePlaneSource.grid_shape`



* :attr:`~ModePlaneSource.grid_slice`



* :attr:`~ModePlaneSource.grid_slice_tuple`



* :attr:`~ModePlaneSource.horizontal_axis`



* :attr:`~ModePlaneSource.max_angle_random_offset`



* :attr:`~ModePlaneSource.max_angle_random_offset_radians`



* :attr:`~ModePlaneSource.max_horizontal_offset`



* :attr:`~ModePlaneSource.max_horizontal_offset_grid`



* :attr:`~ModePlaneSource.max_random_grid_offsets`



* :attr:`~ModePlaneSource.max_random_real_offsets`



* :attr:`~ModePlaneSource.max_vertical_offset`



* :attr:`~ModePlaneSource.max_vertical_offset_grid`



* :attr:`~ModePlaneSource.mode_index`



* :attr:`~ModePlaneSource.name`



* :attr:`~ModePlaneSource.partial_grid_shape`



* :attr:`~ModePlaneSource.partial_real_position`



* :attr:`~ModePlaneSource.partial_real_shape`



* :attr:`~ModePlaneSource.propagation_axis`



* :attr:`~ModePlaneSource.real_shape`



* :attr:`~ModePlaneSource.static_amplitude_factor`



* :attr:`~ModePlaneSource.switch`



* :attr:`~ModePlaneSource.temporal_profile`



* :attr:`~ModePlaneSource.vertical_axis`



* :attr:`~ModePlaneSource.wave_character`






.. rubric:: Methods





* :attr:`~ModePlaneSource.adjust_time_step_by_on_off`



* :attr:`~ModePlaneSource.apply`



* :attr:`~ModePlaneSource.aset`



* :attr:`~ModePlaneSource.check_overlap`



* :attr:`~ModePlaneSource.extend_to`



* :attr:`~ModePlaneSource.face_to_face_negative_direction`



* :attr:`~ModePlaneSource.face_to_face_positive_direction`



* :attr:`~ModePlaneSource.frequency_spectrum`



* :attr:`~ModePlaneSource.get_class_fields`



* :attr:`~ModePlaneSource.get_public_fields`



* :attr:`~ModePlaneSource.is_on_at_time_step`



* :attr:`~ModePlaneSource.place_above`



* :attr:`~ModePlaneSource.place_at_center`



* :attr:`~ModePlaneSource.place_below`



* :attr:`~ModePlaneSource.place_on_grid`



* :attr:`~ModePlaneSource.place_relative_to`



* :attr:`~ModePlaneSource.plot`



* :attr:`~ModePlaneSource.plot_time_signal_and_spectrum`



* :attr:`~ModePlaneSource.same_position`



* :attr:`~ModePlaneSource.same_position_and_size`



* :attr:`~ModePlaneSource.same_size`



* :attr:`~ModePlaneSource.sample_time_signal`



* :attr:`~ModePlaneSource.set_grid_coordinates`



* :attr:`~ModePlaneSource.size_relative_to`



* :attr:`~ModePlaneSource.update_E`



* :attr:`~ModePlaneSource.update_H`







Attributes
==========





.. autoattribute:: ModePlaneSource.azimuth_angle



.. autoattribute:: ModePlaneSource.azimuth_radians



.. autoattribute:: ModePlaneSource.color



.. autoattribute:: ModePlaneSource.direction



.. autoattribute:: ModePlaneSource.elevation_angle



.. autoattribute:: ModePlaneSource.elevation_radians



.. autoattribute:: ModePlaneSource.filter_pol



.. autoattribute:: ModePlaneSource.grid_shape



.. autoattribute:: ModePlaneSource.grid_slice



.. autoattribute:: ModePlaneSource.grid_slice_tuple



.. autoattribute:: ModePlaneSource.horizontal_axis



.. autoattribute:: ModePlaneSource.max_angle_random_offset



.. autoattribute:: ModePlaneSource.max_angle_random_offset_radians



.. autoattribute:: ModePlaneSource.max_horizontal_offset



.. autoattribute:: ModePlaneSource.max_horizontal_offset_grid



.. autoattribute:: ModePlaneSource.max_random_grid_offsets



.. autoattribute:: ModePlaneSource.max_random_real_offsets



.. autoattribute:: ModePlaneSource.max_vertical_offset



.. autoattribute:: ModePlaneSource.max_vertical_offset_grid



.. autoattribute:: ModePlaneSource.mode_index



.. autoattribute:: ModePlaneSource.name



.. autoattribute:: ModePlaneSource.partial_grid_shape



.. autoattribute:: ModePlaneSource.partial_real_position



.. autoattribute:: ModePlaneSource.partial_real_shape



.. autoattribute:: ModePlaneSource.propagation_axis



.. autoattribute:: ModePlaneSource.real_shape



.. autoattribute:: ModePlaneSource.static_amplitude_factor



.. autoattribute:: ModePlaneSource.switch



.. autoattribute:: ModePlaneSource.temporal_profile



.. autoattribute:: ModePlaneSource.vertical_axis



.. autoattribute:: ModePlaneSource.wave_character








Methods
==========








.. automethod:: ModePlaneSource.adjust_time_step_by_on_off





.. automethod:: ModePlaneSource.apply





.. automethod:: ModePlaneSource.aset





.. automethod:: ModePlaneSource.check_overlap





.. automethod:: ModePlaneSource.extend_to





.. automethod:: ModePlaneSource.face_to_face_negative_direction





.. automethod:: ModePlaneSource.face_to_face_positive_direction





.. automethod:: ModePlaneSource.frequency_spectrum





.. automethod:: ModePlaneSource.get_class_fields





.. automethod:: ModePlaneSource.get_public_fields





.. automethod:: ModePlaneSource.is_on_at_time_step





.. automethod:: ModePlaneSource.place_above





.. automethod:: ModePlaneSource.place_at_center





.. automethod:: ModePlaneSource.place_below





.. automethod:: ModePlaneSource.place_on_grid





.. automethod:: ModePlaneSource.place_relative_to





.. automethod:: ModePlaneSource.plot





.. automethod:: ModePlaneSource.plot_time_signal_and_spectrum





.. automethod:: ModePlaneSource.same_position





.. automethod:: ModePlaneSource.same_position_and_size





.. automethod:: ModePlaneSource.same_size





.. automethod:: ModePlaneSource.sample_time_signal





.. automethod:: ModePlaneSource.set_grid_coordinates





.. automethod:: ModePlaneSource.size_relative_to





.. automethod:: ModePlaneSource.update_E





.. automethod:: ModePlaneSource.update_H






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