Module pipes

Module for manipulating data pipes.

Functions

bundle(bundle=None, pipe=None)
Add the data pipe to the given bundle, created the bundle as needed.

list of str bundle_names()
Return the list of all data pipe bundles.

str cdp_name()
Return the name of the current data pipe.

change_type(pipe_type=None)
Change the type of the current data pipe.

None or RelaxError instance check_pipe_func(pipe_name=None)
Test for the existence of the current or supplied data pipe.

check_type(pipe_type)
Check the validity of the given data pipe type.

copy(pipe_from=None, pipe_to=None, bundle_to=None)
Copy the contents of the source data pipe to a new target data pipe.

create(pipe_name=None, pipe_type=None, bundle=None, switch=True)
Create a new data pipe.

current()
Print the name of the current data pipe.

delete(pipe_name=None)
Delete a data pipe.

display(sort=False, rev=False)
Print the details of all the data pipes.

str or None get_bundle(pipe=None)
Return the name of the bundle that the given pipe belongs to.

PipeContainer instance get_pipe(name=None)
Return a data pipe.

str get_type(name=None)
Return the type of the data pipe.

bool has_bundle(bundle=None)
Determine if the relax data store contains the data pipe bundle.

bool has_pipe(name)
Determine if the relax data store contains the data pipe.

PipeContainer instance or tuple of PipeContainer instance and str if name=True pipe_loop(name=False)
Generator function for looping over and yielding the data pipes.

list of str pipe_names(bundle=None)
Return the list of all data pipes.

switch(pipe_name=None)
Switch the current data pipe to the given data pipe.

Variables

ds = The relax data storage obje...

status = Status()

VALID_TYPES = ['ct', 'frame order', 'jw', 'hybrid', 'mf', 'N-s...

PIPE_DESC = {'N-state': 'N-state model or ensemble analysis', ...

PIPE_DESC_LIST = ['Consistency testing', 'Frame Order theories...

check_pipe = <lib.checks.Check instance at 0x7fd8f8b3dfa0>

__package__ = 'pipe_control'

name = 'relax_fit'

Imports: sys, Relax_data_store, C_module_exp_fn, scipy_module, Check, builtins, RelaxError, RelaxNoPipeError, RelaxPipeError, sort_filenames, write_data, pipe_control, Status

Function Details

bundle(bundle=None, pipe=None)

Add the data pipe to the given bundle, created the bundle as needed.

Parameters:

• bundle (str) - The name of the data pipe bundle.
• pipe (str) - The name of the data pipe to add to the bundle.

bundle_names()

Return the list of all data pipe bundles.

Returns: list of str

The list of data pipe bundles.

cdp_name()

Return the name of the current data pipe.

Returns: str

The name of the current data pipe.

change_type(pipe_type=None)

Change the type of the current data pipe.

Parameters:

• pipe_type (str) - The new data pipe type which can be one of the following: 'ct': Consistency testing, 'frame order': The Frame Order theories. 'jw': Reduced spectral density mapping, 'hybrid': The hybridised data pipe. 'mf': Model-free analysis, 'N-state': N-state model of domain dynamics, 'noe': Steady state NOE calculation, 'relax_fit': Relaxation curve fitting, 'relax_disp': Relaxation dispersion,

check_pipe_func(pipe_name=None)

Test for the existence of the current or supplied data pipe.

Parameters:

• pipe_name (str) - The name of the data pipe to switch to.

Returns: None or RelaxError instance

The initialised RelaxError object or nothing.

check_type(pipe_type)

Check the validity of the given data pipe type.

Parameters:

• pipe_type (str) - The data pipe type to check.

Raises:

• RelaxError - If the data pipe type is invalid or the required Python modules are missing.

copy(pipe_from=None, pipe_to=None, bundle_to=None)

Copy the contents of the source data pipe to a new target data pipe.

If the 'pipe_from' argument is None then the current data pipe is assumed as the source. The data pipe corresponding to 'pipe_to' cannot exist.

Parameters:

• pipe_from (str) - The name of the source data pipe to copy the data from.
• pipe_to (str) - The name of the target data pipe to copy the data to.
• bundle_to (str or None) - The optional data pipe bundle to associate the new data pipe with.

create(pipe_name=None, pipe_type=None, bundle=None, switch=True)

Create a new data pipe.

The current data pipe will be changed to this new data pipe.

Parameters:

• pipe_name (str) - The name of the new data pipe.
• pipe_type (str) - The new data pipe type which can be one of the following: 'ct': Consistency testing, 'frame order': The Frame Order theories. 'jw': Reduced spectral density mapping, 'hybrid': The hybridised data pipe. 'mf': Model-free analysis, 'N-state': N-state model of domain dynamics, 'noe': Steady state NOE calculation, 'relax_fit': Relaxation curve fitting, 'relax_disp': Relaxation dispersion,
• bundle (str or None) - The optional data pipe bundle to associate the data pipe with.
• switch (bool) - If True, this new pipe will be switched to, otherwise the current data pipe will remain as is.

delete(pipe_name=None)

Delete a data pipe.

Parameters:

• pipe_name (str) - The name of the data pipe to delete.

get_bundle(pipe=None)

Return the name of the bundle that the given pipe belongs to.

Parameters:

• pipe (str or None) - The name of the data pipe to find the bundle of, defaulting to the current pipe.

Returns: str or None

The name of the bundle that the pipe is located in.

get_pipe(name=None)

Return a data pipe.

Parameters:

• name (str or None) - The name of the data pipe to return. If None, the current data pipe is returned.

Returns: PipeContainer instance

The current data pipe.

get_type(name=None)

Return the type of the data pipe.

Parameters:

• name (str or None) - The name of the data pipe. If None, the current data pipe is used.

Returns: str

The current data pipe type.

has_bundle(bundle=None)

Determine if the relax data store contains the data pipe bundle.

Parameters:

• bundle (str) - The name of the data pipe bundle.

Returns: bool

The answer to the question.

has_pipe(name)

Determine if the relax data store contains the data pipe.

Parameters:

• name (str) - The name of the data pipe.

Returns: bool

True if the data pipe exists, False otherwise.

pipe_loop(name=False)

Generator function for looping over and yielding the data pipes.

Parameters:

• name (bool) - A flag which if True will cause the name of the pipe to be returned.

Returns: PipeContainer instance or tuple of PipeContainer instance and str if name=True

The data pipes, and optionally the pipe names.

pipe_names(bundle=None)

Return the list of all data pipes.

Parameters:

• bundle (str or None) - If supplied, the pipe names will be restricted to those of the bundle.

Returns: list of str

The list of data pipes.

switch(pipe_name=None)

Switch the current data pipe to the given data pipe.

Parameters:

• pipe_name (str) - The name of the data pipe to switch to.

Variables Details

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.
...

VALID_TYPES

Value:

['ct',
 'frame order',
 'jw',
 'hybrid',
 'mf',
 'N-state',
 'noe',
 'relax_disp',
...

PIPE_DESC

Value:

{'N-state': 'N-state model or ensemble analysis',
 'ct': 'Consistency testing',
 'frame order': 'Frame Order theories',
 'hybrid': 'Special hybrid pipe',
 'jw': 'Reduced spectral density mapping',
 'mf': 'Model-free analysis',
 'noe': 'Steady state NOE calculation',
 'relax_disp': 'Relaxation dispersion',
...

PIPE_DESC_LIST

Value:

['Consistency testing',
 'Frame Order theories',
 'Reduced spectral density mapping',
 'Special hybrid pipe',
 'Model-free analysis',
 'N-state model or ensemble analysis',
 'Steady state NOE calculation',
 'Relaxation dispersion',
...