McXtrace - An X-ray ray-trace simulation package

[ Identification | Description | Input parameters | Links ]

The Progress_bar Component

A simulation progress bar

Identification

• Site:
• Author: Emmanuel Farhi
• Origin: ILL
• Date: 2009

Description

An indicator of the progress of the simulation, monitoring
the Init, Trace with the achieved percentage, and the Finally section.
Intermediate savings (e.g. triggered by USR2 signal) are also shown.
This component should be positioned at the very begining of the instrument
The profile option will save the intensity and number of events for each
component It may be used to evaluate the simulation efficiency.

Example: Progress_bar(percent=10,flag_save=1) AT (0,0,0)

Input parameters

Parameters in boldface are required; the others are optional.

Name	Unit	Description	Default
profile		(str) file name to save the simulation profile	0
percent		(0-100) percentage interval between updates. Default is 10%.	10
flag_save		(0|1) flag to enable intermediate saving for all monitors	0
minutes		(min) time in minutes between updates (Overrides percent flag).	0

AT (	,	,		) RELATIVE		Generate
ROTATED (	,	,		) RELATIVE

Links

• Source code for Progress_bar.comp.

---

[ Identification | Description | Input parameters | Links ]

Generated on 2023-12-19 19:37:45

---

Last Modified: Thursday, 16-May-2024 15:56:15 CEST