# Extrapolators¶

class solarbextrapolation.extrapolators.Extrapolators(map_magnetogram, **kwargs)[source]

Bases: object

Common class for all 3D vector field extrapolation routines. Each routine, created by building a subclass, will have wildly varying capabilities and input arguments so this have been left intentionally minimal. The primary method to override is extrapolation(), the primary method to call is extrapolate() which will both call extrapolation() and save the result if a filepath argument is given.

Parameters: map_magnetogram : sunpy.map.GenericMap The sunpy map containing the boundary magnetogram data. filepath : string The optional filepath for automatic saving of extrapolation results. notes : string The optional notes regarding thius run of the extrapolation routine. extrapolator_routine : string The name for the extrapolation routine. zshape : int The vertical grid size. xrange : astropy.unit.Quantity, optional The x edge to edge coordinates. If defined will manually scale the boundary data. yrange : astropy.units.quantity.Quantity, optional The y edge to edge coordinates. If defined will manually scale the boundary data. zrange : astropy.unit.Quantity The vertical edge to edge coordinates for the vertical range. notes : string User specified notes that will be added to the metadata.

Construct an extrapolator using the given 2D map.

Methods Summary

 extrapolate(**kwargs) Method to be called to run the extrapolation.

Methods Documentation

extrapolate(**kwargs)[source]

Method to be called to run the extrapolation. Times and saves the extrapolation where applicable.