SingleGaussian

class sofia_redux.scan.simulation.source_models.single_gaussian.SingleGaussian(**kwargs)

Bases: SimulatedSource

Initialize a SingleGaussian simulated source.

Models the source as a single Gaussian that may be applied to any 2-dimensional coordinates with the exception of horizontal type.

Parameters:

kwargsdict

Optional keyword arguments to pass into Gaussian2D. Note that width settings MUST be provided. The width parameters can take the values {x_stddev, y_stddev, fwhm, x_fwhm, y_fwhm}.

Methods Summary

apply_to_horizontal(horizontal)	Apply the source model to a set of 2-D offsets.
apply_to_offsets(offsets)	Apply the source model to a set of 2-D offsets.
copy()	Return a copy of the SingleGaussian.
initialize_model(**kwargs)	Initialize the model with the provided options.

Methods Documentation

apply_to_horizontal(horizontal)

Apply the source model to a set of 2-D offsets.

Parameters:

horizontalHorizontalCoordinates

HorizontalCoordinates.

Returns:

datanumpy.ndarray

The modelled data of the source given the offsets.

apply_to_offsets(offsets)

Apply the source model to a set of 2-D offsets.

Parameters:

offsetsCoordinate2D

Equatorial native offsets.

Returns:

datanumpy.ndarray

The modelled data of the source given the offsets.

copy()

Return a copy of the SingleGaussian.

Returns:

SingleGaussian

initialize_model(**kwargs)

Initialize the model with the provided options.

Parameters:

kwargsdict, optional

Returns:

None