bestgui.paramset

Forms for BEST parameters files setup and management.

class bestgui.paramset.AltitudeOfAmbiguityForm

clear()

Clear all the objects in the ParamSet.

get_values()

on_coortype_changed(widget=None)

on_toggled(widget=None)

set_default()

Set at the default value all the objects in the ParamSet.

set_values(vlist)

class bestgui.paramset.AltitudeOfAmbiguityParamSet(name='altitudeOfAmbiguity', label='Altitude of Ambbiguity Evaluation')

clear()

Clear all the objects in the ParamSet.

enabled

get_enabled()

set_default()

Set at the default value all the objects in the ParamSet.

set_enabled(enabled)

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the AoIParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the AoIParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.AoIParamSet(name='AoI', label='Area of Interest')

Set of parameters representing the Area of Interest (AoI).

@TODO: AoIParamSet should not derive from AoIForm, it “has” a AoIForm

attribute.

clear()

Clear all the objects in the ParamSet.

set_default()

Set at the default value all the objects in the ParamSet.

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the AoIParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the AoIParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.AoIParamSubSet(*args, **kwargs)

enabled

class bestgui.paramset.BaseCfgMixIn

class bestgui.paramset.BaseParamSet(name, label='', widget=None, **kwargs)

Abstract base class for sets of parameters.

Derived classes should at least implement (and overwrite) the following methods: set_default, clear, set_from_cfg, update_cfg.

The ParamSet classes implementations should never make no assumption about the “widget” attribute but that it is a widget. If it is needed to reference some widget component for methods implemetation it is strongly suggested to bind that widget to a (pivate) attribute.

A ParamSet has at least the following attributes:

name – the ParamSet name label – a label for the PatamSet widget – the widget that encloses the ParamSet GUI

The “widget” attribute is used for packing the ParamSet into into the application GUI.

clear()

Clear all the objects in the ParamSet.

enabled

Tell whenever the ParamSet is enabled or not.

get_enabled()

load(inifilename, section=None)

save(inifilename)

set_default()

Set at the default value all the objects in the ParamSet.

set_enabled(sensitive)

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the ParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the ParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.BaseParamSetDecoration

Base class for ParamSet decoration.

This class and its derivates are designed to provide decorations (title, scroll-bars and so on) to ParamSet classes. It is thought to be used as MixIn class together with a ParamSet class and it expects that some attribures/methods like self.label, self.clear and self.set_default are defined. The user shoult inherit from both a ParamSet and one ParamSetContainer and use the addContainer method in the inizializer.

buttonbox()

Build a button-bar with the “Clean” and the “Default” buttons.

on_clear(widget=None)

Callback for the ParamSet “clear” method.

on_set_default(widget=None)

Callback for the ParamSet “set_default” method.

class bestgui.paramset.BaseSubSet

Decoration for base sub-set of parameters.

This class is designed to provide decorations to ParamSet classes. The decoration is a frame with a bold title. BaseSubSet is thought to be used as MixIn class together with a ParamSet class and it expects that some attribures/methods like self.label, self.clear and self.set_default are defined. The user shoult inherit from both a ParamSet and one ParamSetContainer and use the addContainer method in the inizializer.

class bestgui.paramset.CfgMultiParamSet(hmifile, name='', label=None, workdir=None)

class bestgui.paramset.CfgParamSet(hmifile, name='', label=None, workdir=None)

ParamSet defined from configuration file.

The format of the configuration file must be readable using the ConfigParser module.

class bestgui.paramset.CoRegistrationParamSet(workdir=None)

on_interp_mode_changed(widget=None, pset_index=None, par_index=None)

on_subset_toggled(widget, pset_index, par_index)

class bestgui.paramset.FullResolutionParamSet(workdir=None)

on_media_type_toggled(widget=None)

class bestgui.paramset.GCPSelectionForm

clear()

Clean all the objects in the ParamSet.

get_values()

on_combobox_changed(widget=None)

on_edit(widget=None)

set_default()

Set at the default value all the objects in the ParamSet.

set_values(values)

class bestgui.paramset.GCPSelectionParamSet(name='gcp_selection', label='GCP Selection')

clear()

Clean all the objects in the ParamSet.

enabled

get_enabed()

set_default()

Set at the default value all the objects in the ParamSet.

set_enabled(enabled)

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the AoIParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the AoIParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.HeaderAnalysisParamSet(workdir=None)

on_media_type_toggled(widget=None)

on_number_of_volumes_toggled(widget=None)

on_sensor_id_toggled(widget=None)

on_sensor_mode_toggled(widget=None)

update_cfg(cfg, section=None)

class bestgui.paramset.MainCfgMultiParamSet(*args, **kwargs)

class bestgui.paramset.MainCfgParamSet(*args, **kwargs)

class bestgui.paramset.MainSet

Decoration for main parameters sets.

This class is designed to provide decorations to ParamSet classes. The decoration is a frame with a centered title in bold large characters and scrollbars. MainSet is thought to be used as MixIn class together with a ParamSet class and it expects that some attribures/methods like self.label, self.clear and self.set_default are defined. The user shoult inherit from both a ParamSet and one ParamSetContainer and use the addContainer method in the inizializer.

class bestgui.paramset.OptAoIParamSet(*args, **kwargs)

enabled

class bestgui.paramset.OptSubSet

Decoration for optional sub-set of parameters.

This class is designed to provide decorations to ParamSet classes. The decoration is a frame with a bold title enclosed in an expander: the entire subset can be disanled by clicking on the expander arrow. OptSubSet is thought to be used as MixIn class together with a ParamSet class and it expects that some attribures/methods like self.label, self.clear and self.set_default are defined. The user shoult inherit from both a ParamSet and one ParamSetContainer and use the addContainer method in the inizializer.

enabled

get_enabled()

on_expand(widget=None)

set_enabled(enabled)

class bestgui.paramset.QuickLookParamSet(workdir=None)

on_media_type_toggled(widget=None)

class bestgui.paramset.StdMultiParamSet(paramsets, name, label='', workdir=None)

clear()

Clean all the objects in the ParamSet.

set_default()

Set at the default value all the objects in the ParamSet.

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the ParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the ParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.StdParamChkSubSet(*args, **kwargs)

enabled

class bestgui.paramset.StdParamSet(params, name, label='', widget=None, **kwargs)

Standard set of parameters.

StdParamSet implements the BaseParamSet interface. The “params” arrtibute is used to store the parameters. All parameters objects in “params” must be instances of BaseParam or BaseParamSet. The instatioation of parameter objects and packing into the container “widget” is left to the user.

clear()

Clear all the objects in the ParamSet.

set_default()

Set at the default value all the objects in the ParamSet.

set_from_cfg(cfg, section=None, errors_='strict')

Set the objects in the ParamSet getting the values from “cfg”.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

‘strict’ ‘warn’ ‘ignore’

update_cfg(cfg, section=None)

Update the “cfg” object setting the values from the ParamSet.

“cfg” must be a “ConfigParser” object (from the python standard library) and the section parameter is used to specify the configuration file section. If “section” is None then the “label” attribute is used as section specifierqualifier.

class bestgui.paramset.StdParamSubSet(*args, **kwargs)

class bestgui.paramset.SubSet

Decoration for sub-set of parameters.

This class is designed to provide decorations to ParamSet classes. The decoration is a frame with a bold title and a checkbutton that allows to disble the sub-set. SubSet is thought to be used as MixIn class together with a ParamSet class and it expects that some attribures/methods like self.label, self.clear and self.set_default are defined. The user shoult inherit from both a ParamSet and one ParamSetContainer and use the addContainer method in the inizializer.

enabled

get_enabled()

on_toggled(widget)

set_enabled(enabled)

bestgui.paramset.decorated_paramset(paramset_type, decoration_type=None, name=None)

Return a new ParamSet class with decorations.

Both the type of the ParamSet and decoration type are passed as parameters. If the “decoration_type” is None then the “paramset_type” is returned.

Example:

>>> newParamSet = decorated_paramset(StdParamSet, MainSet)