fdtdx.GDSLayerObject
====================

.. currentmodule:: fdtdx

.. autoclass:: GDSLayerObject
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~GDSLayerObject.axis`



* :attr:`~GDSLayerObject.color`



* :attr:`~GDSLayerObject.fill_supersample`



* :attr:`~GDSLayerObject.gds_center`



* :attr:`~GDSLayerObject.grid_shape`



* :attr:`~GDSLayerObject.grid_slice`



* :attr:`~GDSLayerObject.grid_slice_tuple`



* :attr:`~GDSLayerObject.horizontal_axis`



* :attr:`~GDSLayerObject.material_name`



* :attr:`~GDSLayerObject.materials`



* :attr:`~GDSLayerObject.max_random_grid_offsets`



* :attr:`~GDSLayerObject.max_random_real_offsets`



* :attr:`~GDSLayerObject.name`



* :attr:`~GDSLayerObject.partial_grid_shape`



* :attr:`~GDSLayerObject.partial_real_position`



* :attr:`~GDSLayerObject.partial_real_shape`



* :attr:`~GDSLayerObject.placement_order`



* :attr:`~GDSLayerObject.polygons`



* :attr:`~GDSLayerObject.real_shape`



* :attr:`~GDSLayerObject.reference_plane`



* :attr:`~GDSLayerObject.sidewall_angle`



* :attr:`~GDSLayerObject.subpixel_full_tensor`



* :attr:`~GDSLayerObject.subpixel_smoothing`



* :attr:`~GDSLayerObject.thickness`



* :attr:`~GDSLayerObject.vertical_axis`






.. rubric:: Methods





* :attr:`~GDSLayerObject.apply`



* :attr:`~GDSLayerObject.aset`



* :attr:`~GDSLayerObject.check_overlap`



* :attr:`~GDSLayerObject.extend_to`



* :attr:`~GDSLayerObject.face_to_face_negative_direction`



* :attr:`~GDSLayerObject.face_to_face_positive_direction`



* :attr:`~GDSLayerObject.get_class_fields`



* :attr:`~GDSLayerObject.get_fill_fraction_for_shape`



* :attr:`~GDSLayerObject.get_geometry_size_hint`



* :attr:`~GDSLayerObject.get_interface_normal_for_shape`



* :attr:`~GDSLayerObject.get_material_mapping`



* :attr:`~GDSLayerObject.get_public_fields`



* :attr:`~GDSLayerObject.get_voxel_mask_for_shape`



* :attr:`~GDSLayerObject.place_above`



* :attr:`~GDSLayerObject.place_at_center`



* :attr:`~GDSLayerObject.place_below`



* :attr:`~GDSLayerObject.place_on_grid`



* :attr:`~GDSLayerObject.place_relative_to`



* :attr:`~GDSLayerObject.same_position`



* :attr:`~GDSLayerObject.same_position_and_size`



* :attr:`~GDSLayerObject.same_size`



* :attr:`~GDSLayerObject.set_grid_coordinates`



* :attr:`~GDSLayerObject.size_relative_to`



* :attr:`~GDSLayerObject.validate_placement`







Attributes
==========





.. autoattribute:: GDSLayerObject.axis



.. autoattribute:: GDSLayerObject.color



.. autoattribute:: GDSLayerObject.fill_supersample



.. autoattribute:: GDSLayerObject.gds_center



.. autoattribute:: GDSLayerObject.grid_shape



.. autoattribute:: GDSLayerObject.grid_slice



.. autoattribute:: GDSLayerObject.grid_slice_tuple



.. autoattribute:: GDSLayerObject.horizontal_axis



.. autoattribute:: GDSLayerObject.material_name



.. autoattribute:: GDSLayerObject.materials



.. autoattribute:: GDSLayerObject.max_random_grid_offsets



.. autoattribute:: GDSLayerObject.max_random_real_offsets



.. autoattribute:: GDSLayerObject.name



.. autoattribute:: GDSLayerObject.partial_grid_shape



.. autoattribute:: GDSLayerObject.partial_real_position



.. autoattribute:: GDSLayerObject.partial_real_shape



.. autoattribute:: GDSLayerObject.placement_order



.. autoattribute:: GDSLayerObject.polygons



.. autoattribute:: GDSLayerObject.real_shape



.. autoattribute:: GDSLayerObject.reference_plane



.. autoattribute:: GDSLayerObject.sidewall_angle



.. autoattribute:: GDSLayerObject.subpixel_full_tensor



.. autoattribute:: GDSLayerObject.subpixel_smoothing



.. autoattribute:: GDSLayerObject.thickness



.. autoattribute:: GDSLayerObject.vertical_axis








Methods
==========








.. automethod:: GDSLayerObject.apply





.. automethod:: GDSLayerObject.aset





.. automethod:: GDSLayerObject.check_overlap





.. automethod:: GDSLayerObject.extend_to





.. automethod:: GDSLayerObject.face_to_face_negative_direction





.. automethod:: GDSLayerObject.face_to_face_positive_direction





.. automethod:: GDSLayerObject.get_class_fields





.. automethod:: GDSLayerObject.get_fill_fraction_for_shape





.. automethod:: GDSLayerObject.get_geometry_size_hint





.. automethod:: GDSLayerObject.get_interface_normal_for_shape





.. automethod:: GDSLayerObject.get_material_mapping





.. automethod:: GDSLayerObject.get_public_fields





.. automethod:: GDSLayerObject.get_voxel_mask_for_shape





.. automethod:: GDSLayerObject.place_above





.. automethod:: GDSLayerObject.place_at_center





.. automethod:: GDSLayerObject.place_below





.. automethod:: GDSLayerObject.place_on_grid





.. automethod:: GDSLayerObject.place_relative_to





.. automethod:: GDSLayerObject.same_position





.. automethod:: GDSLayerObject.same_position_and_size





.. automethod:: GDSLayerObject.same_size





.. automethod:: GDSLayerObject.set_grid_coordinates





.. automethod:: GDSLayerObject.size_relative_to





.. automethod:: GDSLayerObject.validate_placement






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