hexrd.preprocess.profiles module

class hexrd.preprocess.profiles.Chess_Arguments(num_frames: int = 1440, start_frame: int = 0, threshold: int = 5, ome_start: float = 0.0, ome_end: float = 360.0, style: str = 'npz', output: str = 'test')

Bases: HexrdPPScript_Arguments

help_messages = {'base_dir': 'raw data path on chess daq', 'expt_name': 'experiment name', 'num_frames': 'number of frames to read', 'ome_end': 'end omega', 'ome_start': 'start omega', 'output': 'output filename', 'samp_name': 'sample name', 'scan_number': 'ff scan number', 'start_frame': 'index of first data frame', 'style': 'format for saving framecache', 'threshold': 'threshold for frame caches'}

num_frames: int = 1440

ome_end: float = 360.0

ome_start: float = 0.0

property ostep: float

output: str = 'test'

short_switches = {'num_frames': 'n', 'ome_end': 'e', 'ome_start': 'o', 'start_frame': 's', 'threshold': 't'}

start_frame: int = 0

style: str = 'npz'

threshold: int = 5

validate_arguments() → None

class hexrd.preprocess.profiles.Dexelas_Arguments(num_frames: int = 1441, start_frame: int = 4, threshold: int = 50, ome_start: float = 0.0, ome_end: float = 360.0, style: str = 'npz', output: str = 'test', base_dir: Optional[str] = None, expt_name: Optional[str] = None, samp_name: Optional[str] = None, scan_number: Optional[int] = None, panel_opts: dict[str, list[list[typing.Union[str, int]]]] = <factory>)

Bases: Chess_Arguments

base_dir: str | None = None

expt_name: str | None = None

property file_names: list[str]

help_messages = {'base_dir': 'raw data path on chess daq', 'expt_name': 'experiment name', 'num_frames': 'number of frames to read', 'ome_end': 'end omega', 'ome_start': 'start omega', 'output': 'output filename', 'panel_opts': 'detector-specific options', 'samp_name': 'sample name', 'scan_number': 'ff scan number', 'start_frame': 'index of first data frame', 'style': 'format for saving framecache', 'threshold': 'threshold for frame caches'}

num_frames: int = 1441

panel_opts: dict[str, list[list[Union[str, int]]]]

profile_name = 'dexelas'

samp_name: str | None = None

scan_number: int | None = None

start_frame: int = 4

threshold: int = 50

validate_arguments() → None

yaml_tag = '!Dexelas_Arguments'

class hexrd.preprocess.profiles.Eiger_Arguments(num_frames: int = 1440, start_frame: int = 0, threshold: int = 5, ome_start: float = 0.0, ome_end: float = 360.0, style: str = 'npz', output: str = 'test', absolute_path: str | None = None)

Bases: Chess_Arguments

absolute_path: str | None = None

property file_name: str

help_messages = {'absolute_path': 'absolute path to image file', 'base_dir': 'raw data path on chess daq', 'expt_name': 'experiment name', 'num_frames': 'number of frames to read', 'ome_end': 'end omega', 'ome_start': 'start omega', 'output': 'output filename', 'samp_name': 'sample name', 'scan_number': 'ff scan number', 'start_frame': 'index of first data frame', 'style': 'format for saving framecache', 'threshold': 'threshold for frame caches'}

profile_name = 'eiger'

short_switches = {'num_frames': 'n', 'ome_end': 'e', 'ome_start': 'o', 'start_frame': 's', 'threshold': 't'}

validate_arguments() → None

yaml_tag = '!Eiger_Arguments'

class hexrd.preprocess.profiles.HexrdPPScript_Arguments

Bases: YAMLObject

classmethod create_args(name: str, **kwargs: Any) → HexrdPPScript_Arguments

Create argument class of type name using kwargs to set the dataclass values

classmethod create_default_config(name: str) → str

Create argument class of type name using kwargs to set the dataclass values

dump_config() → str

Create a yaml string representation of the values hold in this dataclass

classmethod known_formats() → list[str]

Get all know argument formats registered so far

classmethod load_from_config(buffer: str) → HexrdPPScript_Arguments

Create an HexrdPPScript_Arguments instance from yaml string

profile_name = 'none'

validate_arguments() → None

yaml_loader

alias of SafeLoader

yaml_tag = '!HexrdPPScript_Arguments'