solarbextrapolation.map3dclasses.
Map3D
(data, meta, **kwargs)[source]¶Bases: object
A basic data structure for holding a 3D numpy array of floats or 3-float vectors and metadata. The structure can be saved/loaded (using pickle ATM).
Parameters: | data :
meta :
|
---|
Attributes Summary
date |
Image observation time |
dsun |
The observer distance from the Sun. |
is_scalar |
Returns true if data is a volume of scalar values (3D array) or false if it is a volume of vector values (4D array). |
rsun_meters |
Radius of the sun in meters |
scale |
Image scale along the x, y and z axes in units/pixel (cdelt1/2/3) |
units |
Image coordinate units along the x, y and z axes (cunit1/2/3). |
Methods Summary
load (filepath, **kwargs) |
Load a Map3D instance using pickle. |
save (filepath[, filetype]) |
Saves the Map3D object to a file. |
Attributes Documentation
date
¶Image observation time
dsun
¶The observer distance from the Sun.
is_scalar
¶Returns true if data is a volume of scalar values (3D array) or false if it is a volume of vector values (4D array).
rsun_meters
¶Radius of the sun in meters
scale
¶Image scale along the x, y and z axes in units/pixel (cdelt1/2/3)
units
¶Image coordinate units along the x, y and z axes (cunit1/2/3).
Methods Documentation
save
(filepath, filetype='auto', **kwargs)[source]¶Saves the Map3D object to a file.
Currently uses Python pickle. https://docs.python.org/2/library/pickle.html In the future support will be added for saving to other formats.
Parameters: | filepath : string
filetype : string
|
---|