fdtdx.FieldDetector
===================

.. currentmodule:: fdtdx

.. autoclass:: FieldDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~FieldDetector.color`



* :attr:`~FieldDetector.components`



* :attr:`~FieldDetector.dtype`



* :attr:`~FieldDetector.exact_interpolation`



* :attr:`~FieldDetector.grid_shape`



* :attr:`~FieldDetector.grid_slice`



* :attr:`~FieldDetector.grid_slice_tuple`



* :attr:`~FieldDetector.if_inverse_plot_backwards`



* :attr:`~FieldDetector.inverse`



* :attr:`~FieldDetector.max_random_grid_offsets`



* :attr:`~FieldDetector.max_random_real_offsets`



* :attr:`~FieldDetector.name`



* :attr:`~FieldDetector.num_time_steps_recorded`



* :attr:`~FieldDetector.num_video_workers`



* :attr:`~FieldDetector.partial_grid_shape`



* :attr:`~FieldDetector.partial_real_position`



* :attr:`~FieldDetector.partial_real_shape`



* :attr:`~FieldDetector.plot`



* :attr:`~FieldDetector.plot_dpi`



* :attr:`~FieldDetector.plot_interpolation`



* :attr:`~FieldDetector.real_shape`



* :attr:`~FieldDetector.reduce_volume`



* :attr:`~FieldDetector.switch`






.. rubric:: Methods





* :attr:`~FieldDetector.apply`



* :attr:`~FieldDetector.aset`



* :attr:`~FieldDetector.check_overlap`



* :attr:`~FieldDetector.draw_plot`



* :attr:`~FieldDetector.extend_to`



* :attr:`~FieldDetector.face_to_face_negative_direction`



* :attr:`~FieldDetector.face_to_face_positive_direction`



* :attr:`~FieldDetector.get_class_fields`



* :attr:`~FieldDetector.get_public_fields`



* :attr:`~FieldDetector.init_state`



* :attr:`~FieldDetector.place_above`



* :attr:`~FieldDetector.place_at_center`



* :attr:`~FieldDetector.place_below`



* :attr:`~FieldDetector.place_on_grid`



* :attr:`~FieldDetector.place_relative_to`



* :attr:`~FieldDetector.same_position`



* :attr:`~FieldDetector.same_position_and_size`



* :attr:`~FieldDetector.same_size`



* :attr:`~FieldDetector.set_grid_coordinates`



* :attr:`~FieldDetector.size_relative_to`



* :attr:`~FieldDetector.update`







Attributes
==========





.. autoattribute:: FieldDetector.color



.. autoattribute:: FieldDetector.components



.. autoattribute:: FieldDetector.dtype



.. autoattribute:: FieldDetector.exact_interpolation



.. autoattribute:: FieldDetector.grid_shape



.. autoattribute:: FieldDetector.grid_slice



.. autoattribute:: FieldDetector.grid_slice_tuple



.. autoattribute:: FieldDetector.if_inverse_plot_backwards



.. autoattribute:: FieldDetector.inverse



.. autoattribute:: FieldDetector.max_random_grid_offsets



.. autoattribute:: FieldDetector.max_random_real_offsets



.. autoattribute:: FieldDetector.name



.. autoattribute:: FieldDetector.num_time_steps_recorded



.. autoattribute:: FieldDetector.num_video_workers



.. autoattribute:: FieldDetector.partial_grid_shape



.. autoattribute:: FieldDetector.partial_real_position



.. autoattribute:: FieldDetector.partial_real_shape



.. autoattribute:: FieldDetector.plot



.. autoattribute:: FieldDetector.plot_dpi



.. autoattribute:: FieldDetector.plot_interpolation



.. autoattribute:: FieldDetector.real_shape



.. autoattribute:: FieldDetector.reduce_volume



.. autoattribute:: FieldDetector.switch








Methods
==========








.. automethod:: FieldDetector.apply





.. automethod:: FieldDetector.aset





.. automethod:: FieldDetector.check_overlap





.. automethod:: FieldDetector.draw_plot





.. automethod:: FieldDetector.extend_to





.. automethod:: FieldDetector.face_to_face_negative_direction





.. automethod:: FieldDetector.face_to_face_positive_direction





.. automethod:: FieldDetector.get_class_fields





.. automethod:: FieldDetector.get_public_fields





.. automethod:: FieldDetector.init_state





.. automethod:: FieldDetector.place_above





.. automethod:: FieldDetector.place_at_center





.. automethod:: FieldDetector.place_below





.. automethod:: FieldDetector.place_on_grid





.. automethod:: FieldDetector.place_relative_to





.. automethod:: FieldDetector.same_position





.. automethod:: FieldDetector.same_position_and_size





.. automethod:: FieldDetector.same_size





.. automethod:: FieldDetector.set_grid_coordinates





.. automethod:: FieldDetector.size_relative_to





.. automethod:: FieldDetector.update






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