Update documentation.md

parent 1d902a7e
......@@ -203,7 +203,7 @@ Parameters:
### MecaRobotForDosimetry
This class inherits from the MecaRobot class and adapts it for scintillation dosimetry. It reads the signal of scintillators from a signal queue, while keeping track of each scintillators' position. The lowest scintillator is set as the tool reference frame (TRF), which means that the movement commands will send the lowest scintillator to the specified position. For each scintillator, two files will be created : one containing the scintillator's position relative to the source (scintillator_x_position_relative_to_source.txt) and one containing the scintillator's absolute distance to the source (scintillator_x_distance_to_source.txt). A file containing the scintillators' signal (scintillators_signal.txt) will be created, as well as a file containing the time (time.txt).
**MecaRobotForDosimetry**(*ip="192.168.0.100", port=10000, simulation_mode=False, enable_log=False, scintillators_positions=np.array([0]), source_position=np.array([0,0,0]), water_level=-np.inf, scintillators_signal_queue=None*)
**MecaRobotForDosimetry**(*ip="192.168.0.100", port=10000, simulation_mode=False, enable_log=False, scintillators_positions=np.array([0,0,0]), source_position=np.array([0,0,0]), water_level=-np.inf, scintillators_signal_queue=None*)
Connects to the robot. The robot is then activated, homed and sent to its initial position (every joint at 0°).
......@@ -222,7 +222,7 @@ Parameters:
Enables the log, in which case every communication with the robot is written in the *log.txt* file.
- **scintillators_positions : *np.ndarray***
Array of each scintillator's position in the form (x, y, z) (in mm) relative to the end of the robot (flange reference frame), starting with the closest. The x, y and z axis are defined as [such](https://photos.app.goo.gl/VJsigoDeULbp3z447). For instance, with the scintillators setup depicted [here](https://photos.app.goo.gl/hMZSctgg5Qzhubjn6), this parameter would be *np.array([[3, 0, -10], [3, 0, -15], [3, 0 -20]])*.
Array of each scintillator's position in the form (x, y, z) (in mm) relative to the end of the robot (flange reference frame), starting with the closest. The x, y and z axis are defined as [such](https://photos.app.goo.gl/VJsigoDeULbp3z447). For instance, with the scintillators setup depicted [here](https://photos.app.goo.gl/hMZSctgg5Qzhubjn6), this parameter would be `np.array([[3, 0, -10], [3, 0, -15], [3, 0 -20]])`.
- **source_position : *np.ndarray***
Position (x, y, z) of the source (in mm) in relation to the base of the robot (world reference frame).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment