Construct a FieldAlignedPositions object.

This is the recommended way to instantiate FieldAlignedPositions objects, as it will ensure they end up in a valid

Parameters:¶

start_points: SliceCoords¶

The positions on the poloidal plane from which to project along field lines.

dx3: float¶

The width of the data in the x3-direction, before subdividing.

field: FieldTrace¶

The underlying magnetic field along which to trace.

alignments: numpy.typing.NDArray¶

The extent to which projections from each of the starting points follows the field line versus stays fixed at the starting poloidal position. A value of 1 corresponds to it completely following the field line while 0 means it doesn’t follow it at all (the x1 and x2 coordinates are unchanged as moving in the x3 direction). Values in between result in linear interpolation between these two extremes. This array should be of the same or lower dimension as start_points and must be broadcast-compatible with it.

order: int¶

The order of accuracy with which to represent lines in the x3-direction. Determines the number of points that will be stored.

num_divisions: int = 1¶

The number of segments this data is divided into along the x3-direction. Note that the result will not actually be divided in this way; it will just be able to be divided while still providing the desired order of accuracy.