prosi3d package

Subpackages

Submodules

prosi3d.datahandler module

class prosi3d.datahandler.DataHandler[source]

Bases: object

Read the data

extract()[source]

read_container()[source]

prosi3d.sensorconfig module

prosi3d.sensorconfig.ac_freq = 50000: Optical Sensors

prosi3d.skeleton module

This is a skeleton file that can serve as a starting point for a Python console script. To run this script uncomment the following lines in the [options.entry_points] section in setup.cfg:

console_scripts =
     fibonacci = prosi3d.skeleton:run

Then run pip install . (or pip install -e . for editable mode) which will install the command fibonacci inside your current environment.

Besides console scripts, the header (i.e. until _logger…) of this file can also be used as template for Python modules.

Note

This skeleton file can be safely removed if not needed!

References

prosi3d.skeleton.fib(n)[source]

Fibonacci example function

Parameters:: n (int) – integer
Returns:: n-th Fibonacci number
Return type:: int

prosi3d.skeleton.main(args)[source]

Wrapper allowing fib() to be called with string arguments in a CLI fashion

Instead of returning the value from fib(), it prints the result to the stdout in a nicely formatted message.

Parameters:: args (List[str]) – command line parameters as list of strings (for example ["--verbose", "42"]).

prosi3d.skeleton.parse_args(args)[source]

Parse command line parameters

Parameters:: args (List[str]) – command line parameters as list of strings (for example ["--help"]).
Returns:: command line parameters namespace
Return type:: argparse.Namespace

prosi3d.skeleton.run()[source]

Calls main() passing the CLI arguments extracted from sys.argv

This function can be used as entry point to create console scripts with setuptools.

prosi3d.skeleton.setup_logging(loglevel)[source]

Setup basic logging

Parameters:: loglevel (int) – minimum loglevel for emitting messages

prosi3d.streamhandler module

class prosi3d.streamhandler.StreamHandler[source]