pyworkflow.protocol.params module¶
-
class
pyworkflow.protocol.params.
Conditional
(error, allowsNull=False)[source]¶ Bases:
pyworkflow.protocol.params.Validator
Simple validation based on a condition. If the value doesn’t meet the condition, the error will be returned.
-
class
pyworkflow.protocol.params.
DigFreqParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.FloatParam
Digital frequency param.
-
class
pyworkflow.protocol.params.
ElementGroup
(form=None, **args)[source]¶ Bases:
pyworkflow.protocol.params.FormElement
Class to group some params in the form. Such as: Labeled group or params in the same line.
-
class
pyworkflow.protocol.params.
EnumParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.IntParam
Select from a list of values, separated by comma
-
DISPLAY_COMBO
= 1¶
-
DISPLAY_HLIST
= 2¶
-
DISPLAY_LIST
= 0¶
-
-
class
pyworkflow.protocol.params.
FileParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.PathParam
Filename path
-
class
pyworkflow.protocol.params.
FolderParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.PathParam
Folder path
-
class
pyworkflow.protocol.params.
Form
(protocol)[source]¶ Bases:
object
Store all sections and parameters
-
class
pyworkflow.protocol.params.
FormElement
(**args)[source]¶ Bases:
pyworkflow.object.OrderedObject
Base for any element on the form
-
ATTRIBUTES
= ['label', 'expertLevel', 'condition', 'important', 'help', 'default', 'paramClass']¶
-
-
class
pyworkflow.protocol.params.
Format
(valueType, error='Value have not a correct format', allowsNull=False)[source]¶ Bases:
pyworkflow.protocol.params.Conditional
Check if the format is right.
-
class
pyworkflow.protocol.params.
GE
(thresold, error='Value should be greater or equal than the thresold')[source]¶
-
class
pyworkflow.protocol.params.
GT
(threshold, error='Value should be greater than the threshold')[source]¶
-
class
pyworkflow.protocol.params.
Group
(form=None, **args)[source]¶ Bases:
pyworkflow.protocol.params.ElementGroup
Group some parameters with a labeled frame.
-
class
pyworkflow.protocol.params.
LE
(threshold, error='Value should be less or equal than the threshold')[source]¶
-
class
pyworkflow.protocol.params.
LT
(threshold, error='Value should be less than the threshold')[source]¶
-
class
pyworkflow.protocol.params.
LabelParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
Just the same as StringParam, but to be rendered as a label and can not be directly edited by the user in the Protocol Form.
-
class
pyworkflow.protocol.params.
Line
(form=None, **args)[source]¶ Bases:
pyworkflow.protocol.params.ElementGroup
Group to put some parameters in the same line.
-
class
pyworkflow.protocol.params.
MultiPointerParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.PointerParam
This type of Param will serve to select objects with DIFFERENT types from the database to be input for some protocol.
-
class
pyworkflow.protocol.params.
NonEmptyBoolCondition
(error='Boolean param needs to be set.')[source]¶
-
class
pyworkflow.protocol.params.
NumericListParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
This class will serve to have list representations as strings. Possible notation are: 1000 10 1 1 -> to define a list with 4 values [1000, 10, 1, 1], or 10x2 5x3 -> to define a list with 5 values [10, 10, 5, 5, 5] If you ask for more elements than in the list, the last one is repeated
-
class
pyworkflow.protocol.params.
NumericListValidator
(error='Incorrect format for numeric list param. ')[source]¶ Bases:
pyworkflow.protocol.params.Conditional
Validator for ListParam. See ListParam.
-
class
pyworkflow.protocol.params.
NumericRangeParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
This class will serve to specify range of numbers with a string representation. Possible notation are:
“1,5-8,10” -> [1,5,6,7,8,10] “2,6,9-11” -> [2,6,9,10,11] “2 5, 6-8” -> [2,5,6,7,8]
-
class
pyworkflow.protocol.params.
Param
(**args)[source]¶ Bases:
pyworkflow.protocol.params.FormElement
Definition of a protocol parameter
-
class
pyworkflow.protocol.params.
PathParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
Param for path strings
-
class
pyworkflow.protocol.params.
PointerParam
(paramClass=<class 'pyworkflow.object.Pointer'>, **args)[source]¶ Bases:
pyworkflow.protocol.params.Param
This type of Param will serve to select existing objects in the database that will be input for some protocol.
-
class
pyworkflow.protocol.params.
RegexParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
Regex based string param
-
class
pyworkflow.protocol.params.
RelationParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.Param
This type of Param is very similar to PointerParam, since it will hold a pointer to another object. But, in the PointerParam, we search for objects of some Class (maybe with some conditions). Here, we search for objects related to a given attribute of a protocol by a given relation.
-
class
pyworkflow.protocol.params.
Section
(form, **args)[source]¶ Bases:
pyworkflow.protocol.params.ElementGroup
Definition of a section to hold other params
-
class
pyworkflow.protocol.params.
StringParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.Param
Param with underlying String value
-
class
pyworkflow.protocol.params.
TextParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.StringParam
Long string params
-
class
pyworkflow.protocol.params.
TupleParam
(**args)[source]¶ Bases:
pyworkflow.protocol.params.Param
This class will condense a tuple of several other params of the same type and related concenpt. For example: min and max, low and high.