Module pipes

Module for manipulating data pipes.

Functions

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

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

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

delete(pipe_name=None)
Delete a data pipe.

display()
Print the details of all the data pipes.

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

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

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()
Return the list of all data pipes.

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

Boolean test(pipe_name=None)
Function for testing the existence of the current or supplied 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 of domain motions', 'ct...

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

__package__ = 'generic_fns'

name = 'relax_fit'

Imports: __builtin__, sys, Relax_data_store, C_module_exp_fn, scipy_module, RelaxError, RelaxNoPipeError, RelaxPipeError, Status

Function Details

copy(pipe_from=None, pipe_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.

create(pipe_name=None, pipe_type=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,
• switch (bool) - If True, this new pipe will be switched to, otherwise the current data pipe will remain as is.

cdp_name()

Return the name of the current data pipe.

Returns: str

The name of the current data pipe.

delete(pipe_name=None)

Delete a data pipe.

Parameters:

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

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_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()

Return the list of all data pipes.

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.

test(pipe_name=None)

Function for testing the existence of the current or supplied data pipe.

Parameters:

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

Returns: Boolean

The answer to the question of whether the pipe exists.

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_fit']

PIPE_DESC

Value:

{'N-state': 'N-state model of domain motions',
 '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_fit': 'Relaxation curve fitting'}

PIPE_DESC_LIST

Value:

['Consistency testing',
 'Frame Order theories',
 'Reduced spectral density mapping',
 'Special hybrid pipe',
 'Model-free analysis',
 'N-state model of domain motions',
 'Steady state NOE calculation',
 'Relaxation curve fitting']