AnalyticalModel

class solarbextrapolation.analyticalmodels.AnalyticalModel(**kwargs)[source]

Bases: object

Common class for the development of anylitical models of magnetic fields. Use the models to evaluate the accuracy of an extrapolation routine with the figures of merit.

Methods Summary

generate(**kwargs) Method to be called to calculate the vector field and return as a Map3D object.
to_los_magnetogram(**kwargs) Calculate the LoS vector field as a SunPy map and return.
to_vec_magnetogram(**kwargs) Calculate the vector field as a SunPy map and return.

Methods Documentation

generate(**kwargs)[source]

Method to be called to calculate the vector field and return as a Map3D object. Times and saves the extrapolation where applicable.

to_los_magnetogram(**kwargs)[source]

Calculate the LoS vector field as a SunPy map and return.

Generally this will require that you have run generate(self, **kwargs) first, so in the base class this is checked, but it is not always the case as some models may allow this to be determined without calculating the full field.

to_vec_magnetogram(**kwargs)[source]

Calculate the vector field as a SunPy map and return.

Generally this will require that you have run generate(self, **kwargs) first, so in the base class this is checked, but it is not always the case as some models may allow this to be determined without calculating the full field. ######### I’m not sure if this is a good default.