McXtrace logo

McXtrace - An X-ray ray-trace simulation package

ESRF; SAXSLAB Niels Bohr Institute DTU Physics

McXtrace

Project Status
 Project Partners
 Project People
 Goal

Installation
 Mac OSX Installation
 Windows Installation

Mailing List

Links

Publications

Minutes of Meetings

McXtrace Art

About McXtrace

Documentation
 Commands
 Tutorial

Download
 Components

Search


McXtrace: Progress_bar Component

[ Identification | Description | Input parameters | Output parameters | Links ]

The Progress_bar Component

A simulation progress bar

Identification

  • Author: Emmanuel Farhi
  • Origin: ILL
  • Date: 2009
  • Version: 1.0
  • Modification history:
    • Erik Knudsen

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 if set to "", it is set to the name of the instrument. 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

Output parameters

Name Unit Description Default
IntermediateCnts  
StartTime  
EndTime  

Links


[ Identification | Description | Input parameters | Output parameters | Links ]

Generated automatically by McDoc, Peter Willendrup <peter.willendrup@risoe.dk> / Tue Aug 16 12:59:11 2016


Last Modified: Tuesday, 16-Aug-2016 14:59:11 CEST
Search website mailinglist archive SVN repos McCode Trac