fdtdx.EnergyDetector
====================

.. currentmodule:: fdtdx

.. autoclass:: EnergyDetector
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~EnergyDetector.aggregate`



* :attr:`~EnergyDetector.as_slices`





* :attr:`~EnergyDetector.color`



* :attr:`~EnergyDetector.dtype`



* :attr:`~EnergyDetector.exact_interpolation`



* :attr:`~EnergyDetector.grid_shape`



* :attr:`~EnergyDetector.grid_slice`



* :attr:`~EnergyDetector.grid_slice_tuple`



* :attr:`~EnergyDetector.if_inverse_plot_backwards`



* :attr:`~EnergyDetector.inverse`



* :attr:`~EnergyDetector.max_random_grid_offsets`



* :attr:`~EnergyDetector.max_random_real_offsets`



* :attr:`~EnergyDetector.name`



* :attr:`~EnergyDetector.num_time_steps_recorded`



* :attr:`~EnergyDetector.num_video_workers`



* :attr:`~EnergyDetector.partial_grid_shape`



* :attr:`~EnergyDetector.partial_real_position`



* :attr:`~EnergyDetector.partial_real_shape`



* :attr:`~EnergyDetector.plot`



* :attr:`~EnergyDetector.plot_dpi`



* :attr:`~EnergyDetector.plot_interpolation`



* :attr:`~EnergyDetector.real_shape`



* :attr:`~EnergyDetector.reduce_volume`



* :attr:`~EnergyDetector.switch`



* :attr:`~EnergyDetector.x_slice`



* :attr:`~EnergyDetector.y_slice`



* :attr:`~EnergyDetector.z_slice`






.. rubric:: Methods





* :attr:`~EnergyDetector.apply`



* :attr:`~EnergyDetector.aset`



* :attr:`~EnergyDetector.check_overlap`



* :attr:`~EnergyDetector.draw_plot`



* :attr:`~EnergyDetector.extend_to`



* :attr:`~EnergyDetector.face_to_face_negative_direction`



* :attr:`~EnergyDetector.face_to_face_positive_direction`



* :attr:`~EnergyDetector.get_class_fields`



* :attr:`~EnergyDetector.get_public_fields`



* :attr:`~EnergyDetector.init_state`



* :attr:`~EnergyDetector.place_above`



* :attr:`~EnergyDetector.place_at_center`



* :attr:`~EnergyDetector.place_below`



* :attr:`~EnergyDetector.place_on_grid`



* :attr:`~EnergyDetector.place_relative_to`



* :attr:`~EnergyDetector.same_position`



* :attr:`~EnergyDetector.same_position_and_size`



* :attr:`~EnergyDetector.same_size`



* :attr:`~EnergyDetector.set_grid_coordinates`



* :attr:`~EnergyDetector.size_relative_to`



* :attr:`~EnergyDetector.update`







Attributes
==========



.. autoattribute:: EnergyDetector.aggregate



.. autoattribute:: EnergyDetector.as_slices





.. autoattribute:: EnergyDetector.color



.. autoattribute:: EnergyDetector.dtype



.. autoattribute:: EnergyDetector.exact_interpolation



.. autoattribute:: EnergyDetector.grid_shape



.. autoattribute:: EnergyDetector.grid_slice



.. autoattribute:: EnergyDetector.grid_slice_tuple



.. autoattribute:: EnergyDetector.if_inverse_plot_backwards



.. autoattribute:: EnergyDetector.inverse



.. autoattribute:: EnergyDetector.max_random_grid_offsets



.. autoattribute:: EnergyDetector.max_random_real_offsets



.. autoattribute:: EnergyDetector.name



.. autoattribute:: EnergyDetector.num_time_steps_recorded



.. autoattribute:: EnergyDetector.num_video_workers



.. autoattribute:: EnergyDetector.partial_grid_shape



.. autoattribute:: EnergyDetector.partial_real_position



.. autoattribute:: EnergyDetector.partial_real_shape



.. autoattribute:: EnergyDetector.plot



.. autoattribute:: EnergyDetector.plot_dpi



.. autoattribute:: EnergyDetector.plot_interpolation



.. autoattribute:: EnergyDetector.real_shape



.. autoattribute:: EnergyDetector.reduce_volume



.. autoattribute:: EnergyDetector.switch



.. autoattribute:: EnergyDetector.x_slice



.. autoattribute:: EnergyDetector.y_slice



.. autoattribute:: EnergyDetector.z_slice








Methods
==========








.. automethod:: EnergyDetector.apply





.. automethod:: EnergyDetector.aset





.. automethod:: EnergyDetector.check_overlap





.. automethod:: EnergyDetector.draw_plot





.. automethod:: EnergyDetector.extend_to





.. automethod:: EnergyDetector.face_to_face_negative_direction





.. automethod:: EnergyDetector.face_to_face_positive_direction





.. automethod:: EnergyDetector.get_class_fields





.. automethod:: EnergyDetector.get_public_fields





.. automethod:: EnergyDetector.init_state





.. automethod:: EnergyDetector.place_above





.. automethod:: EnergyDetector.place_at_center





.. automethod:: EnergyDetector.place_below





.. automethod:: EnergyDetector.place_on_grid





.. automethod:: EnergyDetector.place_relative_to





.. automethod:: EnergyDetector.same_position





.. automethod:: EnergyDetector.same_position_and_size





.. automethod:: EnergyDetector.same_size





.. automethod:: EnergyDetector.set_grid_coordinates





.. automethod:: EnergyDetector.size_relative_to





.. automethod:: EnergyDetector.update






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