fdtdx.PhasorDetector
====================

.. currentmodule:: fdtdx

.. autoclass:: PhasorDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~PhasorDetector.color`



* :attr:`~PhasorDetector.components`



* :attr:`~PhasorDetector.dtype`



* :attr:`~PhasorDetector.exact_interpolation`



* :attr:`~PhasorDetector.grid_shape`



* :attr:`~PhasorDetector.grid_slice`



* :attr:`~PhasorDetector.grid_slice_tuple`



* :attr:`~PhasorDetector.if_inverse_plot_backwards`



* :attr:`~PhasorDetector.inverse`



* :attr:`~PhasorDetector.max_random_grid_offsets`



* :attr:`~PhasorDetector.max_random_real_offsets`



* :attr:`~PhasorDetector.name`



* :attr:`~PhasorDetector.num_time_steps_recorded`



* :attr:`~PhasorDetector.num_video_workers`



* :attr:`~PhasorDetector.partial_grid_shape`



* :attr:`~PhasorDetector.partial_real_position`



* :attr:`~PhasorDetector.partial_real_shape`



* :attr:`~PhasorDetector.plot`



* :attr:`~PhasorDetector.plot_dpi`



* :attr:`~PhasorDetector.plot_interpolation`



* :attr:`~PhasorDetector.real_shape`



* :attr:`~PhasorDetector.reduce_volume`



* :attr:`~PhasorDetector.scaling_mode`



* :attr:`~PhasorDetector.switch`



* :attr:`~PhasorDetector.wave_characters`






.. rubric:: Methods





* :attr:`~PhasorDetector.apply`



* :attr:`~PhasorDetector.aset`



* :attr:`~PhasorDetector.check_overlap`



* :attr:`~PhasorDetector.draw_plot`



* :attr:`~PhasorDetector.extend_to`



* :attr:`~PhasorDetector.face_to_face_negative_direction`



* :attr:`~PhasorDetector.face_to_face_positive_direction`



* :attr:`~PhasorDetector.get_class_fields`



* :attr:`~PhasorDetector.get_public_fields`



* :attr:`~PhasorDetector.init_state`



* :attr:`~PhasorDetector.place_above`



* :attr:`~PhasorDetector.place_at_center`



* :attr:`~PhasorDetector.place_below`



* :attr:`~PhasorDetector.place_on_grid`



* :attr:`~PhasorDetector.place_relative_to`



* :attr:`~PhasorDetector.same_position`



* :attr:`~PhasorDetector.same_position_and_size`



* :attr:`~PhasorDetector.same_size`



* :attr:`~PhasorDetector.set_grid_coordinates`



* :attr:`~PhasorDetector.size_relative_to`



* :attr:`~PhasorDetector.update`







Attributes
==========





.. autoattribute:: PhasorDetector.color



.. autoattribute:: PhasorDetector.components



.. autoattribute:: PhasorDetector.dtype



.. autoattribute:: PhasorDetector.exact_interpolation



.. autoattribute:: PhasorDetector.grid_shape



.. autoattribute:: PhasorDetector.grid_slice



.. autoattribute:: PhasorDetector.grid_slice_tuple



.. autoattribute:: PhasorDetector.if_inverse_plot_backwards



.. autoattribute:: PhasorDetector.inverse



.. autoattribute:: PhasorDetector.max_random_grid_offsets



.. autoattribute:: PhasorDetector.max_random_real_offsets



.. autoattribute:: PhasorDetector.name



.. autoattribute:: PhasorDetector.num_time_steps_recorded



.. autoattribute:: PhasorDetector.num_video_workers



.. autoattribute:: PhasorDetector.partial_grid_shape



.. autoattribute:: PhasorDetector.partial_real_position



.. autoattribute:: PhasorDetector.partial_real_shape



.. autoattribute:: PhasorDetector.plot



.. autoattribute:: PhasorDetector.plot_dpi



.. autoattribute:: PhasorDetector.plot_interpolation



.. autoattribute:: PhasorDetector.real_shape



.. autoattribute:: PhasorDetector.reduce_volume



.. autoattribute:: PhasorDetector.scaling_mode



.. autoattribute:: PhasorDetector.switch



.. autoattribute:: PhasorDetector.wave_characters








Methods
==========








.. automethod:: PhasorDetector.apply





.. automethod:: PhasorDetector.aset





.. automethod:: PhasorDetector.check_overlap





.. automethod:: PhasorDetector.draw_plot





.. automethod:: PhasorDetector.extend_to





.. automethod:: PhasorDetector.face_to_face_negative_direction





.. automethod:: PhasorDetector.face_to_face_positive_direction





.. automethod:: PhasorDetector.get_class_fields





.. automethod:: PhasorDetector.get_public_fields





.. automethod:: PhasorDetector.init_state





.. automethod:: PhasorDetector.place_above





.. automethod:: PhasorDetector.place_at_center





.. automethod:: PhasorDetector.place_below





.. automethod:: PhasorDetector.place_on_grid





.. automethod:: PhasorDetector.place_relative_to





.. automethod:: PhasorDetector.same_position





.. automethod:: PhasorDetector.same_position_and_size





.. automethod:: PhasorDetector.same_size





.. automethod:: PhasorDetector.set_grid_coordinates





.. automethod:: PhasorDetector.size_relative_to





.. automethod:: PhasorDetector.update






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