Package pipe_control :: Module opendx
[hide private]
[frames] | no frames]

Module opendx

source code

Module containing the base class for the OpenDX space mapping classes.

Classes [hide private]
Map
The space mapping base class.
Functions [hide private]
 
map(params=None, map_type='Iso3D', spin_id=None, inc=20, lower=None, upper=None, axis_incs=10, file_prefix='map', dir='dx', point=None, point_file='point', chi_surface=None, create_par_file=False)
Map the space corresponding to the spin identifier and create the OpenDX files.
source code
Variables [hide private]
  __package__ = 'pipe_control'

Imports: deepcopy, float64, array, zeros, asctime, localtime, RelaxError, open_write_file, write_data, percentile, write_config, write_general, write_point, write_program, value, return_api


Function Details [hide private]

map(params=None, map_type='Iso3D', spin_id=None, inc=20, lower=None, upper=None, axis_incs=10, file_prefix='map', dir='dx', point=None, point_file='point', chi_surface=None, create_par_file=False)

source code 

Map the space corresponding to the spin identifier and create the OpenDX files.

Parameters:
  • params (list of str) - The list of model parameters to map.
  • map_type (str) - The type of map to create. The available options are:
    • 'Iso3D', a 3D isosurface visualisation of the space.
  • spin_id (str) - The spin identification string.
  • inc (int) - The resolution of the plot. This is the number of increments per dimension.
  • lower (None or list of float) - The lower bounds of the space to map. If supplied, this should be a list of floats, its length equal to the number of parameters in the model.
  • upper (None or list of float) - The upper bounds of the space to map. If supplied, this should be a list of floats, its length equal to the number of parameters in the model.
  • axis_incs (int) - The number of tick marks to display in the OpenDX plot in each dimension.
  • file_prefix (str) - The file prefix for all the created files.
  • dir (str or None) - The directory to place the files into.
  • point (None or list of float) - If supplied, a red sphere will be placed at these coordinates.
  • point_file (str or None) - The file prefix for the point output files.
  • create_par_file (bool) - Whether to create a file with parameters and associated chi2 value.