Short description
create_dl_transform_blurCreateDlTransformBlurCreateDlTransformBlurcreate_dl_transform_blurT_create_dl_transform_blur — Create a blur transform.
Signature
create_dl_transform_blur( string TransformName, real Probability, string Method, real RangeStrength, attribute.name GenParamName, attribute.value GenParamValue, out dl_transform Blur )void CreateDlTransformBlur( const HTuple& TransformName, const HTuple& Probability, const HTuple& Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* Blur )static void HOperatorSet.CreateDlTransformBlur( HTuple transformName, HTuple probability, HTuple method, HTuple rangeStrength, HTuple genParamName, HTuple genParamValue, out HTuple blur )def create_dl_transform_blur( transform_name: str, probability: float, method: str, range_strength: Sequence[float], gen_param_name: Sequence[str], gen_param_value: Sequence[Union[str, float, int]] ) -> HHandle
Herror T_create_dl_transform_blur( const Htuple TransformName, const Htuple Probability, const Htuple Method, const Htuple RangeStrength, const Htuple GenParamName, const Htuple GenParamValue, Htuple* Blur )
void HDlTransform::HDlTransform( const HString& TransformName, double Probability, const HString& Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue )
void HDlTransform::HDlTransform( const char* TransformName, double Probability, const char* Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue )
void HDlTransform::HDlTransform( const wchar_t* TransformName, double Probability, const wchar_t* Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue ) (Windows only)
public HDlTransform( string transformName, double probability, string method, HTuple rangeStrength, HTuple genParamName, HTuple genParamValue )
void HDlTransform::CreateDlTransformBlur( const HString& TransformName, double Probability, const HString& Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue )
void HDlTransform::CreateDlTransformBlur( const char* TransformName, double Probability, const char* Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue )
void HDlTransform::CreateDlTransformBlur( const wchar_t* TransformName, double Probability, const wchar_t* Method, const HTuple& RangeStrength, const HTuple& GenParamName, const HTuple& GenParamValue ) (Windows only)
void HDlTransform.CreateDlTransformBlur( string transformName, double probability, string method, HTuple rangeStrength, HTuple genParamName, HTuple genParamValue )
Description
The operator create_dl_transform_blurCreateDlTransformBlur creates a blur transform and
returns the transform handle in Blurblurblur.
The parameter TransformNametransformNametransform_name specifies a unique, non-empty name
for the transform. Note that when creating a transform pipeline using
create_dl_transform_pipelineCreateDlTransformPipeline, each transform within the pipeline
must have a unique name.
The parameter Probabilityprobabilityprobability specifies the probability with which the
transform is executed in the pipeline. The probability must be between
0.00.0 and 1.01.0. A value of 0.00.0 disables execution,
while a value of 1.01.0 guarantees that the operation is executed.
The parameter Methodmethodmethod defines the method used for the blur effect.
Currently, the method 'gaussian'"gaussian" is supported.
The parameter RangeStrengthrangeStrengthrange_strength defines the range for the strength of
the blur effect. The range is a tuple of the form
[range_min, range_max][range_min, range_max], where 'range_min'"range_min" and
'range_max'"range_max" must be between 0.00.0 and 10.010.0.
No generic parameters GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value are
supported for this transform. Only the value [][] can be set.
The following parameters are specific to the transforms of type
'blur'"blur". They can respectively be get or set using the
operators get_dl_transform_pipeline_paramGetDlTransformPipelineParam and
set_dl_transform_pipeline_paramSetDlTransformPipelineParam:
| ParamName |
set |
get |
| 'method'"method" |
x |
x |
| 'range_strength'"range_strength" |
x |
x |
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Automatically parallelized on internal data level.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
TransformNametransformNametransform_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)
Name of the output transform.
Default: 'blur'"blur"
Probabilityprobabilityprobability (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)
Probability to execute the transform
Default: 1.01.0
Methodmethodmethod (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)
The blur method to use
Default: 'gaussian'"gaussian"
RangeStrengthrangeStrengthrange_strength (input_control) real-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Tuple with range of strength values to draw from
Default: [1.0, 5.0][1.0, 5.0]
GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)
Generic input parameter names.
Default: [][]
GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)Sequence[Union[str, float, int]]Htuple (char* / double / Hlong)
Generic input parameter values.
Default: [][]
Blurblurblur (output_control) dl_transform → (handle)HTuple (HHandle)HDlTransform, HTuple (IntPtr)HHandleHtuple (handle)
Blur transform
Combinations with other operators
Combinations
Possible successors
create_dl_transform_pipelineCreateDlTransformPipeline
See also
create_dl_transform_normalizeCreateDlTransformNormalize, create_dl_transform_random_cropCreateDlTransformRandomCrop, create_dl_transform_random_hsvCreateDlTransformRandomHsv, create_dl_transform_resizeCreateDlTransformResize
Module
Foundation