handybeam.excitation_solver

Note

Documentation unfinished

Note

for single focal point, use handybeam.solve_singlepoint_py()

Contains excitation solvers.

A basic single-point-focus excitation solver is handybeam.solver.Solver.single_focus_solver()

class handybeam.solver.Solver(parent=None)[source]

” Contains the OpenCL subsystem for single focus solver.

This class calls the OpenCL wrapper for the single focus solver.

__init__(parent=None)[source]

Initializes an instance of class Solver.

Parameters:parent (handybeam.world.World()) – This is an instance of the handybeam world class.
__repr__

Return repr(self).

__str__

Return str(self).

set_parent(new_parent)[source]

changes the parent of an instance of the class Solver.

Parameters:new_parent (handybeam.world.World()) – This is an instance of the handybeam world class.
single_focus_solver(x_focus, y_focus, z_focus, local_work_size=(1, 1, 1), print_performance_feedback=False)[source]

Solve excitation coefficients for a single focal point

This method calls the OpenCL wrapper mixin class single_focus_solver which determines the set of activation coefficients required to produce a single focal point a given point in space.

Parameters:
  • x_focus (numpy float) – This is the x-coordinate of the requested focal point position.
  • y_focus (numpy float) – This is the y-coordinate of the requested focal point position.
  • z_focus (numpy float) – This is the z-coordinate of the requested focal point position.
  • local_work_size (tuple) – Tuple containing the local work sizes for the GPU.
  • print_performance_feedback (boolean) – Boolean value determining whether or not to output the GPU performance statistics.

Back to Index

Licence (documentation): Creative Commons CC BY-NC-SA 4.0

Licence (source code): Apache 2.0

EU logo

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 737087.