Evaluators¶

class ReceivePowerEvaluator(target, plot_scale='log')[source]¶

Bases: Evaluator

Estimates the signal power received receivers.

Parameters:

target (Receiver) – The device or receiver to measure the received power of.
plot_scale (str) – The scale of the plot. Can be 'linear' or 'log'.

Evaluate the state of an investigated object.

Implements the process of extracting an arbitrary performance indicator, represented by the returned Artifact \(X_m\).

Returns: Artifact \(X_m\) resulting from the evaluation.

Return type:: PowerEvaluation

generate_result(grid, artifacts)[source]¶

Generates an evaluation result from the artifacts collected over the whole simulation grid.

Parameters:

grid (Sequence[GridDimension]) – The Simulation grid.
artifacts (ndarray) – Numpy object array whose dimensions represent grid dimensions.

Return type:

PowerResult

Returns: The evaluation result.

property abbreviation: str¶

Short string representation of this evaluator.

Used as a label for console output and plot axes annotations.

property title: str¶

Long string representation of this evaluator.

Used as plot title.

class TransmitPowerEvaluator(target, plot_scale='log')[source]¶

Bases: Evaluator

Estimates the signal power transmitted by transmitters.

Parameters:

target (Transmitter) – The device or receiver to measure the received power of.
plot_scale (str) – The scale of the plot. Can be 'linear' or 'log'.

evaluate()[source]¶

Evaluate the state of an investigated object.

Implements the process of extracting an arbitrary performance indicator, represented by the returned Artifact \(X_m\).

Returns: Artifact \(X_m\) resulting from the evaluation.

Return type:: PowerEvaluation

generate_result(grid, artifacts)[source]¶

Generates an evaluation result from the artifacts collected over the whole simulation grid.

Parameters:

grid (Sequence[GridDimension]) – The Simulation grid.
artifacts (ndarray) – Numpy object array whose dimensions represent grid dimensions.

Return type:

PowerResult

Returns: The evaluation result.

property abbreviation: str¶

Short string representation of this evaluator.

Used as a label for console output and plot axes annotations.

property title: str¶

Long string representation of this evaluator.

Used as plot title.

class PowerEvaluation(power)[source]¶

Bases: Evaluation[StemVisualization]

The evaluation of a received power evaluation.

Generated by evaluating power evaluators.

Parameters:: power (ndarray) – The received power in Watts for each antenna stream.

artifact()[source]¶

Generate an artifact from this evaluation.

Returns: The evaluation artifact.

Return type:: PowerArtifact

property power: ndarray¶: The received power indicator in V^2 for each antenna stream.

property title: str¶

Title of the visualizable.

Returns: Title string.

class PowerArtifact(power)[source]¶

Bases: Artifact

The artifact of a received power evaluation.

Generated by the artifact of PowerEvaluation.

Parameters:: power (ndarray) – The received power in Watts for each antenna stream.

to_scalar()[source]¶

Scalar representation of this artifact’s content.

Used to evaluate premature stopping criteria for the underlying evaluation.

Return type:: float
Returns:: Scalar floating-point representation. None if a conversion to scalar is impossible.

property power: ndarray¶: The received power in Watts for each antenna stream.

class PowerResult(average_powers, grid, evaluator, plot_surface=False)[source]¶

Bases: ScalarEvaluationResult

The result of a received power evaluation.

Final result of power evaluations after all evaluation artifacts have been collected.

Parameters:

average_powers (numpy.ndarray) – The received power in Watts for each antenna stream.
grid (Sequence[GridDimension]) – The grid dimensions of the evaluation.
evaluator (Evaluator) – The evaluator that generated this result.
plot_surface (bool) – Whether two-dimensional evaluations should be plotted as surface plots.

to_array()[source]¶

Convert the evaluation result raw data to an array representation.

Used to store the results in arbitrary binary file formats after simulation execution.

Returns: The array result representation.

Return type:: ndarray

property average_powers: ndarray¶: The received power in Watts for each antenna stream.