Tracer

class sunkit_magex.pfss.tracing.Tracer

Bases: ABC

Abstract base class for a streamline tracer.

Methods Summary

cartesian_to_coordinate()	Convert cartesian coordinate outputted by a tracer to a FieldLine object.
coords_to_xyz(seeds, output)	Given a set of astropy sky coordinates, transoform them to cartesian x, y, z coordinates.
trace(seeds, output)
validate_seeds(seeds)	Check that seeds has the right shape and is the correct type.

Methods Documentation

static cartesian_to_coordinate()

Convert cartesian coordinate outputted by a tracer to a FieldLine object.

static coords_to_xyz(seeds, output)

Given a set of astropy sky coordinates, transoform them to cartesian x, y, z coordinates.

Parameters:

• seeds (astropy.coordinates.SkyCoord)

• output (sunkit_magex.pfss.Output)

abstractmethod trace(seeds, output)

Parameters:

• seeds (astropy.coordinates.SkyCoord) – Coordinaes of the magnetic field seed points.

• output (sunkit_magex.pfss.Output) – pfss output.

Returns:

streamlines – Traced field lines.

Return type:

FieldLines

static validate_seeds(seeds)

Check that seeds has the right shape and is the correct type.