Module api
source code
The specific analysis API.
This module is for directly accessing the specific analysis API. The
individual API objects should not be accessed directly, but instead the
functions here should be used.
|
get_string(function_type)
Function for returning a string corresponding to the function type. |
source code
|
|
|
return_api(analysis_type=None,
pipe_name=None)
Return the specific analysis API class instance corresponding to the
function type. |
source code
|
|
|
|
|
ds = The relax data storage obje...
|
|
__package__ = ' specific_analyses '
|
Imports:
Relax_data_store,
RelaxError,
check_pipe
return_api(analysis_type=None,
pipe_name=None)
| source code
|
Return the specific analysis API class instance corresponding to the
function type.
- Parameters:
analysis_type (str or None) - The specific analysis type. This overrides the pipe_name
argument.
pipe_name - The name of the data pipe to obtain the analysis type from. This
is ignored if the analysis_type argument is given. If both
arguments are None, then the current data pipe will be used.
|
return_parameter_object(analysis_type=None,
pipe_name=None)
| source code
|
Return the specific analysis API parameter object corresponding to the
function type.
- Parameters:
analysis_type (str or None) - The specific analysis type. This overrides the pipe_name
argument.
pipe_name - The name of the data pipe to obtain the analysis type from. This
is ignored if the analysis_type argument is given. If both
arguments are None, then the current data pipe will be used.
|
ds
- Value:
The relax data storage object.
Data pipes:
None
Data store objects:
__dict__ <type 'dict'>: dict() -> new empty dictionary
__doc__ <type 'str'>: The relax data storage object.
...
|
|