SignificanceMap

class sofia_redux.scan.source_models.maps.significance_map.SignificanceMap(observation=None)

Bases: Overlay

Create a significance map overlay of an observation.

The exposure map overlay returns and operates on the data and weight images of the Observation2D basis.

Parameters:

observationObservation2D, optional

The observation map from which to overlay significance.

Attributes Summary

data	Return the data values of the significance map.

Methods Summary

set_default_unit()	Set the default unit for the map significance.
set_unit(unit)	Set the unit for the map (Not available for S2N map).

Attributes Documentation

data

Return the data values of the significance map.

The significance (S2N or signal-to-noise ratio) is given by:

s2n = data * sqrt(weight)

where weight should be equivalent to 1/variance.

Returns:

numpy.ndarray

Methods Documentation

set_default_unit()

Set the default unit for the map significance.

The default unit will always be dimensionless (a number).

Returns:

None

set_unit(unit)

Set the unit for the map (Not available for S2N map).

The signal-to-noise ratio will always be expressed in dimensionless units (as a number).

Parameters:

unitstr or units.Unit or units.Quantity

Returns:

None