fdtdx.Detector
==============

.. currentmodule:: fdtdx

.. autoclass:: Detector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~Detector.color`



* :attr:`~Detector.dtype`



* :attr:`~Detector.exact_interpolation`



* :attr:`~Detector.grid_shape`



* :attr:`~Detector.grid_slice`



* :attr:`~Detector.grid_slice_tuple`



* :attr:`~Detector.if_inverse_plot_backwards`



* :attr:`~Detector.inverse`



* :attr:`~Detector.max_random_grid_offsets`



* :attr:`~Detector.max_random_real_offsets`



* :attr:`~Detector.name`



* :attr:`~Detector.num_time_steps_recorded`



* :attr:`~Detector.num_video_workers`



* :attr:`~Detector.partial_grid_shape`



* :attr:`~Detector.partial_real_position`



* :attr:`~Detector.partial_real_shape`



* :attr:`~Detector.plot`



* :attr:`~Detector.plot_dpi`



* :attr:`~Detector.plot_interpolation`



* :attr:`~Detector.real_shape`



* :attr:`~Detector.switch`






.. rubric:: Methods





* :attr:`~Detector.apply`



* :attr:`~Detector.aset`



* :attr:`~Detector.check_overlap`



* :attr:`~Detector.draw_plot`



* :attr:`~Detector.extend_to`



* :attr:`~Detector.face_to_face_negative_direction`



* :attr:`~Detector.face_to_face_positive_direction`



* :attr:`~Detector.get_class_fields`



* :attr:`~Detector.get_public_fields`



* :attr:`~Detector.init_state`



* :attr:`~Detector.place_above`



* :attr:`~Detector.place_at_center`



* :attr:`~Detector.place_below`



* :attr:`~Detector.place_on_grid`



* :attr:`~Detector.place_relative_to`



* :attr:`~Detector.same_position`



* :attr:`~Detector.same_position_and_size`



* :attr:`~Detector.same_size`



* :attr:`~Detector.set_grid_coordinates`



* :attr:`~Detector.size_relative_to`



* :attr:`~Detector.update`







Attributes
==========





.. autoattribute:: Detector.color



.. autoattribute:: Detector.dtype



.. autoattribute:: Detector.exact_interpolation



.. autoattribute:: Detector.grid_shape



.. autoattribute:: Detector.grid_slice



.. autoattribute:: Detector.grid_slice_tuple



.. autoattribute:: Detector.if_inverse_plot_backwards



.. autoattribute:: Detector.inverse



.. autoattribute:: Detector.max_random_grid_offsets



.. autoattribute:: Detector.max_random_real_offsets



.. autoattribute:: Detector.name



.. autoattribute:: Detector.num_time_steps_recorded



.. autoattribute:: Detector.num_video_workers



.. autoattribute:: Detector.partial_grid_shape



.. autoattribute:: Detector.partial_real_position



.. autoattribute:: Detector.partial_real_shape



.. autoattribute:: Detector.plot



.. autoattribute:: Detector.plot_dpi



.. autoattribute:: Detector.plot_interpolation



.. autoattribute:: Detector.real_shape



.. autoattribute:: Detector.switch








Methods
==========








.. automethod:: Detector.apply





.. automethod:: Detector.aset





.. automethod:: Detector.check_overlap





.. automethod:: Detector.draw_plot





.. automethod:: Detector.extend_to





.. automethod:: Detector.face_to_face_negative_direction





.. automethod:: Detector.face_to_face_positive_direction





.. automethod:: Detector.get_class_fields





.. automethod:: Detector.get_public_fields





.. automethod:: Detector.init_state





.. automethod:: Detector.place_above





.. automethod:: Detector.place_at_center





.. automethod:: Detector.place_below





.. automethod:: Detector.place_on_grid





.. automethod:: Detector.place_relative_to





.. automethod:: Detector.same_position





.. automethod:: Detector.same_position_and_size





.. automethod:: Detector.same_size





.. automethod:: Detector.set_grid_coordinates





.. automethod:: Detector.size_relative_to





.. automethod:: Detector.update






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