FieldLine¶

class pfsspy.FieldLine(x, y, z, output)¶

Bases: astropy.coordinates.sky_coordinate.SkyCoord

A single magnetic field line.

This is a sub-class of astropy.coordinates.SkyCoord. For more details on

Parameters:	x : Field line x coordinates as a fraction of solar radius y : Field line y coordinates as a fraction of solar radius z : Field line z coordinates as a fraction of solar radius output : `Output`
Attributes:	representation_type : str Coordinate system representation. By default is `'cartesian'`, but can also be manually set to `'spherical'`. x, y, z : Field line cartesian coordinates. Can only be accessed if representation_type is `'cartesian'`. r, theta, phi : field line spherical coordinates. Can only be accessed if representation_type is `'spherical'`.

Attributes Summary

`expansion_factor`	Magnetic field expansion factor.
`is_open`	Returns `True` if one of the field line is connected to the solar surface and one to the outer boundary, `False` otherwise.
`polarity`	Magnetic field line polarity.

Attributes Documentation

expansion_factor¶

Magnetic field expansion factor.

The expansion factor is defnied as \((r_{\odot}^{2} B_{\odot}) / (r_{ss}^{2} B_{ss}))\)

Returns:	exp_fact : float Field line expansion factor. If field line is closed, returns `None`.

is_open¶: Returns True if one of the field line is connected to the solar surface and one to the outer boundary, False otherwise.

polarity¶

Magnetic field line polarity.

Returns:	pol : int 0 if the field line is closed, otherwise sign(Br) of the magnetic field on the solar surface.