Models (sunkit_spex.models)

sunkit_spex.models contains a number of functional and physical models.

sunkit_spex.models Package

sunkit_spex.models.models Module

Module for generic mathematical models.

Classes

GaussianModel([amplitude, mean, stddev, edges])
StraightLineModel([slope, intercept, edges])

Class Inheritance Diagram

sunkit_spex.models.instrument_response Module

Module for model components required for instrument response models.

Classes

MatrixModel(matrix)

Class Inheritance Diagram

sunkit_spex.models.scaling Module

Classes

Constant([constant])	A model which returns an array with dimensions n-1 of the input dimension populated with a constant value, of whichever units specified by the user.
InverseSquareFluxScaling([observer_distance])	InverseSqaureFluxScaling model converts luminosity output of physical models to a distance scaled flux.

Class Inheritance Diagram

sunkit_spex.models.physical Package

sunkit_spex.models.physical.thermal Module

Classes

ContinuumEmission([temperature, ...])	Calculate the thermal X-ray continuum emission from the solar atmosphere.
LineEmission([temperature, ...])	Calculate thermal line emission from the solar corona.
ThermalEmission([temperature, ...])	Calculate the thermal X-ray spectrum (lines + continuum) from the solar atmosphere.

Class Inheritance Diagram

sunkit_spex.models.physical.nonthermal Module

Functions for computing the photon flux due to bremsstrahlung radiation from energetic electrons impacting a dense plasma. See [1] and [2].

References

[1]

Thick-Target: https://hesperia.gsfc.nasa.gov/hessi/flarecode/bremthickdoc.pdf

[2]

Thin-Target: https://hesperia.gsfc.nasa.gov/hessi/flarecode/bremdoc.pdf

Classes

ThickTarget([p, break_energy, q, ...])	Calculates the thick-target bremsstrahlung radiation of a dual power-law electron distribution.
ThinTarget([p, break_energy, q, ...])	Calculates the thin-target bremsstrahlung radiation of a dual power-law electron distribution.

Class Inheritance Diagram

sunkit_spex.models.physical.albedo Module

Functions

get_albedo_matrix(energy_edges, theta[, ...])

Get albedo correction matrix.

Classes

Albedo(*args, **kwargs)

Aldedo model which adds albdeo correction to input spectrum.

Class Inheritance Diagram

sunkit_spex.models.physical.integrate Module

Functions

fixed_quad_batch(func, a, b[, n, args, ...])	Compute a definite integral using fixed-order Gaussian quadrature.
gauss_legendre(func, a, b[, n, args, ...])	Compute a definite integral using fixed-order Gaussian quadrature.