DataIMGInt¶
-
class
sherpa.astro.data.
DataIMGInt
(name, x0lo, x1lo, x0hi, x1hi, y, shape=None, staterror=None, syserror=None, sky=None, eqpos=None, coord='logical', header=None)[source] [edit on github]¶ Bases:
sherpa.astro.data.DataIMG
Attributes Summary
coord
Coordinate system of independent axes filter
Filter for dependent variable mask
Mask array for dependent variable Methods Summary
apply_filter
(data)eval_model
(modelfunc)eval_model_to_fit
(modelfunc)filter_region
(data)get_axes
()get_bounding_mask
()get_dep
([filter])Return the dependent axis of a data set. get_dims
([filter])get_error
([filter, staterrfunc])Return the total error on the dependent variable. get_filter
()get_filter_expr
()get_image
()get_img
([yfunc])Return dependent variable as an image get_imgerr
()Return total error in dependent variable as an image get_indep
([filter, model])Return the independent axes of a data set. get_logical
()get_max_pos
([dep])get_physical
()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_wcs
()get_world
()get_x
([filter, yfunc, use_evaluation_space])Return linear view of independent axis/axes get_x0
([filter])Return first dimension in 2-D view of independent axis/axes get_x0label
()Return label for first dimension in 2-D view of independent axis/axes get_x1
([filter])Return second dimension in 2-D view of independent axis/axes get_x1label
()Return label for second dimension in 2-D view of independent axis/axes get_xerr
([filter, yfunc])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, use_evaluation_space])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])notice2d
([val, ignore])set_coord
(coord)set_dep
(val)Set the dependent variable values to_component_plot
([yfunc, staterrfunc])to_contour
([yfunc])to_fit
([staterrfunc])to_guess
()to_plot
([yfunc, staterrfunc])Attributes Documentation
-
coord
¶ Coordinate system of independent axes
-
filter
¶ Filter for dependent variable
-
mask
¶ Mask array for dependent variable
Methods Documentation
-
apply_filter
(data) [edit on github]¶
-
eval_model
(modelfunc) [edit on github]¶
-
eval_model_to_fit
(modelfunc) [edit on github]¶
-
filter_region
(data) [edit on github]¶
-
get_axes
()[source] [edit on github]¶
-
get_bounding_mask
() [edit on github]¶
-
get_dep
(filter=False) [edit on github]¶ Return the dependent axis of a data set.
Parameters: filter (bool, optional) – Should the filter attached to the data set be applied to the return value or not. The default is False. Returns: axis – The dependent axis values for the data set. This gives the value of each point in the data set. Return type: array See also
get_indep()
- Return the independent axis of a data set.
get_error()
- Return the errors on the dependent axis of a data set.
get_staterror()
- Return the statistical errors on the dependent axis of a data set.
get_syserror()
- Return the systematic errors on the dependent axis of a data set.
-
get_dims
(filter=False) [edit on github]¶
-
get_error
(filter=False, staterrfunc=None) [edit on github]¶ 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
See also
get_dep()
- Return the independent axis of a data set.
get_staterror()
- Return the statistical errors on the dependent axis of a data set.
get_syserror()
- Return the systematic errors on the dependent axis of a data set.
-
get_filter
() [edit on github]¶
-
get_filter_expr
() [edit on github]¶
-
get_image
() [edit on github]¶
-
get_img
(yfunc=None) [edit on github]¶ Return dependent variable as an image
-
get_imgerr
() [edit on github]¶ Return total error in dependent variable as an image
-
get_indep
(filter=False, model=None)[source] [edit on github]¶ Return the independent axes of a data set.
Parameters: filter (bool, optional) – Should the filter attached to the data set be applied to the return value or not. The default is False. Returns: axis – The independent axis values for the data set. This gives the coordinates of each point in the data set. Return type: tuple of arrays See also
get_dep()
- Return the dependent axis of a data set.
-
get_logical
()[source] [edit on github]¶
-
get_max_pos
(dep=None) [edit on github]¶
-
get_physical
()[source] [edit on github]¶
-
get_staterror
(filter=False, staterrfunc=None) [edit on github]¶ Return the statistical error on the dependent axis of a data set.
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 statistical error for each data point. A value of None is returned if the data set has no statistical error array and staterrfunc is None.
Return type: array or None
See also
get_error()
- Return the errors on the dependent axis of a data set.
get_indep()
- Return the independent axis of a data set.
get_syserror()
- Return the systematic errors on the dependent axis of a data set.
-
get_syserror
(filter=False) [edit on github]¶ Return the statistical error on the dependent axis of a data set.
Parameters: filter (bool, optional) – Should the filter attached to the data set be applied to the return value or not. The default is False. Returns: axis – The systematic error for each data point. A value of None is returned if the data set has no systematic errors. Return type: array or None See also
get_error()
- Return the errors on the dependent axis of a data set.
get_indep()
- Return the independent axis of a data set.
get_staterror()
- Return the statistical errors on the dependent axis of a data set.
-
get_wcs
() [edit on github]¶
-
get_world
()[source] [edit on github]¶
-
get_x
(filter=False, yfunc=None, use_evaluation_space=False) [edit on github]¶ Return linear view of independent axis/axes
-
get_x0
(filter=False)[source] [edit on github]¶ Return first dimension in 2-D view of independent axis/axes
-
get_x0label
() [edit on github]¶ Return label for first dimension in 2-D view of independent axis/axes
-
get_x1
(filter=False)[source] [edit on github]¶ Return second dimension in 2-D view of independent axis/axes
-
get_x1label
() [edit on github]¶ Return label for second dimension in 2-D view of independent axis/axes
-
get_xerr
(filter=False, yfunc=None) [edit on github]¶ Return linear view of bin size in independent axis/axes
-
get_xlabel
() [edit on github]¶ Return label for linear view of independent axis/axes
-
get_y
(filter=False, yfunc=None, use_evaluation_space=False) [edit on github]¶ Return dependent axis in N-D view of dependent variable
-
get_yerr
(filter=False, staterrfunc=None) [edit on github]¶ Return errors in dependent axis in N-D view of dependent variable
-
get_ylabel
(yfunc=None) [edit on github]¶ Return label for dependent axis in N-D view of dependent variable
-
ignore
(*args, **kwargs) [edit on github]¶
-
notice
(x0lo=None, x0hi=None, x1lo=None, x1hi=None, ignore=False) [edit on github]¶
-
notice2d
(val=None, ignore=False) [edit on github]¶
-
set_coord
(coord)[source] [edit on github]¶
-
set_dep
(val) [edit on github]¶ Set the dependent variable values
-
to_component_plot
(yfunc=None, staterrfunc=None) [edit on github]¶
-
to_contour
(yfunc=None) [edit on github]¶
-
to_fit
(staterrfunc=None) [edit on github]¶
-
to_guess
() [edit on github]¶
-
to_plot
(yfunc=None, staterrfunc=None) [edit on github]¶
-