FieldAmplitude

class nexus.FieldAmplitude(sample, energy, points=101, id='')

Bases: Measurement

Constructor for the FieldAmplitude class. Calculates the depth-dependent field amplitude inside a sample.

Parameters:

• id (string) – User identifier.

• sample (BasicSample) – Sample for the calculation. In case that the experiment has several objects only the field amplitude of the given sample is determined.

• energy (float) – X-ray energy (eV).

• points (int) – Number of calculation points.

id

User identifier.

Type:

string

sample

Sample for the calculation. In case that the experiment has several objects only the field amplitude of the given sample is determined.

Type:

BasicSample

energy

X-ray energy (eV).

Type:

float

result

List of complex scattering amplitudes.

Type:

list

depth

List of the depth values for the calculation.

Type:

list

num_points

Number of calculation points.

Type:

int

Calculate()

Calculates the class method. Also callable via operator ().

Returns:

Array of depth values, array of amplitude values.

Return type:

ndarray, ndarray

Plot()

Plot the field amplitude in a sample.

Velocity()

Returns the velocity detuning of the measurement in units of mm/s.

Returns:

Velocity detuning (mm/s).

Return type:

ndarray