fdtdx.FieldProjectionKSpaceDetector
===================================

.. currentmodule:: fdtdx

.. autoclass:: FieldProjectionKSpaceDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~FieldProjectionKSpaceDetector.color`



* :attr:`~FieldProjectionKSpaceDetector.components`



* :attr:`~FieldProjectionKSpaceDetector.dft_subsample`



* :attr:`~FieldProjectionKSpaceDetector.direction`



* :attr:`~FieldProjectionKSpaceDetector.dtype`



* :attr:`~FieldProjectionKSpaceDetector.exact_interpolation`



* :attr:`~FieldProjectionKSpaceDetector.exact_projection_batch_size`



* :attr:`~FieldProjectionKSpaceDetector.exclude_surfaces`



* :attr:`~FieldProjectionKSpaceDetector.far_field_approx`



* :attr:`~FieldProjectionKSpaceDetector.grid_shape`



* :attr:`~FieldProjectionKSpaceDetector.grid_slice`



* :attr:`~FieldProjectionKSpaceDetector.grid_slice_tuple`



* :attr:`~FieldProjectionKSpaceDetector.if_inverse_plot_backwards`



* :attr:`~FieldProjectionKSpaceDetector.interval_space`



* :attr:`~FieldProjectionKSpaceDetector.inverse`



* :attr:`~FieldProjectionKSpaceDetector.max_random_grid_offsets`



* :attr:`~FieldProjectionKSpaceDetector.max_random_real_offsets`



* :attr:`~FieldProjectionKSpaceDetector.name`



* :attr:`~FieldProjectionKSpaceDetector.num_time_steps_recorded`



* :attr:`~FieldProjectionKSpaceDetector.num_video_workers`



* :attr:`~FieldProjectionKSpaceDetector.origin`



* :attr:`~FieldProjectionKSpaceDetector.partial_grid_shape`



* :attr:`~FieldProjectionKSpaceDetector.partial_real_position`



* :attr:`~FieldProjectionKSpaceDetector.partial_real_shape`



* :attr:`~FieldProjectionKSpaceDetector.plot`



* :attr:`~FieldProjectionKSpaceDetector.plot_dpi`



* :attr:`~FieldProjectionKSpaceDetector.plot_interpolation`



* :attr:`~FieldProjectionKSpaceDetector.projection_axis`



* :attr:`~FieldProjectionKSpaceDetector.projection_distance`



* :attr:`~FieldProjectionKSpaceDetector.projection_medium`



* :attr:`~FieldProjectionKSpaceDetector.projection_medium_impedance`



* :attr:`~FieldProjectionKSpaceDetector.projection_medium_refractive_index`



* :attr:`~FieldProjectionKSpaceDetector.propagation_axis`



* :attr:`~FieldProjectionKSpaceDetector.real_shape`



* :attr:`~FieldProjectionKSpaceDetector.reduce_volume`



* :attr:`~FieldProjectionKSpaceDetector.scaling_mode`



* :attr:`~FieldProjectionKSpaceDetector.switch`



* :attr:`~FieldProjectionKSpaceDetector.wave_characters`



* :attr:`~FieldProjectionKSpaceDetector.window_size`






.. rubric:: Methods





* :attr:`~FieldProjectionKSpaceDetector.apply`



* :attr:`~FieldProjectionKSpaceDetector.aset`



* :attr:`~FieldProjectionKSpaceDetector.check_overlap`



* :attr:`~FieldProjectionKSpaceDetector.draw_plot`



* :attr:`~FieldProjectionKSpaceDetector.extend_to`



* :attr:`~FieldProjectionKSpaceDetector.face_to_face_negative_direction`



* :attr:`~FieldProjectionKSpaceDetector.face_to_face_positive_direction`



* :attr:`~FieldProjectionKSpaceDetector.get_class_fields`



* :attr:`~FieldProjectionKSpaceDetector.get_public_fields`



* :attr:`~FieldProjectionKSpaceDetector.init_state`



* :attr:`~FieldProjectionKSpaceDetector.place_above`



* :attr:`~FieldProjectionKSpaceDetector.place_at_center`



* :attr:`~FieldProjectionKSpaceDetector.place_below`



* :attr:`~FieldProjectionKSpaceDetector.place_on_grid`



* :attr:`~FieldProjectionKSpaceDetector.place_relative_to`



* :attr:`~FieldProjectionKSpaceDetector.project`



* :attr:`~FieldProjectionKSpaceDetector.project_all`



* :attr:`~FieldProjectionKSpaceDetector.same_position`



* :attr:`~FieldProjectionKSpaceDetector.same_position_and_size`



* :attr:`~FieldProjectionKSpaceDetector.same_size`



* :attr:`~FieldProjectionKSpaceDetector.set_grid_coordinates`



* :attr:`~FieldProjectionKSpaceDetector.size_relative_to`



* :attr:`~FieldProjectionKSpaceDetector.update`



* :attr:`~FieldProjectionKSpaceDetector.validate_placement`







Attributes
==========





.. autoattribute:: FieldProjectionKSpaceDetector.color



.. autoattribute:: FieldProjectionKSpaceDetector.components



.. autoattribute:: FieldProjectionKSpaceDetector.dft_subsample



.. autoattribute:: FieldProjectionKSpaceDetector.direction



.. autoattribute:: FieldProjectionKSpaceDetector.dtype



.. autoattribute:: FieldProjectionKSpaceDetector.exact_interpolation



.. autoattribute:: FieldProjectionKSpaceDetector.exact_projection_batch_size



.. autoattribute:: FieldProjectionKSpaceDetector.exclude_surfaces



.. autoattribute:: FieldProjectionKSpaceDetector.far_field_approx



.. autoattribute:: FieldProjectionKSpaceDetector.grid_shape



.. autoattribute:: FieldProjectionKSpaceDetector.grid_slice



.. autoattribute:: FieldProjectionKSpaceDetector.grid_slice_tuple



.. autoattribute:: FieldProjectionKSpaceDetector.if_inverse_plot_backwards



.. autoattribute:: FieldProjectionKSpaceDetector.interval_space



.. autoattribute:: FieldProjectionKSpaceDetector.inverse



.. autoattribute:: FieldProjectionKSpaceDetector.max_random_grid_offsets



.. autoattribute:: FieldProjectionKSpaceDetector.max_random_real_offsets



.. autoattribute:: FieldProjectionKSpaceDetector.name



.. autoattribute:: FieldProjectionKSpaceDetector.num_time_steps_recorded



.. autoattribute:: FieldProjectionKSpaceDetector.num_video_workers



.. autoattribute:: FieldProjectionKSpaceDetector.origin



.. autoattribute:: FieldProjectionKSpaceDetector.partial_grid_shape



.. autoattribute:: FieldProjectionKSpaceDetector.partial_real_position



.. autoattribute:: FieldProjectionKSpaceDetector.partial_real_shape



.. autoattribute:: FieldProjectionKSpaceDetector.plot



.. autoattribute:: FieldProjectionKSpaceDetector.plot_dpi



.. autoattribute:: FieldProjectionKSpaceDetector.plot_interpolation



.. autoattribute:: FieldProjectionKSpaceDetector.projection_axis



.. autoattribute:: FieldProjectionKSpaceDetector.projection_distance



.. autoattribute:: FieldProjectionKSpaceDetector.projection_medium



.. autoattribute:: FieldProjectionKSpaceDetector.projection_medium_impedance



.. autoattribute:: FieldProjectionKSpaceDetector.projection_medium_refractive_index



.. autoattribute:: FieldProjectionKSpaceDetector.propagation_axis



.. autoattribute:: FieldProjectionKSpaceDetector.real_shape



.. autoattribute:: FieldProjectionKSpaceDetector.reduce_volume



.. autoattribute:: FieldProjectionKSpaceDetector.scaling_mode



.. autoattribute:: FieldProjectionKSpaceDetector.switch



.. autoattribute:: FieldProjectionKSpaceDetector.wave_characters



.. autoattribute:: FieldProjectionKSpaceDetector.window_size








Methods
==========








.. automethod:: FieldProjectionKSpaceDetector.apply





.. automethod:: FieldProjectionKSpaceDetector.aset





.. automethod:: FieldProjectionKSpaceDetector.check_overlap





.. automethod:: FieldProjectionKSpaceDetector.draw_plot





.. automethod:: FieldProjectionKSpaceDetector.extend_to





.. automethod:: FieldProjectionKSpaceDetector.face_to_face_negative_direction





.. automethod:: FieldProjectionKSpaceDetector.face_to_face_positive_direction





.. automethod:: FieldProjectionKSpaceDetector.get_class_fields





.. automethod:: FieldProjectionKSpaceDetector.get_public_fields





.. automethod:: FieldProjectionKSpaceDetector.init_state





.. automethod:: FieldProjectionKSpaceDetector.place_above





.. automethod:: FieldProjectionKSpaceDetector.place_at_center





.. automethod:: FieldProjectionKSpaceDetector.place_below





.. automethod:: FieldProjectionKSpaceDetector.place_on_grid





.. automethod:: FieldProjectionKSpaceDetector.place_relative_to





.. automethod:: FieldProjectionKSpaceDetector.project





.. automethod:: FieldProjectionKSpaceDetector.project_all





.. automethod:: FieldProjectionKSpaceDetector.same_position





.. automethod:: FieldProjectionKSpaceDetector.same_position_and_size





.. automethod:: FieldProjectionKSpaceDetector.same_size





.. automethod:: FieldProjectionKSpaceDetector.set_grid_coordinates





.. automethod:: FieldProjectionKSpaceDetector.size_relative_to





.. automethod:: FieldProjectionKSpaceDetector.update





.. automethod:: FieldProjectionKSpaceDetector.validate_placement






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