fdtdx.FieldProjectionCartesianDetector
======================================

.. currentmodule:: fdtdx

.. autoclass:: FieldProjectionCartesianDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~FieldProjectionCartesianDetector.color`



* :attr:`~FieldProjectionCartesianDetector.components`



* :attr:`~FieldProjectionCartesianDetector.dft_subsample`



* :attr:`~FieldProjectionCartesianDetector.direction`



* :attr:`~FieldProjectionCartesianDetector.dtype`



* :attr:`~FieldProjectionCartesianDetector.exact_interpolation`



* :attr:`~FieldProjectionCartesianDetector.exact_projection_batch_size`



* :attr:`~FieldProjectionCartesianDetector.exclude_surfaces`



* :attr:`~FieldProjectionCartesianDetector.far_field_approx`



* :attr:`~FieldProjectionCartesianDetector.grid_shape`



* :attr:`~FieldProjectionCartesianDetector.grid_slice`



* :attr:`~FieldProjectionCartesianDetector.grid_slice_tuple`



* :attr:`~FieldProjectionCartesianDetector.if_inverse_plot_backwards`



* :attr:`~FieldProjectionCartesianDetector.interval_space`



* :attr:`~FieldProjectionCartesianDetector.inverse`



* :attr:`~FieldProjectionCartesianDetector.max_random_grid_offsets`



* :attr:`~FieldProjectionCartesianDetector.max_random_real_offsets`



* :attr:`~FieldProjectionCartesianDetector.name`



* :attr:`~FieldProjectionCartesianDetector.num_time_steps_recorded`



* :attr:`~FieldProjectionCartesianDetector.num_video_workers`



* :attr:`~FieldProjectionCartesianDetector.origin`



* :attr:`~FieldProjectionCartesianDetector.partial_grid_shape`



* :attr:`~FieldProjectionCartesianDetector.partial_real_position`



* :attr:`~FieldProjectionCartesianDetector.partial_real_shape`



* :attr:`~FieldProjectionCartesianDetector.plot`



* :attr:`~FieldProjectionCartesianDetector.plot_dpi`



* :attr:`~FieldProjectionCartesianDetector.plot_interpolation`



* :attr:`~FieldProjectionCartesianDetector.projection_axis`



* :attr:`~FieldProjectionCartesianDetector.projection_distance`



* :attr:`~FieldProjectionCartesianDetector.projection_medium`



* :attr:`~FieldProjectionCartesianDetector.projection_medium_impedance`



* :attr:`~FieldProjectionCartesianDetector.projection_medium_refractive_index`



* :attr:`~FieldProjectionCartesianDetector.propagation_axis`



* :attr:`~FieldProjectionCartesianDetector.real_shape`



* :attr:`~FieldProjectionCartesianDetector.reduce_volume`



* :attr:`~FieldProjectionCartesianDetector.scaling_mode`



* :attr:`~FieldProjectionCartesianDetector.switch`



* :attr:`~FieldProjectionCartesianDetector.wave_characters`



* :attr:`~FieldProjectionCartesianDetector.window_size`






.. rubric:: Methods





* :attr:`~FieldProjectionCartesianDetector.apply`



* :attr:`~FieldProjectionCartesianDetector.aset`



* :attr:`~FieldProjectionCartesianDetector.check_overlap`



* :attr:`~FieldProjectionCartesianDetector.draw_plot`



* :attr:`~FieldProjectionCartesianDetector.extend_to`



* :attr:`~FieldProjectionCartesianDetector.face_to_face_negative_direction`



* :attr:`~FieldProjectionCartesianDetector.face_to_face_positive_direction`



* :attr:`~FieldProjectionCartesianDetector.get_class_fields`



* :attr:`~FieldProjectionCartesianDetector.get_public_fields`



* :attr:`~FieldProjectionCartesianDetector.init_state`



* :attr:`~FieldProjectionCartesianDetector.place_above`



* :attr:`~FieldProjectionCartesianDetector.place_at_center`



* :attr:`~FieldProjectionCartesianDetector.place_below`



* :attr:`~FieldProjectionCartesianDetector.place_on_grid`



* :attr:`~FieldProjectionCartesianDetector.place_relative_to`



* :attr:`~FieldProjectionCartesianDetector.project`



* :attr:`~FieldProjectionCartesianDetector.project_all`



* :attr:`~FieldProjectionCartesianDetector.same_position`



* :attr:`~FieldProjectionCartesianDetector.same_position_and_size`



* :attr:`~FieldProjectionCartesianDetector.same_size`



* :attr:`~FieldProjectionCartesianDetector.set_grid_coordinates`



* :attr:`~FieldProjectionCartesianDetector.size_relative_to`



* :attr:`~FieldProjectionCartesianDetector.update`



* :attr:`~FieldProjectionCartesianDetector.validate_placement`







Attributes
==========





.. autoattribute:: FieldProjectionCartesianDetector.color



.. autoattribute:: FieldProjectionCartesianDetector.components



.. autoattribute:: FieldProjectionCartesianDetector.dft_subsample



.. autoattribute:: FieldProjectionCartesianDetector.direction



.. autoattribute:: FieldProjectionCartesianDetector.dtype



.. autoattribute:: FieldProjectionCartesianDetector.exact_interpolation



.. autoattribute:: FieldProjectionCartesianDetector.exact_projection_batch_size



.. autoattribute:: FieldProjectionCartesianDetector.exclude_surfaces



.. autoattribute:: FieldProjectionCartesianDetector.far_field_approx



.. autoattribute:: FieldProjectionCartesianDetector.grid_shape



.. autoattribute:: FieldProjectionCartesianDetector.grid_slice



.. autoattribute:: FieldProjectionCartesianDetector.grid_slice_tuple



.. autoattribute:: FieldProjectionCartesianDetector.if_inverse_plot_backwards



.. autoattribute:: FieldProjectionCartesianDetector.interval_space



.. autoattribute:: FieldProjectionCartesianDetector.inverse



.. autoattribute:: FieldProjectionCartesianDetector.max_random_grid_offsets



.. autoattribute:: FieldProjectionCartesianDetector.max_random_real_offsets



.. autoattribute:: FieldProjectionCartesianDetector.name



.. autoattribute:: FieldProjectionCartesianDetector.num_time_steps_recorded



.. autoattribute:: FieldProjectionCartesianDetector.num_video_workers



.. autoattribute:: FieldProjectionCartesianDetector.origin



.. autoattribute:: FieldProjectionCartesianDetector.partial_grid_shape



.. autoattribute:: FieldProjectionCartesianDetector.partial_real_position



.. autoattribute:: FieldProjectionCartesianDetector.partial_real_shape



.. autoattribute:: FieldProjectionCartesianDetector.plot



.. autoattribute:: FieldProjectionCartesianDetector.plot_dpi



.. autoattribute:: FieldProjectionCartesianDetector.plot_interpolation



.. autoattribute:: FieldProjectionCartesianDetector.projection_axis



.. autoattribute:: FieldProjectionCartesianDetector.projection_distance



.. autoattribute:: FieldProjectionCartesianDetector.projection_medium



.. autoattribute:: FieldProjectionCartesianDetector.projection_medium_impedance



.. autoattribute:: FieldProjectionCartesianDetector.projection_medium_refractive_index



.. autoattribute:: FieldProjectionCartesianDetector.propagation_axis



.. autoattribute:: FieldProjectionCartesianDetector.real_shape



.. autoattribute:: FieldProjectionCartesianDetector.reduce_volume



.. autoattribute:: FieldProjectionCartesianDetector.scaling_mode



.. autoattribute:: FieldProjectionCartesianDetector.switch



.. autoattribute:: FieldProjectionCartesianDetector.wave_characters



.. autoattribute:: FieldProjectionCartesianDetector.window_size








Methods
==========








.. automethod:: FieldProjectionCartesianDetector.apply





.. automethod:: FieldProjectionCartesianDetector.aset





.. automethod:: FieldProjectionCartesianDetector.check_overlap





.. automethod:: FieldProjectionCartesianDetector.draw_plot





.. automethod:: FieldProjectionCartesianDetector.extend_to





.. automethod:: FieldProjectionCartesianDetector.face_to_face_negative_direction





.. automethod:: FieldProjectionCartesianDetector.face_to_face_positive_direction





.. automethod:: FieldProjectionCartesianDetector.get_class_fields





.. automethod:: FieldProjectionCartesianDetector.get_public_fields





.. automethod:: FieldProjectionCartesianDetector.init_state





.. automethod:: FieldProjectionCartesianDetector.place_above





.. automethod:: FieldProjectionCartesianDetector.place_at_center





.. automethod:: FieldProjectionCartesianDetector.place_below





.. automethod:: FieldProjectionCartesianDetector.place_on_grid





.. automethod:: FieldProjectionCartesianDetector.place_relative_to





.. automethod:: FieldProjectionCartesianDetector.project





.. automethod:: FieldProjectionCartesianDetector.project_all





.. automethod:: FieldProjectionCartesianDetector.same_position





.. automethod:: FieldProjectionCartesianDetector.same_position_and_size





.. automethod:: FieldProjectionCartesianDetector.same_size





.. automethod:: FieldProjectionCartesianDetector.set_grid_coordinates





.. automethod:: FieldProjectionCartesianDetector.size_relative_to





.. automethod:: FieldProjectionCartesianDetector.update





.. automethod:: FieldProjectionCartesianDetector.validate_placement






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