Commit c258a042 authored by Henri Payno's avatar Henri Payno
Browse files

[doc] remove sphinx documentation warning

parent 43adef4c
......@@ -138,9 +138,10 @@ class XASWriter(object):
"""
write the XASObject into a hdf5 file.
:param :class:`.XASObject` xas_obj: object to be stored
:param xas_obj: object to be stored
:type: Union[:class:`.XASObject`,dict]
:param bool write_process: if True then store the process flow in the
same file.
same file.
"""
if isinstance(xas_obj, dict):
_xas_obj = XASObject.from_dict(xas_obj)
......
......@@ -41,14 +41,18 @@ def process_spectr_autobk(spectrum, configuration, overwrite=True,
callback=None, output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -41,14 +41,18 @@ def process_spectr_mback(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -41,14 +41,18 @@ def process_spectr_mback_norm(spectrum, configuration, overwrite=True,
callback=None, output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -41,14 +41,18 @@ def process_spectr_pre_edge(spectrum, configuration, overwrite=True, callback=No
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is: input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -41,14 +41,18 @@ def process_spectr_xftf(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -103,9 +103,9 @@ class Process(object):
"""
Store the current process in the linked h5 file if any,
output data stored will be the one defined by the data_keys
:param :class:`.XASObject` xas_obj: object for which we want to save the
treatment
:param xas_obj: object for which we want to save the treatment
:type: :class:`.XASObject`
:param tuple data_keys: keys of the id to save
:param str relative_to: x value
"""
......
......@@ -45,14 +45,18 @@ def process_spectr_exafs(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -44,14 +44,18 @@ def process_spectr_ft(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -44,14 +44,18 @@ def process_spectr_k(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -44,14 +44,18 @@ def process_spectr_norm(spectrum, configuration, overwrite=True, callback=None,
output=None, output_dict=None):
"""
:param :class:`.Spectrum` spectrum: spectrum to process
:param dict configuration: configuration of the pymca normalization
:param bool overwrite: False if we want to return a new Spectrum instance
:param function pointer callback: callback to execute.
:param spectrum: spectrum to process
:type: :class:`.Spectrum`
:param configuration: configuration of the pymca normalization
:type: dict
:param overwrite: False if we want to return a new Spectrum instance
:type: bool
:param callback: callback to execute.
:param output: list to store the result, needed for pool processing
:type: multiprocessing.manager.list
:param dict output_dict: key: input spectrum, value: index in the output
list.
:param output_dict: key is input spectrum, value is index in the output
list.
:type: dict
:return: processed spectrum
:rtype: tuple (configuration, spectrum)
"""
......
......@@ -429,12 +429,13 @@ class XASObject(object):
"""
Register one process for the current xas object. This require to having
link a h5file to this object
:param :class:`.Process` process:
:param process: process to be registred
:type: :class:`.Process`
:param data: result of the processing. If there is more than one
result then a dictionary with the key under which result
should be saved and a numpy.ndarray
:type: Union[numpy.ndarray, dict]
result then a dictionary with the key under which result
should be saved and a numpy.ndarray
:type: Union[numpy.ndarray,dict]
"""
xas.io.write_xas_proc(self.linked_h5_file, entry=self.__entry_name,
processing_order=self.get_next_processing_index(),
......
......@@ -138,10 +138,14 @@ def write_xas_proc(h5_file, entry, process, data, processing_order,
:param str h5_file: path to the hdf5 file
:param str entry: entry name
:param :class:`.Process` process: process executed
:param numpy.ndarray data: process result data
:param int processing_order: processing order of treatment
:param str data_path: path to store the data
:param process: process executed
:type: :class:`.Process`
:param data: process result data
:type: numpy.ndarray
:param processing_order: processing order of treatment
:type: int
:param data_path: path to store the data
:type: str
"""
process_name = 'xas_process_' + str(processing_order)
# write the xasproc
......@@ -202,13 +206,14 @@ def write_xas(h5_file, entry, energy, mu, sample=None, start_time=None,
:param str h5_file: path to the hdf5 file
:param str entry: entry name
:param :class:`.Sample` sample: definition of the sample
:param energy: beam energy
:type: numpy.ndarray, one dim
:param mu: beam absorption
:type: numpy.ndarray, two dimensions
:param sample: definition of the sample
:type: :class:`.Sample`
:param energy: beam energy (1D)
:type: numpy.ndarray
:param mu: beam absorption (2D)
:type: numpy.ndarray
:param start_time:
:param data_path:
:param str data_path:
:param str title: experiment title
:param str definition: experiment definition
"""
......
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