# FieldLine

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

Bases: object

A single magnetic field line.

Parameters
• x – Field line coordinates in cartesian coordinates.

• y – Field line coordinates in cartesian coordinates.

• z – Field line coordinates in cartesian coordinates.

• output (Output) – The PFSS output through which this field line was traced.

Attributes Summary

 b_along_fline The magnetic field vectors along the field line. coords Field line SkyCoord. 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. solar_footpoint Solar surface magnetic field footpoint. source_surface_footpoint Solar surface magnetic field footpoint.

Attributes Documentation

b_along_fline

The magnetic field vectors along the field line.

coords

Field line SkyCoord.

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 – Field line expansion factor.

Return type

float

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 – 0 if the field line is closed, otherwise sign(Br) of the magnetic field on the solar surface.

Return type

int

solar_footpoint

Solar surface magnetic field footpoint.

This is the ends of the magnetic field line that lies on the solar surface.

Returns

footpoint

Return type

SkyCoord

Notes

For a closed field line, both ends lie on the solar surface. This method returns the field line pointing out from the solar surface in this case.

source_surface_footpoint

Solar surface magnetic field footpoint.

This is the ends of the magnetic field line that lies on the solar surface.

Returns

footpoint

Return type

SkyCoord

Notes

For a closed field line, both ends lie on the solar surface. This method returns the field line pointing out from the solar surface in this case.
{"extraction_info": {"found_math": true, "script_math_tex": 0, "script_math_asciimath": 0, "math_annotations": 0, "math_alttext": 0, "mathml": 0, "mathjax_tag": 0, "mathjax_inline_tex": 0, "mathjax_display_tex": 1, "mathjax_asciimath": 1, "img_math": 0, "codecogs_latex": 0, "wp_latex": 0, "mimetex.cgi": 0, "/images/math/codecogs": 0, "mathtex.cgi": 0, "katex": 0, "math-container": 0, "wp-katex-eq": 0, "align": 0, "equation": 0, "x-ck12": 0, "texerror": 0, "math_score": 0.574843168258667, "perplexity": 2292.880940575032}, "config": {"markdown_headings": true, "markdown_code": true, "boilerplate_config": {"ratio_threshold": 0.18, "absolute_threshold": 10, "end_threshold": 15, "enable": true}, "remove_buttons": true, "remove_image_figures": true, "remove_link_clusters": true, "table_config": {"min_rows": 2, "min_cols": 3, "format": "plain"}, "remove_chinese": true, "remove_edit_buttons": true, "extract_latex": true}, "warc_path": "s3://commoncrawl/crawl-data/CC-MAIN-2022-21/segments/1652663016949.77/warc/CC-MAIN-20220528154416-20220528184416-00657.warc.gz"}