`FieldAmplitude`

class nexus.FieldAmplitude(Measurement self, Experiment experiment, std::string const id="")

class nexus.FieldAmplitude(Measurement self, Experiment experiment, DoubleVector detuning, std::string const id="") → Measurement

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.

PopulateOptimizerHandler(Measurement self, OptimizerHandler optimizer_handler)

Update(Measurement self)

Velocity()

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

Returns:: Velocity detuning (mm/s).
Return type:: ndarray

property depth

std::vector<(double,std::allocator<(double)>)>

Type:: depth

property detuning

std::vector<(double,std::allocator<(double)>)>

Type:: detuning

property energy

double

Type:: energy

property experiment

p.Experiment

Type:: experiment

property id

std::string

Type:: id

property num_points

unsigned int

Type:: num_points

property result

std::vector<(Complex,std::allocator<(Complex)>)>

Type:: result

property sample

p.BasicSample

Type:: sample

property time

std::vector<(double,std::allocator<(double)>)>

Type:: time

FieldAmplitude

`FieldAmplitude`