... | ... | @@ -4,24 +4,6 @@ Multiscale is a project born from our AFM group to handle multiple file format a |
|
|
|
|
|
As so, all the processing can be done on the well defined hdf5 format, allowing for intercompatibility of the data analysis.
|
|
|
|
|
|
# How to use
|
|
|
## Convert file
|
|
|
To convert a file, simply use the function tohdf5('path_to_file') from the proc_tools file, it will create a .hdf5 file containing the data of the input-file.
|
|
|
|
|
|
```python
|
|
|
import multiscale as ms
|
|
|
ms.tohdf5(file_example.ibw)
|
|
|
```
|
|
|
|
|
|
## Apply function
|
|
|
Most of the common use will be done by using the [m_apply](/Functions/Core/m_apply) function. a more detailled explanation can be found on the page of the function. But the working principle is the following:
|
|
|
|
|
|
m_apply(filename, function, inputs=[], outputs_names=None, **kwargs)
|
|
|
|
|
|
Where filename is the name of the hdf5, function is the name of the called function, inputs is the path in the hdf5 to the input datas. The name of the output channels can be automatically generated, or given as a parameters.
|
|
|
|
|
|
Any extra parameters of the function are given using the **kwargs.
|
|
|
|
|
|
# Tutorials
|
|
|
|
|
|
A few tutorial were written by R.Bulanadi and can be found in the examples folder of the project, or in the links below:
|
... | ... | |