hexrd.config.root module

class hexrd.config.root.RootConfig(cfg)

Bases: Config

property analysis_dir

Analysis directory, where output files go

The name is derived from working_dir and analysis_name. This property returns a Path object. The directory and any intermediate directories can be created with the mkdir() method, e.g.

>>> analysis_dir.mkdir(parents=True, exist_ok=True)

property analysis_id

property analysis_name

Name of the analysis

This will be used to set up the output directory. The name can contain slash (“/”) characters, which will generate a subdirectory structure in the analysis_dir.

property find_orientations

property fit_grains

property image_series

Return the imageseries dictionary.

property instrument

property material

property multiprocessing

property new_file_placement

Use new file placements for find-orientations and fit-grains

The new file placement rules put several files in the analysis_dir instead of the working_dir.

property working_dir

Working directory, either specified in file or current directory

If the directory is not specified in the config file, then it will default to the current working directory. If it is specified, the directory must exist, or it will throw an IOError.