MagVectorCube¶

class stokespy.MagVectorCube(data, wcs=None, magnetic_params=('B', 'inclination', 'azimuth'), **kwargs)[source]¶

Class representing a 2D map of inverted magnetic field vectors.

Parameters

data (numpy.ndarray) – The array holding the magnetic field data stored in the object. The array index order must be (magnetic, coord1, coord2) or should this be (magnetic, coord2, coord1)?
wcs (astropy.wcs.wcsapi.BaseLowLevelWCS, astropy.wcs.wcsapi.BaseHighLevelWCS, optional) – The WCS object containing the axes’ information. If not provided, a WCS is constructed using wavelength_unit and coordinate_unit, which default to pixels.
magnetic_params (tuple or str) – Tuple containing all or part of the magnetic field components (‘B’, ‘inclination’, ‘azimuth’)

Attributes Summary

`B`	Magnetic field strength as a 2D NDcube (coord1, coord2)
`azimuth`	Magnetic azimuth as 2D NDCube (coord1, coord2)
`inclination`	Magnetic inclination as a 2D NDCube (coord1, coord2)
`magnetic_axis`	The available magnetic parameters

Methods Summary

`coord1_axis`(coord2)	The physical axis across the first spatial dimension
`coord2_axis`(coord1)	The physical axis across the second spatial dimension

Attributes Documentation

Methods Documentation

coord1_axis(coord2)[source]¶: The physical axis across the first spatial dimension

coord2_axis(coord1)[source]¶: The physical axis across the second spatial dimension