create_dl_transform_random_hsvT_create_dl_transform_random_hsvCreateDlTransformRandomHsvCreateDlTransformRandomHsvcreate_dl_transform_random_hsv (Operator)

Name

create_dl_transform_random_hsvT_create_dl_transform_random_hsvCreateDlTransformRandomHsvCreateDlTransformRandomHsvcreate_dl_transform_random_hsv — Create a random HSV transform.

Signature

create_dl_transform_random_hsv( : : TransformName, Probability, RangeH, RangeS, RangeV, GenParamName, GenParamValue : RandomHSV)

Herror T_create_dl_transform_random_hsv(const Htuple TransformName, const Htuple Probability, const Htuple RangeH, const Htuple RangeS, const Htuple RangeV, const Htuple GenParamName, const Htuple GenParamValue, Htuple* RandomHSV)

void CreateDlTransformRandomHsv(const HTuple& TransformName, const HTuple& Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* RandomHSV)

void HDlTransform::HDlTransform(const HString& TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)

void HDlTransform::HDlTransform(const char* TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)

void HDlTransform::HDlTransform(const wchar_t* TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)   ( Windows only)

void HDlTransform::CreateDlTransformRandomHsv(const HString& TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)

void HDlTransform::CreateDlTransformRandomHsv(const char* TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)

void HDlTransform::CreateDlTransformRandomHsv(const wchar_t* TransformName, double Probability, const HTuple& RangeH, const HTuple& RangeS, const HTuple& RangeV, const HTuple& GenParamName, const HTuple& GenParamValue)   ( Windows only)

static void HOperatorSet.CreateDlTransformRandomHsv(HTuple transformName, HTuple probability, HTuple rangeH, HTuple rangeS, HTuple rangeV, HTuple genParamName, HTuple genParamValue, out HTuple randomHSV)

public HDlTransform(string transformName, double probability, HTuple rangeH, HTuple rangeS, HTuple rangeV, HTuple genParamName, HTuple genParamValue)

void HDlTransform.CreateDlTransformRandomHsv(string transformName, double probability, HTuple rangeH, HTuple rangeS, HTuple rangeV, HTuple genParamName, HTuple genParamValue)

def create_dl_transform_random_hsv(transform_name: str, probability: float, range_h: Sequence[float], range_s: Sequence[float], range_v: Sequence[float], gen_param_name: Sequence[str], gen_param_value: Sequence[Union[str, float, int]]) -> HHandle

Description

The operator create_dl_transform_random_hsvcreate_dl_transform_random_hsvCreateDlTransformRandomHsvCreateDlTransformRandomHsvcreate_dl_transform_random_hsv creates a random HSV transform and returns the transform handle in RandomHSVRandomHSVRandomHSVrandomHSVrandom_hsv. The transform performs a random shift of the hue, saturation, and value channels of the input image.

The parameter TransformNameTransformNameTransformNametransformNametransform_name specifies a unique, non-empty name for the transform. Note that when creating a transform pipeline using create_dl_transform_pipelinecreate_dl_transform_pipelineCreateDlTransformPipelineCreateDlTransformPipelinecreate_dl_transform_pipeline, each transform within the pipeline must have a unique name.

The parameter ProbabilityProbabilityProbabilityprobabilityprobability specifies the probability with which the transform is executed in the pipeline. The probability must be between 0.0 and 1.0. A value of 0.0 disables execution, while a value of 1.0 guarantees that the operation is executed.

The parameters RangeHRangeHRangeHrangeHrange_h, RangeSRangeSRangeSrangeSrange_s and RangeVRangeVRangeVrangeVrange_v define the ranges for the random shift on the hue, saturation and value channels of the input image. The ranges are tuples of the form [range_min, range_max], where 'range_min'"range_min""range_min""range_min""range_min" and 'range_max'"range_max""range_max""range_max""range_max" must be between -1.0 and 1.0.

No generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported for this transform. Only the value [] can be set.

The following parameters are specific to the transforms of type 'random_hsv'"random_hsv""random_hsv""random_hsv""random_hsv". They can respectively be get or set using the operators get_dl_transform_pipeline_paramget_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_param and set_dl_transform_pipeline_paramset_dl_transform_pipeline_paramSetDlTransformPipelineParamSetDlTransformPipelineParamset_dl_transform_pipeline_param:

ParamName set get
'range_h'"range_h""range_h""range_h""range_h" x x
'range_s'"range_s""range_s""range_s""range_s" x x
'range_v'"range_v""range_v""range_v""range_v" x x

Execution Information

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

TransformNameTransformNameTransformNametransformNametransform_name (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the output transform.

Default: 'random_hsv' "random_hsv" "random_hsv" "random_hsv" "random_hsv"

ProbabilityProbabilityProbabilityprobabilityprobability (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Probability to execute the transform

Default: 1.0

RangeHRangeHRangeHrangeHrange_h (input_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Tuple with random shift range for the hue channel

Default: [-0.5,0.5]

RangeSRangeSRangeSrangeSrange_s (input_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Tuple with random shift range for the saturation channel

Default: [-0.5,0.5]

RangeVRangeVRangeVrangeVrange_v (input_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Tuple with random shift range for the value channel

Default: [-0.5,0.5]

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Generic input parameter names.

Default: []

List of values: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value-array HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

Generic input parameter values.

Default: []

Suggested values: []

RandomHSVRandomHSVRandomHSVrandomHSVrandom_hsv (output_control)  dl_transform HDlTransform, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Random HSV transform

Possible Successors

create_dl_transform_pipelinecreate_dl_transform_pipelineCreateDlTransformPipelineCreateDlTransformPipelinecreate_dl_transform_pipeline

See also

create_dl_transform_blurcreate_dl_transform_blurCreateDlTransformBlurCreateDlTransformBlurcreate_dl_transform_blur, create_dl_transform_normalizecreate_dl_transform_normalizeCreateDlTransformNormalizeCreateDlTransformNormalizecreate_dl_transform_normalize, create_dl_transform_random_cropcreate_dl_transform_random_cropCreateDlTransformRandomCropCreateDlTransformRandomCropcreate_dl_transform_random_crop, create_dl_transform_resizecreate_dl_transform_resizeCreateDlTransformResizeCreateDlTransformResizecreate_dl_transform_resize

Module

Foundation