SimpleAperturePhotometry#

class jdaviz.configs.imviz.plugins.aper_phot_simple.aper_phot_simple.SimpleAperturePhotometry(*args, **kwargs)[source]#

Bases: PluginTemplateMixin, DatasetSelectMixin, TableMixin, PlotMixin

Public constructor

Attributes Summary

`background_value`	A trait which allows any value.
`bg_subset_items`	An instance of a Python list.
`bg_subset_selected`	A trait for unicode strings.
`counts_factor`	A trait which allows any value.
`current_plot_type`	A trait for unicode strings.
`fit_radial_profile`	A boolean (True, False) trait.
`fit_results`	An instance of a Python list.
`flux_scaling`	A trait which allows any value.
`pixel_area`	A trait which allows any value.
`plot_available`	A boolean (True, False) trait.
`plot_types`	An instance of a Python list.
`radial_plot`	A trait which allows any value.
`result_available`	A boolean (True, False) trait.
`result_failed_msg`	A trait for unicode strings.
`results`	An instance of a Python list.
`subset_area`	An int trait.
`subset_items`	An instance of a Python list.
`subset_selected`	A trait for unicode strings.
`template_file`

Methods Summary

`batch_aper_phot`(options[, full_exceptions])	Run aperture photometry over a list of options.
`unpack_batch_options`(**options)	Unpacks a dictionary of options for batch mode, including all combinations of any values passed as tuples or lists. For example::.
`vue_do_aper_phot`(args, *kwargs)

Attributes Documentation

background_value#: A trait which allows any value.

bg_subset_items#: An instance of a Python list.

bg_subset_selected#: A trait for unicode strings.

counts_factor#: A trait which allows any value.

current_plot_type#: A trait for unicode strings.

fit_radial_profile#: A boolean (True, False) trait.

fit_results#: An instance of a Python list.

flux_scaling#: A trait which allows any value.

pixel_area#: A trait which allows any value.

plot_available#: A boolean (True, False) trait.

plot_types#: An instance of a Python list.

radial_plot#: A trait which allows any value.

result_available#: A boolean (True, False) trait.

result_failed_msg#: A trait for unicode strings.

results#: An instance of a Python list.

subset_area#: An int trait.

subset_items#: An instance of a Python list.

subset_selected#: A trait for unicode strings.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.7.0/lib/python3.11/site-packages/jdaviz/configs/imviz/plugins/aper_phot_simple/aper_phot_simple.py', 'aper_phot_simple.vue')#

Methods Documentation

batch_aper_phot(options, full_exceptions=False)[source]#

Run aperture photometry over a list of options. Values will be looped in order and any unprovided options will remain at there previous values (either from a previous entry in the list or from the plugin). The plugin itself will update and will remain at the final state from the last entry in the list.

To provide a list of values per-input, use unpack_batch_options to and pass that as input here.

Parameters:

optionslist: Each entry will result in one computation of aperture photometry and should be a dictionary of values to override from the values set in the plugin/traitlets.
full_exceptionsbool, optional: Whether to expose the full exception message for all failed iterations.

unpack_batch_options(**options)[source]#

Unpacks a dictionary of options for batch mode, including all combinations of any values passed as tuples or lists. For example:

unpack_batch_options(dataset=['image1', 'image2'],
                     subset=['Subset 1', 'Subset 2'],
                     bg_subset=['Subset 3'],
                     flux_scaling=3
                     )

would result in:

[{'subset': 'Subset 1',
  'dataset': 'image1',
  'bg_subset': 'Subset 3',
  'flux_scaling': 3},
 {'subset': 'Subset 2',
  'dataset': 'image1',
  'bg_subset': 'Subset 3',
  'flux_scaling': 3},
 {'subset': 'Subset 1',
  'dataset': 'image2',
  'bg_subset': 'Subset 3',
  'flux_scaling': 3},
 {'subset': 'Subset 2',
  'dataset': 'image2',
  'bg_subset': 'Subset 3',
  'flux_scaling': 3}]

Parameters:

optionsdict: Dictionary of values to override from the values set in the plugin/traitlets. Each entry can either be a single value, or a list. All combinations of those that contain a list will be exposed

Returns:

optionslist: List of all combinations of input parameters, which can then be used as input to batch_aper_phot

vue_do_aper_phot(*args, **kwargs)[source]#