Filter#
- class esis.optics.Filter(material: None | optika.materials._materials.AbstractMaterial = None, material_oxide: None | optika.materials._materials.AbstractMaterial = None, material_mesh: None | optika.materials._materials.AbstractMaterial = None, ratio_mesh: float | named_arrays._scalars.scalars.AbstractScalar = 0, frequency_mesh: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. 1 / mm>, radius_clear: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, width_border: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, thickness: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, thickness_oxide: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, distance_radial: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, azimuth: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, translation: astropy.units.quantity.Quantity | named_arrays._vectors.cartesian.vectors_cartesian_3d.AbstractCartesian3dVectorArray = <Quantity 0. mm>, pitch: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, yaw: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, roll: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>)#
Bases:
AbstractFilter
Attributes
the coordinate transformation between the global coordinate system and this object's local coordinate system
Methods
__init__
([material, material_oxide, ...])to_string
([prefix])Public-facing version of the
__repr__
method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.Inheritance Diagram
- Parameters:
material (None | AbstractMaterial)
material_oxide (None | AbstractMaterial)
material_mesh (None | AbstractMaterial)
ratio_mesh (float | AbstractScalar)
frequency_mesh (Quantity | AbstractScalar)
radius_clear (Quantity | AbstractScalar)
width_border (Quantity | AbstractScalar)
thickness (Quantity | AbstractScalar)
thickness_oxide (Quantity | AbstractScalar)
distance_radial (Quantity | AbstractScalar)
azimuth (Quantity | AbstractScalar)
translation (Quantity | AbstractCartesian3dVectorArray)
pitch (Quantity | AbstractScalar)
yaw (Quantity | AbstractScalar)
roll (Quantity | AbstractScalar)
- to_string(prefix=None)#
Public-facing version of the
__repr__
method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.
- azimuth: Quantity | AbstractScalar = <Quantity 0. deg>#
- distance_radial: Quantity | AbstractScalar = <Quantity 0. mm>#
- frequency_mesh: Quantity | AbstractScalar = <Quantity 0. 1 / mm>#
- material: None | AbstractMaterial = None#
- material_mesh: None | AbstractMaterial = None#
- material_oxide: None | AbstractMaterial = None#
- pitch: Quantity | AbstractScalar = <Quantity 0. deg>#
- radius_clear: Quantity | AbstractScalar = <Quantity 0. mm>#
- ratio_mesh: float | AbstractScalar = 0#
- roll: Quantity | AbstractScalar = <Quantity 0. deg>#
- thickness: Quantity | AbstractScalar = <Quantity 0. mm>#
- thickness_oxide: Quantity | AbstractScalar = <Quantity 0. mm>#
- property transformation: AbstractTransformation#
the coordinate transformation between the global coordinate system and this object’s local coordinate system
- translation: Quantity | AbstractCartesian3dVectorArray = <Quantity 0. mm>#
- width_border: Quantity | AbstractScalar = <Quantity 0. mm>#
- yaw: Quantity | AbstractScalar = <Quantity 0. deg>#