Data2D¶

class sherpa.data.Data2D(name, x0, x1, y, shape=None, staterror=None, syserror=None)[source]¶

2-D data set

Attributes Summary

`filter`	Filter for dependent variable
`mask`	Mask array for dependent variable

Methods Summary

`apply_filter`(data)
`eval_model`(modelfunc)
`eval_model_to_fit`(modelfunc)
`get_axes`()
`get_dep`([filter])
`get_dims`([filter])
`get_error`([filter, staterrfunc])	Return the total error on the dependent variable.
`get_filter`()
`get_filter_expr`()
`get_img`([yfunc])
`get_imgerr`()
`get_indep`([filter])
`get_max_pos`([dep])
`get_staterror`([filter, staterrfunc])	Return the statistical error on the dependent axis of a data set.
`get_syserror`([filter])	Return the statistical error on the dependent axis of a data set.
`get_x`([filter])	Return linear view of independent axis/axes
`get_x0`([filter])
`get_x0label`()	Return label for first dimension in 2-D view of independent axis/axes
`get_x1`([filter])
`get_x1label`()	Return label for second dimension in 2-D view of independent axis/axes
`get_xerr`([filter])	Return linear view of bin size in independent axis/axes
`get_xlabel`()	Return label for linear view of independent axis/axes
`get_y`([filter, yfunc])	Return dependent axis in N-D view of dependent variable
`get_yerr`([filter, staterrfunc])	Return errors in dependent axis in N-D view of dependent variable
`get_ylabel`([yfunc])	Return label for dependent axis in N-D view of dependent variable
`ignore`(\args, \\*kwargs)
`notice`([x0lo, x0hi, x1lo, x1hi, ignore])
`set_dep`(val)	Set the dependent variable values
`to_contour`([yfunc])
`to_fit`([staterrfunc])
`to_guess`()
`to_plot`([yfunc, staterrfunc])

Attributes Documentation

Methods Documentation

get_error(filter=False, staterrfunc=None)¶

Return the total error on the dependent variable.

Parameters:	filter (bool, optional) – Should the filter attached to the data set be applied to the return value or not. The default is False. staterrfunc (function) – If no statistical error has been set, the errors will be calculated by applying this function to the dependent axis of the data set.
Returns:	axis – The error for each data point, formed by adding the statistical and systematic errors in quadrature.
Return type:	array or None