Synopsis
Return the region defined in the image viewer.
Syntax
image_getregion(coord='')
Description
The regions defined in the current frame are returned.
Examples
Example 1
>>> image_getregion() 'circle(123,128,12.377649);-box(130,121,14,14,329.93142);'
Example 2
>>> image_getregion('physical')
'circle(3920.5,4080.5,396.08476);-rotbox(4144.5,3856.5,448,448,329.93142);'PARAMETERS
The parameter for this function is:
| Parameter | Type information | Definition |
|---|---|---|
| coord | str, optional | The coordinate system to use. |
Return value
The return value from this function is:
region -- The region, or regions, or the empty string.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
- contrib
- get_chart_spectrum, get_marx_spectrum
- data
- get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_scale, get_bkg_source, get_bkg_source_plot, get_coord, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, load_image, pack_image, unpack_image
- filtering
- get_filter
- fitting
- calc_stat_info, get_stat_info
- info
- get_default_id, list_stats
- methods
- get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
- modeling
- get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_model, image_model_component, image_source, image_source_component
- plotting
- get_split_plot
- psfs
- get_psf, get_psf_contour, get_psf_image, get_psf_plot, image_kernel
- statistics
- get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
- utilities
- get_analysis, get_rate
- visualization
- contour, contour_data, contour_model, contour_ratio, contour_resid, image_close, image_data, image_deleteframes, image_fit, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset