eispac core

All functions and classes in core are loaded into the top-level eispac namespace. It is therefore recommended to access them via calls like eispac.FUNCTION() rather than eispac.core.FUNCTION()

Functions

create_fit_dict(n_pxls, n_steps, n_wave, ...)	Dictionary to hold the fit parameters returned by fit_spectra()
export_fits(fit_result[, save_dir, verbose])	Save fit line intensites, velocites, and widths to a .fits file
fit_spectra(inten, template[, parinfo, ...])	Fit one or more EIS line spectra using mpfit (with multiprocessing).
fit_spectra_astropy(inten, template[, ...])	Fit one or more EIS line spectra using mpfit.
generate_astropy_model(template)	Create an Astropy fitting model using a template intended for MPFIT.
lineid_to_name(lineid)	Convert line IDs to filesystem-friendly strings
match_templates(eis_obs)	Generate a list of all template files that match an EIS file or window.
multigaussian(param, x[, n_gauss, n_poly])	Multigaussian model with a polynomial background
multigaussian_deviates(param[, x, y, error, ...])	Computes the deviates between a multigaussian model fit and input data.
read_cube([filename, window, apply_radcal, ...])	Load a single window of EIS data from an HDF5 file into an EISCube object
read_fit(filename[, verbose])	Load an EISFitResult object from an HDF5 file
read_template(filename)	Load an EISFitTemplate from an HDF5 or TOML template file
read_wininfo(filename)	Read the window information from an EIS HDF5 header file
save_fit(fit_result[, save_dir, verbose])	Save an EISFitResult object to an HDF5 file (or files)
scale_guess(x, y, param, n_gauss, n_poly)	Scale inital guess of multigaussian model parameters to data values

Classes

EISCube(*args, **kwargs)	EIS Level-1 Data Cube
EISFitResult([wave, template, parinfo, ...])	Object containing the results from fitting one or more EIS window spectra
EISFitTemplate([filename, template, parinfo])	Multigaussian fitting template for use with MPFIT and fit_spectra
EISMap(data[, header])	EIS fit parameter map.

Class Inheritance Diagram

digraph inheritanced829c4d7fb { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "EISCube" [URL="../api/eispac.core.EISCube.html#eispac.core.EISCube",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="EIS Level-1 Data Cube"]; "NDCube" -> "EISCube" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EISFitResult" [URL="../api/eispac.core.EISFitResult.html#eispac.core.EISFitResult",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Object containing the results from fitting one or more EIS window spectra"]; "EISFitTemplate" [URL="../api/eispac.core.EISFitTemplate.html#eispac.core.EISFitTemplate",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Multigaussian fitting template for use with MPFIT and `~eispac.core.fit_spectra`"]; "EISMap" [URL="../api/eispac.core.EISMap.html#eispac.core.EISMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="EIS fit parameter map."]; "GenericMap" -> "EISMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GenericMap" [URL="https://docs.sunpy.org/en/stable/generated/api/sunpy.map.GenericMap.html#sunpy.map.GenericMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Generic spatially-aware 2D data array"]; "NDData" -> "GenericMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDCube" [URL="https://docs.sunpy.org/projects/ndcube/en/stable/api/ndcube.NDCube.html#ndcube.NDCube",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class representing N-D data described by a single array and set of WCS transformations."]; "NDCubeBase" -> "NDCube" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDCubeABC" [URL="https://docs.sunpy.org/projects/ndcube/en/stable/api/ndcube.ndcube.NDCubeABC.html#ndcube.ndcube.NDCubeABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "NDDataBase" -> "NDCubeABC" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDCubeBase" [URL="https://docs.sunpy.org/projects/ndcube/en/stable/api/ndcube.NDCubeBase.html#ndcube.NDCubeBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class representing N-D data described by a single array and set of WCS transformations."]; "NDCubeABC" -> "NDCubeBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDData" -> "NDCubeBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDCubeSlicingMixin" -> "NDCubeBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDCubeSlicingMixin" [URL="https://docs.sunpy.org/projects/ndcube/en/stable/api/ndcube.mixins.NDCubeSlicingMixin.html#ndcube.mixins.NDCubeSlicingMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mixin to provide slicing on objects using the `NDData`"]; "NDSlicingMixin" -> "NDCubeSlicingMixin" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDData" [URL="https://docs.astropy.org/en/stable/api/astropy.nddata.NDData.html#astropy.nddata.NDData",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A container for `numpy.ndarray`-based datasets, using the"]; "NDDataBase" -> "NDData" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDDataBase" [URL="https://docs.astropy.org/en/stable/api/astropy.nddata.NDDataBase.html#astropy.nddata.NDDataBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base metaclass that defines the interface for N-dimensional datasets"]; "NDSlicingMixin" [URL="https://docs.astropy.org/en/stable/api/astropy.nddata.NDSlicingMixin.html#astropy.nddata.NDSlicingMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mixin to provide slicing on objects using the `NDData`"]; }