Module checks

Module for checks for the frame order analysis.

Functions

None or RelaxError instance check_domain_func(domain=None)
Check if the domain has been defined.

None or RelaxError instance check_model_func(pipe_name=None)
Check if the frame order model has been set up.

None or RelaxError instance check_parameters_func()
Check if the frame order parameters exist.

None or RelaxError instance check_pivot_func(pipe_name=None)
Check that the pivot point has been set.

Variables

check_domain = <lib.checks.Check instance at 0x7fd8f79ad050>

check_model = <lib.checks.Check instance at 0x7fd8f79ad0a0>

check_parameters = <lib.checks.Check instance at 0x7fd8f79ad0f0>

check_pivot = <lib.checks.Check instance at 0x7fd8f79ad140>

__package__ = 'specific_analyses.frame_order'

Imports: Check, RelaxError, cdp_name, get_pipe

Function Details

check_domain_func(domain=None)

Check if the domain has been defined.

Parameters:

• domain (None or str) - The domain to check for. If None, then the check will be for any domain being defined.

Returns: None or RelaxError instance

The initialised RelaxError object if the domain is not defined, or nothing.

check_model_func(pipe_name=None)

Check if the frame order model has been set up.

Parameters:

• pipe_name (None or str) - The data pipe to check for, if not the current pipe.

Returns: None or RelaxError instance

The initialised RelaxError object if the model is not set up, or nothing.

check_parameters_func()

Check if the frame order parameters exist.

Returns: None or RelaxError instance

The initialised RelaxError object if the model parameters have not been setup, or nothing.

check_pivot_func(pipe_name=None)

Check that the pivot point has been set.

Parameters:

• pipe_name (str) - The data pipe to check the pivot for. This defaults to the current data pipe if not set.

Returns: None or RelaxError instance

The initialised RelaxError object if the pivot point has not been set, or nothing.