Commit a5ec0ca0 authored by Pierre Paleo's avatar Pierre Paleo
Browse files

Add doc

parent a3d8fc29
Pipeline #19693 passed with stage
in 1 minute and 15 seconds
......@@ -18,7 +18,7 @@ The typical usage of a `Processing`-like class is
- Then, Call the main class method
Example:
**Example usage**:
```python
# Build a Processing object - it might take some time
......@@ -26,7 +26,11 @@ F = FlatField(radios, flats, darks)
# Then, perform the processing
F.normalize_radios() # parameters depend on the class implementation, ex. CudaFlatfield
```
**Examples of "Processing"**:
- [CCDProcessing](apidoc/nabu.preproc.ccd.rst#nabu.preproc.ccd.CCDProcessing)
- [PaganinPhaseRetrieval](apidoc/nabu.preproc.phase.rst#nabu.preproc.phase.PaganinPhaseRetrieval)
- [Reconstructor](apidoc/nabu.reconstruction.reconstructor.rst#nabu.reconstruction.reconstructor.Reconstructor)
Component
----------
......
......@@ -36,3 +36,6 @@ def PhaseRetrieval(Component):
self.phase_retrieval.apply_filter(radio, output=XXX) # depends CPU/GPU
print("Phase retrieval on chunk %d: end" % self.current_chunk) # info
def execute(self):
pass
Supports Markdown
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