Tracer

class pfsspy.tracing.Tracer

Bases: abc.ABC

Abstract base class for a streamline tracer.

Methods Summary

cartesian_to_coordinate()	Convert cartesian coordinate outputted by a tracer to a FieldLine object.
trace(self, seeds, output)	Parameters:
validate_seeds_shape(seeds)	Check that seeds has the right shape.

Methods Documentation

static cartesian_to_coordinate()

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

trace(self, seeds, output)

Parameters:

seeds : (n, 3) array

Coordinaes of the magnetic field seed points.

output : pfsspy.Output

pfss output.

Returns:

streamlines : FieldLines

Traced field lines.

static validate_seeds_shape(seeds)

Check that seeds has the right shape.