Module files

Module for generating OpenDX files.

Functions

write_config(file_prefix=None, dir=None, date=None)
Creating the OpenDX .cfg program configuration file.

write_general(file_prefix=None, dir=None, inc=None)
Create the OpenDX .general file for a 3D map.

write_point(file_prefix=None, dir=None, inc=None, point=None, bounds=None, N=None)
Creating a sphere at a given position within the map.

write_program(file_prefix=None, point_file=None, dir=None, inc=None, N=None, num_points=None, labels=None, tick_locations=None, tick_values=None, date=None)
Create the OpenDX .net program file.

Variables

__package__ = 'lib.software.opendx'

Imports: open_write_file

Function Details

write_config(file_prefix=None, dir=None, date=None)

Creating the OpenDX .cfg program configuration file.

Parameters:

• file_prefix (str) - The base part of the file name without extension.
• dir (str or None) - The directory to place the file in.
• date (str) - The date string to include in the configuration.

write_general(file_prefix=None, dir=None, inc=None)

Create the OpenDX .general file for a 3D map.

Parameters:

• file_prefix (str) - The base part of the file name without extension.
• dir (str or None) - The directory to place the file in.
• inc (int) - The number of increments in the 3D map.

write_point(file_prefix=None, dir=None, inc=None, point=None, bounds=None, N=None)

Creating a sphere at a given position within the map.

The formula used to calculate the coordinate position is:

                   V - L
   coord =   Inc * -----
                   U - L

where:

• V is the coordinate or parameter value.
• L is the lower bound value.
• U is the upper bound value.
• Inc is the number of increments.

Both a data file and .general file will be created.

Parameters:

• file_prefix (str) - The base part of the file name without extension.
• dir (str or None) - The directory to place the file in.
• inc (int) - The number of increments in the map.
• point (numpy rank-1 float array) - The coordinates of the point.
• bounds (numpy rank-2 float array) - The bounds of the map.
• N (int) - The dimension of the map.

write_program(file_prefix=None, point_file=None, dir=None, inc=None, N=None, num_points=None, labels=None, tick_locations=None, tick_values=None, date=None)

Create the OpenDX .net program file.

Parameters:

• file_prefix (str) - The base part of the file name without extension.
• point_file (str or None) - The name of the point file to be displayed by the program.
• dir (str or None) - The directory to place the file in.
• inc (int) - The number of increments in the map.
• N (int) - The dimension of the map.
• num_points (int) - The number of points to be displayed by the program.
• labels (str) - The strings associated with the map axes, as an OpenDX string.
• tick_locations (str) - The locations of the tick marks, as an OpenDX string.
• tick_values (str) - The values of the tick marks, as an OpenDX string.
• date (str) - The date string to include in the configuration.