get_dl_transform_pipeline_paramT_get_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_param (Operator)
Name
get_dl_transform_pipeline_paramT_get_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_param — Retrieve parameter values for a given transform in the transform pipeline,
or for the transform pipeline itself.
Signature
void GetDlTransformPipelineParam(const HTuple& TransformPipeline, const HTuple& TransformName, const HTuple& ParamName, HTuple* ParamValue)
static HTuple HDlTransform::GetDlTransformPipelineParam(const HDlTransformPipeline& TransformPipeline, const HString& TransformName, const HString& ParamName)
static HTuple HDlTransform::GetDlTransformPipelineParam(const HDlTransformPipeline& TransformPipeline, const char* TransformName, const char* ParamName)
static HTuple HDlTransform::GetDlTransformPipelineParam(const HDlTransformPipeline& TransformPipeline, const wchar_t* TransformName, const wchar_t* ParamName)
(
Windows only)
HTuple HDlTransformPipeline::GetDlTransformPipelineParam(const HString& TransformName, const HString& ParamName) const
HTuple HDlTransformPipeline::GetDlTransformPipelineParam(const char* TransformName, const char* ParamName) const
HTuple HDlTransformPipeline::GetDlTransformPipelineParam(const wchar_t* TransformName, const wchar_t* ParamName) const
(
Windows only)
Description
The operator get_dl_transform_pipeline_paramget_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_param returns the value of
the parameter ParamNameParamNameParamNameparamNameparam_name in ParamValueParamValueParamValueparamValueparam_value for the transform
TransformNameTransformNameTransformNametransformNametransform_name in the transform pipeline TransformPipelineTransformPipelineTransformPipelinetransformPipelinetransform_pipeline.
The operator can also be used to return parameters of the transform pipeline
TransformPipelineTransformPipelineTransformPipelinetransformPipelinetransform_pipeline itself, if TransformNameTransformNameTransformNametransformNametransform_name is set to
''"""""""".
The transform names can be retrieved using
get_dl_transform_pipeline_paramget_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_param with the parameter
'transform_names'"transform_names""transform_names""transform_names""transform_names".
General parameters of a transform pipeline:
ParamNameParamNameParamNameparamNameparam_name |
set |
get |
|
'fill_value'"fill_value""fill_value""fill_value""fill_value" |
x |
x |
|
'num_additional_samples'"num_additional_samples""num_additional_samples""num_additional_samples""num_additional_samples" |
|
x |
|
'transform_names'"transform_names""transform_names""transform_names""transform_names" |
|
x |
|
'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction" |
x |
x |
|
'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" |
x |
x |
|
'bbox_min_side_length'"bbox_min_side_length""bbox_min_side_length""bbox_min_side_length""bbox_min_side_length" |
x |
x |
|
'instance_min_visibility'"instance_min_visibility""instance_min_visibility""instance_min_visibility""instance_min_visibility" |
x |
x
|
- 'fill_value'"fill_value""fill_value""fill_value""fill_value":
-
Value used to fill padded regions if required by the transforms.
Restriction:
Only values of type integer or float are allowed.
Default:
0.0
- 'num_additional_samples'"num_additional_samples""num_additional_samples""num_additional_samples""num_additional_samples":
-
Total number of additional samples required by all transforms in the
pipeline.
- 'transform_names'"transform_names""transform_names""transform_names""transform_names":
-
Names of the transforms contained in the pipeline.
- 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction":
-
Determines whether directions of oriented bounding boxes shall be
used ('false'"false""false""false""false") or ignored ('true'"true""true""true""true").
Only for transformation of samples for detection models of
'instance_type'"instance_type""instance_type""instance_type""instance_type" = 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2".
List of values:
'true'"true""true""true""true", 'false'"false""false""false""false"
Default:
'false'"false""false""false""false"
- 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation":
-
Array containing all class IDs that have no orientation,
e.g., round or other point symmetrical objects. The labels
are replaced by the smallest enclosing axis-aligned bounding boxes.
Only for transformation of samples for detection models of
'instance_type'"instance_type""instance_type""instance_type""instance_type" = 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2".
Default:
'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" = []
- 'bbox_min_side_length'"bbox_min_side_length""bbox_min_side_length""bbox_min_side_length""bbox_min_side_length":
-
Minimum allowed side length of a transformed box instance. Smaller
box instances are not transferred to output.
Default:
2
- 'instance_min_visibility'"instance_min_visibility""instance_min_visibility""instance_min_visibility""instance_min_visibility":
-
Minimum allowed visibility fraction of a transformed instance.
Instances with lower visibility are not transferred to output.
Default:
0.5
Parameters common to each transform:
ParamNameParamNameParamNameparamNameparam_name |
set |
get |
|
'name'"name""name""name""name" |
x |
x |
|
'num_additional_samples'"num_additional_samples""num_additional_samples""num_additional_samples""num_additional_samples" |
|
x |
|
'probability'"probability""probability""probability""probability" |
x |
x |
|
'type'"type""type""type""type" |
|
x
|
- 'name'"name""name""name""name":
-
Name of the transform.
- 'num_additional_samples'"num_additional_samples""num_additional_samples""num_additional_samples""num_additional_samples":
-
Number of additional samples required by the transform.
- 'probability'"probability""probability""probability""probability":
-
Probability with which the transform is executed.
Restriction:
Not settable for transforms of type
'resize'"resize""resize""resize""resize".
- 'type'"type""type""type""type":
Type of the transform.
The parameters that are gettable and settable for a specific transform are
described in the corresponding operator reference of the respective
transform (create_dl_transform_*).
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
TransformPipelineTransformPipelineTransformPipelinetransformPipelinetransform_pipeline (input_control) dl_transform_pipeline → HDlTransformPipeline, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Transform pipeline handle
TransformNameTransformNameTransformNametransformNametransform_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the target transform.
Default:
''
""
""
""
""
ParamNameParamNameParamNameparamNameparam_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the parameter to query.
Default:
'transform_names'
"transform_names"
"transform_names"
"transform_names"
"transform_names"
List of values:
'alignment'"alignment""alignment""alignment""alignment", 'bbox_min_side_length'"bbox_min_side_length""bbox_min_side_length""bbox_min_side_length""bbox_min_side_length", 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation", 'clip_size'"clip_size""clip_size""clip_size""clip_size", 'deviation'"deviation""deviation""deviation""deviation", 'direction'"direction""direction""direction""direction", 'fill_value'"fill_value""fill_value""fill_value""fill_value", 'height'"height""height""height""height", 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction", 'image_dimensions'"image_dimensions""image_dimensions""image_dimensions""image_dimensions", 'instance_min_visibility'"instance_min_visibility""instance_min_visibility""instance_min_visibility""instance_min_visibility", 'interpolation'"interpolation""interpolation""interpolation""interpolation", 'mean'"mean""mean""mean""mean", 'method'"method""method""method""method", 'name'"name""name""name""name", 'num_additional_samples'"num_additional_samples""num_additional_samples""num_additional_samples""num_additional_samples", 'probability'"probability""probability""probability""probability", 'range_h'"range_h""range_h""range_h""range_h", 'range_perspective'"range_perspective""range_perspective""range_perspective""range_perspective", 'range_rot'"range_rot""range_rot""range_rot""range_rot", 'range_s'"range_s""range_s""range_s""range_s", 'range_scale'"range_scale""range_scale""range_scale""range_scale", 'range_shear'"range_shear""range_shear""range_shear""range_shear", 'range_strength'"range_strength""range_strength""range_strength""range_strength", 'range_trans'"range_trans""range_trans""range_trans""range_trans", 'range_v'"range_v""range_v""range_v""range_v", 'transform_names'"transform_names""transform_names""transform_names""transform_names", 'type'"type""type""type""type", 'width'"width""width""width""width", 'zoom_type'"zoom_type""zoom_type""zoom_type""zoom_type"
ParamValueParamValueParamValueparamValueparam_value (output_control) tuple(-array) → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Value of the parameter.
Possible Predecessors
create_dl_transform_pipelinecreate_dl_transform_pipelineCreateDlTransformPipelineCreateDlTransformPipelinecreate_dl_transform_pipeline
See also
set_dl_transform_pipeline_paramset_dl_transform_pipeline_paramSetDlTransformPipelineParamSetDlTransformPipelineParamset_dl_transform_pipeline_param,
transform_dl_sample_batchtransform_dl_sample_batchTransformDlSampleBatchTransformDlSampleBatchtransform_dl_sample_batch
Module
Foundation