# Map3DComparer¶

class solarbextrapolation.map3dclasses.Map3DComparer(map3D, *args, **kwargs)[source]

Bases: object

Class for comparrison of vector fields.
There are two classification of test:
* Mono: returns a value for a given vector field. Can be normalized to the benchmark field.
* Binary: requires comparrison between two vector fields.
By default:
* Benchmark field is the first/original vector field. This is used as the baseline for comparrison. This can be changed using the benchmark=n kwarg.
* Normalise will be set to false.
Individual tests can be run and return results for imediate viewing (using astropy.table).
Likewise, compare_all can be used to run the whole series of tests.
Note: all vector fields must be of the same shape.

Methods Summary

 L_infin_norm(map_field, benchmark, **kwargs) l-infinity norm of the vector field. compare_all(**kwargs) Compare all of the given vector fields and return the results as an astropy.table.

Methods Documentation

L_infin_norm(map_field, benchmark, **kwargs)[source]

l-infinity norm of the vector field. For vector field $$fx$$ this would be:

$\| \mathbf{x} \| \infty = \sqrt[\infty]{\Sigma_i x_i^\infty} pprox ext{max}(|x_i|)$

(the malue of the maximum component)

compare_all(**kwargs)[source]

Compare all of the given vector fields and return the results as an astropy.table.