The LAMP Application

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

lamp_mac/LSS/

superadam_reflectivity.pro


:Description: Computes the indexes from a ranges string. A ranges string is a string with the following format 'a:b,c:d,e:f' Parsing such a string will produce indexes resulting from the concatenation of [a,b], [c,d], [e,f] intervals. Example: parsing '1:5,7:10' will yield [1,2,3,4,5,7,8,9,10] :Params: str : in, required, type=string The input ranges string. indexes : out, required, type=indexes array The output indexes. :Keywords: mini : in, optional, type=integer If provided, only those indexes strictly upper to 'mini' will be kept. maxi : in, optional, type=integer If provided, only those indexes strictly lower to 'maxi' will be kept. value : in, optional, type=numeric If provided, will translate the output indexes by 'value' :Author: pellegrini :Categories: strings

Routines

process_ranges_string, str, indexes, mini=mini, maxi=maxi, value=value
reformat_superadam_data, data

thetas_to_q, thetas, wavelength, q, radians=radians, two_thetas=two_thetas

efficiency_correction, data, data_error, efficiency_file, x_range=x_range, y_range=y_range

monitor_correction, data, data_error, monitor

integrate_superadam_data, data, data_error, integrated_data, integrated_data_error, x_range=x_range, y_range=y_range, peaks=peaks, background=background

superadam_reflectivity, reflect, q_values, reflectivity, reflectivity_error, integ_range_x=integ_range_x, integ_range_y=integ_range_y, direct=direct, efficiency=efficiency, eff_range_x=eff_range_x, eff_range_y=eff_range_y, background_range=background_range, peaksearch_range=peaksearch_range, wavelength=wavelength

Routine details

top process_ranges_string

process_ranges_string, str, indexes, mini=mini, maxi=maxi, value=value

Parameters

str
indexes

Keywords

mini
maxi
value

top reformat_superadam_data

reformat_superadam_data, data

:Description: Reformat the superADAM so that it always has 3 dimensions. :Params: data : inout, required, type=array The input suerADAM data. :Author: pellegrini

Parameters

data

top thetas_to_q

thetas_to_q, thetas, wavelength, q, radians=radians, two_thetas=two_thetas

:Description: Generates the q values given an array of angles. :Params: angles : in, required, type=array The input angles. wavelength : in, required, type=float The wavelength. q : out, required, type=vector The q values. :Keywords: /two_thetas : in, optional If set, specify that the input angles are two thetas. /radians : in, optional If set, the input angles are in radians otherwise in degrees. :Author: pellegrini :Categories: reflectivity

Parameters

thetas
wavelength
q

Keywords

radians
two_thetas

top efficiency_correction

efficiency_correction, data, data_error, efficiency_file, x_range=x_range, y_range=y_range

:Description: Correct some input datas from detector efficiency. :Params: data : inout, required, type=float array The data to correct from efficiency efficiency : in, required, type=numor string The numor from which the efficiency matrix will be computed. :Keywords: efficiency_range_x : in, optional, type=string If provided, the ranges string that define the x region for the efficiency factor computation. efficiency_range_y If provided, the ranges string that define the y region for the efficiency factor computation. :Author: pellegrini,gonzalez

Parameters

data
data_error
efficiency_file

Keywords

x_range
y_range

top monitor_correction

monitor_correction, data, data_error, monitor

:Description: Normalize data from monitor. :Params: data : inout, required, type=float array The data to be normalized from monitor data_error : inout, required, type=float array The error for the normalized data. monitor : in, required, type=float vector The monitor value for each q values. :Author: pellegrini,gonzalez

Parameters

data
data_error
monitor

top integrate_superadam_data

integrate_superadam_data, data, data_error, integrated_data, integrated_data_error, x_range=x_range, y_range=y_range, peaks=peaks, background=background

:Description: Integrate the data for each q value around the corresponding peak. :Params: data : in, required, type=array The input data. error : in, required, type=array. The error corresponding to the input data. peaks : in, required, type=vector The indexes of the peaks found for each q values. integrated_peak : out, required, type=vector The integrated peak. :Author: pellegrini,gonzalez

Parameters

data
data_error
integrated_data
integrated_data_error

Keywords

x_range
y_range
peaks
background

top superadam_reflectivity

superadam_reflectivity, reflect, q_values, reflectivity, reflectivity_error, integ_range_x=integ_range_x, integ_range_y=integ_range_y, direct=direct, efficiency=efficiency, eff_range_x=eff_range_x, eff_range_y=eff_range_y, background_range=background_range, peaksearch_range=peaksearch_range, wavelength=wavelength

:Description: Computes the reflectivity for superADAM instrument. :Params: reflect : in, required, type=string The reflected beam numors. integ_range_x : in, required, type=string The integration range that will surround the detected peaks. Must be of the form 'a:b' where a<0 and b>0 so that for each q frame, the integration will be performed on the range [p+a,p+b] where p is the index of the reflected peak. wavelength : in, required, type=float The wavelength. q_values : out, required, type=vector The q values for which the reflectivity is computed. reflectivity : out, required, type=vector The reflectivity defined for all the q values. :Keywords: direct : in, optional, type=string The direct beam numors. efficiency : in, required, type=string The incoherent scatterer numors. eff_range_x : in, optional, type=string The X range used for defining the range over which the efficiency will be computed. Must be of the form 'a:b', where a and b specified the minimum and maximum indexes to consider. For example, 10:40 will correspond indexes 10,11,12...40. If not set, 'eff_range_y' will be used. If not set, use the whole data X dimension. eff_range_y : in, optional, type=string The X range used for defining the range over which the efficiency will be computed. Must be of the form 'a:b', where a and b specified the minimum and maximum indexes to consider. For example, 10:40 will correspond indexes 10,11,12...40. If not set, 'eff_range_y' will be used. If not set, use the whole data Y dimension. integ_range_y : in, optional, type=string The Y range used for integrating the peak. Must be of the form 'a:b', where a and b specified the minimum and maximum indexes to consider. For example, 10:40 will correspond indexes 10,11,12...40. If not set, 'eff_range_y' will be used. background_range : in, optional, type=string The background range used for substracting the background from the integrated peak. Must be of the form 'a:b' where a<0 and b>0 so that for each q frame, the background will be computed in the range [p+a,p+b] where p is the index of the reflected peak. :Author: pellegrini

Parameters

reflect
q_values
reflectivity
reflectivity_error

Keywords

integ_range_x
integ_range_y
direct
efficiency
eff_range_x
eff_range_y
background_range
peaksearch_range
wavelength

File attributes

Modification date: Tue Oct 1 14:40:51 2013
Lines: 583