Package specific_analyses :: Package frame_order :: Module parameter_object

[frames] | no frames]

Module parameter_object

source code

The module for the frame order parameter list object.

Classes

[hide private]

Frame_order_params
The frame order parameter list singleton.

Functions

[hide private]

float

angle_upper_excluding_bound(incs=None, model_info=None)
Determine the upper grid bound for the angular parameters, excluding the bound value.

source code

float

axis_alpha_upper(incs=None, model_info=None)
Determine the upper grid bound for the axis alpha angle.

source code

float

cone_angle_lower(incs=None, model_info=None)
Determine the lower grid bound for the cone and torsion angles.

source code

float

cone_angle_upper(incs=None, model_info=None)
Determine the upper grid bound for the cone and torsion angles.

source code

float

pivot_grid_bound(param=None, extent=25.0)
Determine the grid bounds for the pivot coordinates.

source code

float

pivot_x_lower(incs=None, model_info=None, size=25.0)
Determine the lower grid bound for the pivot X coordinate.

source code

float

pivot_x_upper(incs=None, model_info=None, size=25.0)
Determine the upper grid bound for the pivot X coordinate.

source code

float

pivot_y_lower(incs=None, model_info=None, size=25.0)
Determine the lower grid bound for the pivot Y coordinate.

source code

float

pivot_y_upper(incs=None, model_info=None, size=25.0)
Determine the upper grid bound for the pivot Y coordinate.

source code

float

pivot_z_lower(incs=None, model_info=None, size=25.0)
Determine the lower grid bound for the pivot Z coordinate.

source code

float

pivot_z_upper(incs=None, model_info=None, size=25.0)
Determine the upper grid bound for the pivot Z coordinate.

source code

Variables

[hide private]

__package__ = 'specific_analyses.frame_order'

Imports: pi, RelaxError, Param_list

Function Details

[hide private]

angle_upper_excluding_bound(incs=None, model_info=None)

source code

Determine the upper grid bound for the angular parameters, excluding the bound value.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.

Returns: float

The upper grid search bound for the angular parameters, excluding the bound value.

axis_alpha_upper(incs=None, model_info=None)

source code

Determine the upper grid bound for the axis alpha angle.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.

Returns: float

The upper grid search bound for the axis alpha angle.

cone_angle_lower(incs=None, model_info=None)

source code

Determine the lower grid bound for the cone and torsion angles.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.

Returns: float

The lower grid search bound for the cone and torsion angles.

cone_angle_upper(incs=None, model_info=None)

source code

Determine the upper grid bound for the cone and torsion angles.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.

Returns: float

The upper grid search bound for the cone and torsion angles.

pivot_grid_bound(param=None, extent=25.0)

source code

Determine the grid bounds for the pivot coordinates.

Parameters:

param (str) - The parameter to find the bound for. This should be one of 'pivot_x', 'pivot_y', or 'pivot_z'.
extent (float) - The length in Angstrom to extend out from the current coordinate to reach the grid bound.

Returns: float

The grid search bound for the given coordinate.

pivot_x_lower(incs=None, model_info=None, size=25.0)

source code

Determine the lower grid bound for the pivot X coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The lower grid search bound for the coordinate.

pivot_x_upper(incs=None, model_info=None, size=25.0)

source code

Determine the upper grid bound for the pivot X coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The upper grid search bound for the coordinate.

pivot_y_lower(incs=None, model_info=None, size=25.0)

source code

Determine the lower grid bound for the pivot Y coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The lower grid search bound for the coordinate.

pivot_y_upper(incs=None, model_info=None, size=25.0)

source code

Determine the upper grid bound for the pivot Y coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The upper grid search bound for the coordinate.

pivot_z_lower(incs=None, model_info=None, size=25.0)

source code

Determine the lower grid bound for the pivot Z coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The lower grid search bound for the coordinate.

pivot_z_upper(incs=None, model_info=None, size=25.0)

source code

Determine the upper grid bound for the pivot Z coordinate.

Parameters:

incs (int) - The number of grid search increments.
model_info (None) - The model information from model_loop(). This is unused.
size (float) - The half grid size in Angstrom.

Returns: float

The upper grid search bound for the coordinate.