find_fieldlines_within_loop_footprint#
- greensfield.util.find_fieldlines_within_loop_footprint(fieldlines, coordinate, wcs, radius=None, index=0)[source]#
Find fieldlines whose footpoints fall within the footprint of a visually-defined loop.
- Parameters:
fieldlines (
listofgreensfield.models.Fieldline) – Fieldlines traced through field extrapolation to iterate overcoordinate (
SkyCoord) – The coordinate defining the base of the visually-defined loop. If a single point,radiusis used to define the circular footprint. If radius is None, it is assumed that this defines closed path of the loop footprint.wcs (
WCS) – The WCS of the image from whichcoordinatewas derived.radius (
float, optional) – The radius of the circular loop footprint.index (
int, optional) – The index of the fieldline coordinate to use that defines the fieldline footpoint.
- Returns:
bundle
- Return type: