Surfaces#

class pysimtra.surfaces.circle.Circle(name, radius, position=(0, 0, 0), orientation=(0, 0, 0), dtheta=180, save_avg_data=False, save_ind_data=False, avg_grid=None)#
Parameters:

  • name (str) – name of the circle

  • radius (float) – radius of the circle in m

  • position (tuple) – position (x, y, z) in m

  • orientation (tuple) – orientation (phi, theta, psi) in °

  • dtheta (float) – opening angle of the circle in °, defaults to a full circle

  • save_avg_data (bool) – whether the average data should be saved, defaults to False

  • save_ind_data (bool) – whether the individual data should be saved, defaults to False

  • avg_grid (tuple[int, ...]) – averaging grid size, tuple with number of segments in x and y direction

Returns:

Circle object

class pysimtra.surfaces.rectangle.Rectangle(name, dx, dy, position=(0, 0, 0), orientation=(0, 0, 0), save_avg_data=False, save_ind_data=False, avg_grid=None)#
Parameters:

  • name (str) – name of the rectangle

  • dx (float) – half width of the rectangle in m

  • dy (float) – half height of the rectangle in m

  • position (tuple) – position (x, y, z) in m

  • orientation (tuple) – orientation (phi, theta, psi) in °

  • save_avg_data (bool) – whether the average data should be saved, defaults to False

  • save_ind_data (bool) – whether the individual data should be saved, defaults to False

  • avg_grid (tuple[int, ...]) – averaging grid size, tuple with number of segments in x and y direction

Returns:

Rectangle object

class pysimtra.surfaces.cylinder.Cylinder(name, radius, height, position=(0, 0, 0), orientation=(0, 0, 0), dtheta=180, save_avg_data=False, save_ind_data=False, avg_grid=None)#
Parameters:

  • name (str) – name of the cylinder

  • radius (float) – radius of the circle in m

  • height (float) – height of the rectangle in m

  • position (tuple) – position (x, y, z) in m

  • orientation (tuple) – orientation (phi, theta, psi) in °

  • dtheta (float) – opening angle of the cylinder in °, defaults to a full cylinder

  • save_avg_data (bool) – whether the average data should be saved, defaults to False

  • save_ind_data (bool) – whether the individual data should be saved, defaults to False

  • avg_grid (tuple[int, ...]) – averaging grid size, tuple with number of segments in x and y direction. Ignored if save_avg_data is False

class pysimtra.surfaces.cone.Cone(name, small_rho, big_rho, height, position=(0, 0, 0), orientation=(0, 0, 0), dtheta=180, save_avg_data=False, save_ind_data=False, avg_grid=None)#
Parameters:

  • name (str) – name of the cone

  • small_rho (float) – small radius of the cone in m

  • big_rho (float) – big radius of the cone in m

  • height (float) – height of the cone in m

  • position (tuple) – position (x, y, z) in m

  • orientation (tuple) – orientation (phi, theta, psi) in °

  • dtheta (float) – opening angle of the cone in °, defaults to a full cone

  • save_avg_data (bool) – whether the average data should be saved, defaults to False

  • save_ind_data (bool) – whether the individual data should be saved, defaults to False

  • avg_grid (tuple[int, ...]) – averaging grid size, tuple with number of segments in x and y direction. Ignored if save_avg_data is False

class pysimtra.surfaces.sphere.Sphere(name, radius, dphi=180, position=(0, 0, 0), orientation=(0, 0, 0), dtheta=180, save_avg_data=False, save_ind_data=False, avg_grid=None)#
Parameters:

  • name (str) – name of the sphere

  • radius (float) – radius of the sphere in m

  • dphi (float) – opening angle 1 of the sphere in °, defaults to a sphere

  • position (tuple) – position (x, y, z) in m

  • orientation (tuple) – orientation (phi, theta, psi) in °

  • dtheta (float) – opening angle 2 of the sphere in °, defaults to a full sphere

  • save_avg_data (bool) – whether the average data should be saved, defaults to False

  • save_ind_data (bool) – whether the individual data should be saved, defaults to False

  • avg_grid (tuple[int, ...]) – averaging grid size, tuple with number of segments in x and y direction. Ignored if save_avg_data is False