|
Beamline Instrument Software Support |
|
|
|
SPEC Macro documentation:
[ Macro Index |
BCU Home ]
|
|
| MXUTILS.MAC | ||||||
| [ source code | installed at | configured at ] | ||||||
| See other macros in category: MX | ||||||
Description:
| ||||||
|
Documentation:
| ||||||
Macros:
Usage: getMxCollectPars ([inp]) Get the MXCOLLECT_PARS paaremeter(s). With no argument returns the list of all the existing COLLECT parameters. The input argument inp can be a string or an associative array of strings. In both cases the return value is either the value of the inp parameter, or an empty string, if the specified parameter in not set beforehand. E.g. inp = "mypar" to get the MXCOLLECT_PARS[mypar] value; inp[0]="my", inp[1]="par" to get the MXCOLLECT_PARS[my][par] value. setMxCollectPars Usage: setMxCollectPars (inp,val) Set the MXCOLLECT_PARS paaremeter inp to a value val. The input parameter is a string or an associative array of strings. getMxBcmPars Usage: getMxBcmPars ([inp]) Get the MXBCM_PARS paaremeter(s). With no argument returns the list of all the existing BCM parameters. The input argument inp can be a string or an associative array of strings. In both cases the return value is either the value of the inp parameter, or an empty string, if the specified parameter in not set beforehand. E.g. inp = "mypar" to get the MXBCM_PARS[mypar] value; inp[0]="my", inp[1]="par" to get the MXBCM_PARS[my][par] value. setMxBcmPars Usage: setMxBcmPars (inp,val) Set the MXBCM_PARS paaremeter inp to a value val. The input parameter is a string or an associative array of strings. getMxSpecPars Usage: getMxSpecPars ([inp]) Get the MXSPEC_PARS paaremeter(s). With no argument returns the list of all the existing SPEC parameters. The input argument inp can be a string or an associative array of strings. In both cases the return value is either the value of the inp parameter, or an empty string, if the specified parameter in not set beforehand. E.g. inp = "mypar" to get the MXSPEC_PARS[mypar] value; inp[0]="my", inp[1]="par" to get the MXSPEC_PARS[my][par] value. setMxSpecPars Usage: setMxSpecPars (inp,val) Set the MXSPEC_PARS paaremeter inp to a value val. The input parameter is a string or an associative array of strings. getMxWavelength Usage: getMxWavelength () Get the wavelength. Returns the current wavelength (for the MAD beamlines), the default wavelength or LAMBDA, in case a pseudo motor is set. getMxCurrentDistance Usage: getMxCurrentDistance () Get the current detector distance. Returns the current distance getMxCurrentTransmission Usage: getMxCurrentTransmission () Get the current transmission getMxMaximumExposure Usage: getMxMaximumExposure () Get the maximum exposure for a given transmission getMxDetectorBinMode Usage: getMxDetectorBinMode () Get the detector binning mode (if applicable). getMxDetectorFileSuffix Usage: getMxDetectorFileSuffix () Get the detector binning mode (if applicable). beam_centre_update Usage: beam_centre_update () calculate the latest beam centre given the current detector distance pars_init Usage: pars_init () Initialise the MXCOLLECT_PARS, MXBCM_PARS and MXSPEC_PARS with the default values (generic and beamline specific). | ||||||
| Internal Macros: | ||||||
Usage: getMxEnergy() getMxResolution Usage: getMxResolution (diameter) Get the detector resolution. getMxResolutionAtCorner Usage: getMxResolutionAtCorner () Get the detectoer resolution in the corners. getMxResolutionAtHalfCorner Usage: getMxResolutionAtHalfCorner () Get the detectoer resolution at half radius. getMxBeamShape Usage: getMxBeamShape(flag) _getRadius Usage: _getRadius () Get the detector radius. getMxDiameter Usage: getMxDiameter () Get the detector diameter. getMxCurrentFilename Usage: getMxCurrentFilename () Get current filename (set by the detector macros). setMxCurrentFilename Usage: setMxCurrentFilename () Set current filename. CalculateResolutionFromDistance Usage: CalculateResolutionFromDistance (dist) Calculate the resolution as function of the dist from the sample. CalculateDistanceFromResolution Usage: CalculateDistanceFromResolution (resol) Calculate the distance from the sample as function of the resol. getMxBeamCentreX Usage: getMxBeamCentreX () Get current Beam centre for X. getMxBeamCentreY Usage: getMxBeamCentreY () Get current Beam Centre Y. getMxUndulatorGap Usage: getMxUndulatorGap(which) getMxUndulatorType Usage: getMxUndulatorType(which) getMxKappaValue Usage: getMxKappaValue() getMxPhiValue Usage: getMxPhiValue() getMxKappaPhiValue Usage: getMxKappaPhiValue() getMxOscillationAxisName Usage: getMxOscillationAxisName() getMxSlitGapHorizontal Usage: getMxSlitGapHorizontal() getMxSlitGapVertical Usage: getMxSlitGapVertical() getMxBeamSizeX Usage: getMxBeamSizeX(dont_get_beamsize) getMxBeamInfo Usage: getMxBeamInfo() getMxBeamSizeY Usage: getMxBeamSizeY(dont_get_beamsize) getMxTotalParams Usage: getMxTotalParams() local_pars_init Usage: local_pars_init() _mxlocal_read_pars Usage: _mxlocal_read_pars(name, path) local_pars_commit Usage: local_pars_commit() check_beam Usage: check_beam() | ||||||
|