A Python client library for the Autoscoper API
Project description
Autoscoper Python TCP Client
This document describes the interface allowing to interface with a running Autoscoper process from Python.
Setup
cd client_connection_libs/python
pip install -e .
- Open any python file and add
from PyAutoscoper.connect import *
to the top of the file. - Use any of the functions described below
Available functions:
-
openConnection
- Parameters:
address
- Return: autoscoper_socket
- MethodId:
NA
- Parameters:
-
loadTrial
- Parameters:
autoscoper_socket
trial_file
- Return:
None
- MethodId:
1
- Parameters:
-
loadTrackingData
- Parameters:
- Required parameters:
autoscoper_socket
volume
trackingData
- Optional parameters:
save_as_matrix
- If true, the tracking data will be saved as a 4 by 4 matrix. If false, the tracking data will be saved in xyz roll pitch yaw format. Defaults to true.save_as_rows
- If true, the tracking data will be saved as rows. If false, the tracking data will be saved as columns. Defaults to true.save_with_commas
- If true, the tracking data will be saved with commas. If false, the tracking data will be saved with spaces. Defaults to true.convert_to_cm
- If true, the tracking data will be converted to cm. If false, the tracking data will be saved in mm. Defaults to false.convert_to_rad
- If true, the tracking data will be converted to radians. If false, the tracking data will be saved in degrees. Defaults to false.interpolate
- If true, the tracking data will be interpolated using the spline method. If false, the tracking data will be saved as is (with NaN values). Defaults to false.
- Required parameters:
- Return:
None
- MethodId:
2
- Parameters:
-
saveTracking
- Parameters:
- Required parameters:
autoscoper_socket
volume
filename
- Optional parameters:
save_as_matrix
- If true, the tracking data will be saved as a 4 by 4 matrix. If false, the tracking data will be saved in xyz roll pitch yaw format. Defaults to true.save_as_rows
- If true, the tracking data will be saved as rows. If false, the tracking data will be saved as columns. Defaults to true.save_with_commas
- If true, the tracking data will be saved with commas. If false, the tracking data will be saved with spaces. Defaults to true.convert_to_cm
- If true, the tracking data will be converted to cm. If false, the tracking data will be saved in mm. Defaults to false.convert_to_rad
- If true, the tracking data will be converted to radians. If false, the tracking data will be saved in degrees. Defaults to false.interpolate
- If true, the tracking data will be interpolated using the spline method. If false, the tracking data will be saved as is (with NaN values). Defaults to false.
- Required parameters:
- Return:
None
- MethodId:
3
- Parameters:
-
loadFilters
- Parameters:
autoscoper_socket
cameraId
filtersConfig
- Return:
None
- MethodId:
4
- Parameters:
-
setFrame
- Parameters:
autoscoper_socket
frame
- Return:
None
- MethodId:
5
- Parameters:
-
getPose
- Parameters:
autoscoper_socket
volume
frame
- Return: pose
- MethodId:
6
- Parameters:
-
setPose
- Parameters:
autoscoper_socket
volume
frame
pose
- Return:
None
- MethodId:
7
- Parameters:
-
getNCC
- Parameters:
autoscoper_socket
volume
pose
- Return:
None
- MethodId:
8
- Parameters:
-
setBackground
- Parameters:
autoscoper_socket
value
- Return:
None
- MethodId:
9
- Parameters:
-
optimizeFrame
- Parameters:
autoscoper_socket
volumeID
frame
repeats
max_iter
min_lim
max_lim
max_stall_iter
- Return:
None
- MethodId:
11
- Parameters:
-
getFullDRR
- Parameters:
NA
- Return:
None
- MethodId: 12
- Parameters:
-
closeConnection
- Parameters:
NA
- Return:
None
- MethodId: 13
- Parameters:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
PyAutoscoper-1.0.0.tar.gz
(18.6 kB
view hashes)
Built Distribution
Close
Hashes for PyAutoscoper-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 400059659e57c75ac9d9112c183e5baff7c505239da71b902e3d7a32643a059a |
|
MD5 | dd6f5fd2e6e41f2857a42bc2c2e875f9 |
|
BLAKE2b-256 | 2f1bb0091f9ccd2a39351cc316f5dc59d0ed1de614d623725e733f6d24c7132b |