fdtdx.GaussianPlaneSource
=========================

.. currentmodule:: fdtdx

.. autoclass:: GaussianPlaneSource
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~GaussianPlaneSource.azimuth_angle`



* :attr:`~GaussianPlaneSource.azimuth_radians`



* :attr:`~GaussianPlaneSource.color`



* :attr:`~GaussianPlaneSource.direction`



* :attr:`~GaussianPlaneSource.elevation_angle`



* :attr:`~GaussianPlaneSource.elevation_radians`



* :attr:`~GaussianPlaneSource.fixed_E_polarization_vector`



* :attr:`~GaussianPlaneSource.fixed_H_polarization_vector`



* :attr:`~GaussianPlaneSource.grid_shape`



* :attr:`~GaussianPlaneSource.grid_slice`



* :attr:`~GaussianPlaneSource.grid_slice_tuple`



* :attr:`~GaussianPlaneSource.horizontal_axis`



* :attr:`~GaussianPlaneSource.max_angle_random_offset`



* :attr:`~GaussianPlaneSource.max_angle_random_offset_radians`



* :attr:`~GaussianPlaneSource.max_horizontal_offset`



* :attr:`~GaussianPlaneSource.max_horizontal_offset_grid`



* :attr:`~GaussianPlaneSource.max_random_grid_offsets`



* :attr:`~GaussianPlaneSource.max_random_real_offsets`



* :attr:`~GaussianPlaneSource.max_vertical_offset`



* :attr:`~GaussianPlaneSource.max_vertical_offset_grid`



* :attr:`~GaussianPlaneSource.name`



* :attr:`~GaussianPlaneSource.normalize_by_energy`



* :attr:`~GaussianPlaneSource.partial_grid_shape`



* :attr:`~GaussianPlaneSource.partial_real_position`



* :attr:`~GaussianPlaneSource.partial_real_shape`



* :attr:`~GaussianPlaneSource.propagation_axis`



* :attr:`~GaussianPlaneSource.radius`



* :attr:`~GaussianPlaneSource.real_shape`



* :attr:`~GaussianPlaneSource.static_amplitude_factor`



* :attr:`~GaussianPlaneSource.std`



* :attr:`~GaussianPlaneSource.switch`



* :attr:`~GaussianPlaneSource.temporal_profile`



* :attr:`~GaussianPlaneSource.vertical_axis`



* :attr:`~GaussianPlaneSource.wave_character`






.. rubric:: Methods





* :attr:`~GaussianPlaneSource.adjust_time_step_by_on_off`



* :attr:`~GaussianPlaneSource.apply`



* :attr:`~GaussianPlaneSource.aset`



* :attr:`~GaussianPlaneSource.check_overlap`



* :attr:`~GaussianPlaneSource.extend_to`



* :attr:`~GaussianPlaneSource.face_to_face_negative_direction`



* :attr:`~GaussianPlaneSource.face_to_face_positive_direction`



* :attr:`~GaussianPlaneSource.frequency_spectrum`



* :attr:`~GaussianPlaneSource.get_class_fields`



* :attr:`~GaussianPlaneSource.get_public_fields`



* :attr:`~GaussianPlaneSource.is_on_at_time_step`



* :attr:`~GaussianPlaneSource.place_above`



* :attr:`~GaussianPlaneSource.place_at_center`



* :attr:`~GaussianPlaneSource.place_below`



* :attr:`~GaussianPlaneSource.place_on_grid`



* :attr:`~GaussianPlaneSource.place_relative_to`



* :attr:`~GaussianPlaneSource.plot_time_signal_and_spectrum`



* :attr:`~GaussianPlaneSource.same_position`



* :attr:`~GaussianPlaneSource.same_position_and_size`



* :attr:`~GaussianPlaneSource.same_size`



* :attr:`~GaussianPlaneSource.sample_time_signal`



* :attr:`~GaussianPlaneSource.set_grid_coordinates`



* :attr:`~GaussianPlaneSource.size_relative_to`



* :attr:`~GaussianPlaneSource.update_E`



* :attr:`~GaussianPlaneSource.update_H`







Attributes
==========





.. autoattribute:: GaussianPlaneSource.azimuth_angle



.. autoattribute:: GaussianPlaneSource.azimuth_radians



.. autoattribute:: GaussianPlaneSource.color



.. autoattribute:: GaussianPlaneSource.direction



.. autoattribute:: GaussianPlaneSource.elevation_angle



.. autoattribute:: GaussianPlaneSource.elevation_radians



.. autoattribute:: GaussianPlaneSource.fixed_E_polarization_vector



.. autoattribute:: GaussianPlaneSource.fixed_H_polarization_vector



.. autoattribute:: GaussianPlaneSource.grid_shape



.. autoattribute:: GaussianPlaneSource.grid_slice



.. autoattribute:: GaussianPlaneSource.grid_slice_tuple



.. autoattribute:: GaussianPlaneSource.horizontal_axis



.. autoattribute:: GaussianPlaneSource.max_angle_random_offset



.. autoattribute:: GaussianPlaneSource.max_angle_random_offset_radians



.. autoattribute:: GaussianPlaneSource.max_horizontal_offset



.. autoattribute:: GaussianPlaneSource.max_horizontal_offset_grid



.. autoattribute:: GaussianPlaneSource.max_random_grid_offsets



.. autoattribute:: GaussianPlaneSource.max_random_real_offsets



.. autoattribute:: GaussianPlaneSource.max_vertical_offset



.. autoattribute:: GaussianPlaneSource.max_vertical_offset_grid



.. autoattribute:: GaussianPlaneSource.name



.. autoattribute:: GaussianPlaneSource.normalize_by_energy



.. autoattribute:: GaussianPlaneSource.partial_grid_shape



.. autoattribute:: GaussianPlaneSource.partial_real_position



.. autoattribute:: GaussianPlaneSource.partial_real_shape



.. autoattribute:: GaussianPlaneSource.propagation_axis



.. autoattribute:: GaussianPlaneSource.radius



.. autoattribute:: GaussianPlaneSource.real_shape



.. autoattribute:: GaussianPlaneSource.static_amplitude_factor



.. autoattribute:: GaussianPlaneSource.std



.. autoattribute:: GaussianPlaneSource.switch



.. autoattribute:: GaussianPlaneSource.temporal_profile



.. autoattribute:: GaussianPlaneSource.vertical_axis



.. autoattribute:: GaussianPlaneSource.wave_character








Methods
==========








.. automethod:: GaussianPlaneSource.adjust_time_step_by_on_off





.. automethod:: GaussianPlaneSource.apply





.. automethod:: GaussianPlaneSource.aset





.. automethod:: GaussianPlaneSource.check_overlap





.. automethod:: GaussianPlaneSource.extend_to





.. automethod:: GaussianPlaneSource.face_to_face_negative_direction





.. automethod:: GaussianPlaneSource.face_to_face_positive_direction





.. automethod:: GaussianPlaneSource.frequency_spectrum





.. automethod:: GaussianPlaneSource.get_class_fields





.. automethod:: GaussianPlaneSource.get_public_fields





.. automethod:: GaussianPlaneSource.is_on_at_time_step





.. automethod:: GaussianPlaneSource.place_above





.. automethod:: GaussianPlaneSource.place_at_center





.. automethod:: GaussianPlaneSource.place_below





.. automethod:: GaussianPlaneSource.place_on_grid





.. automethod:: GaussianPlaneSource.place_relative_to





.. automethod:: GaussianPlaneSource.plot_time_signal_and_spectrum





.. automethod:: GaussianPlaneSource.same_position





.. automethod:: GaussianPlaneSource.same_position_and_size





.. automethod:: GaussianPlaneSource.same_size





.. automethod:: GaussianPlaneSource.sample_time_signal





.. automethod:: GaussianPlaneSource.set_grid_coordinates





.. automethod:: GaussianPlaneSource.size_relative_to





.. automethod:: GaussianPlaneSource.update_E





.. automethod:: GaussianPlaneSource.update_H






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