Skip to content

get_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_paramT_get_dl_transform_pipeline_param🔗

Short description🔗

get_dl_transform_pipeline_paramGetDlTransformPipelineParamGetDlTransformPipelineParamget_dl_transform_pipeline_paramT_get_dl_transform_pipeline_param — Retrieve parameter values for a given transform in the transform pipeline, or for the transform pipeline itself.

Signature🔗

get_dl_transform_pipeline_param( dl_transform_pipeline TransformPipeline, string TransformName, string ParamName, out tuple ParamValue )void GetDlTransformPipelineParam( const HTuple& TransformPipeline, const HTuple& TransformName, const HTuple& ParamName, HTuple* ParamValue )static void HOperatorSet.GetDlTransformPipelineParam( HTuple transformPipeline, HTuple transformName, HTuple paramName, out HTuple paramValue )def get_dl_transform_pipeline_param( transform_pipeline: HHandle, transform_name: str, param_name: str ) -> Sequence[Union[str, float, int]]

def get_dl_transform_pipeline_param_s( transform_pipeline: HHandle, transform_name: str, param_name: str ) -> Union[str, float, int]Herror T_get_dl_transform_pipeline_param( 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)

static HTuple HDlTransform.GetDlTransformPipelineParam( HDlTransformPipeline transformPipeline, string transformName, string paramName )

HTuple HDlTransformPipeline.GetDlTransformPipelineParam( string transformName, string paramName )

Description🔗

The operator get_dl_transform_pipeline_paramGetDlTransformPipelineParam returns the value of the parameter ParamNameparamNameparam_name in ParamValueparamValueparam_value for the transform TransformNametransformNametransform_name in the transform pipeline TransformPipelinetransformPipelinetransform_pipeline.

The operator can also be used to return parameters of the transform pipeline TransformPipelinetransformPipelinetransform_pipeline itself, if TransformNametransformNametransform_name is set to ''"".

The transform names can be retrieved using get_dl_transform_pipeline_paramGetDlTransformPipelineParam with the parameter 'transform_names'"transform_names".

General parameters of a transform pipeline:

ParamNameparamNameparam_name set get
'fill_value'"fill_value" x x
'num_additional_samples'"num_additional_samples" x
'transform_names'"transform_names" x
'ignore_direction'"ignore_direction" x x
'class_ids_no_orientation'"class_ids_no_orientation" x x
'bbox_min_side_length'"bbox_min_side_length" x x
'instance_min_visibility'"instance_min_visibility" x x
  • '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.00.0

  • 'num_additional_samples'"num_additional_samples": Total number of additional samples required by all transforms in the pipeline.

  • 'transform_names'"transform_names": Names of the transforms contained in the pipeline.

  • 'ignore_direction'"ignore_direction": Determines whether directions of oriented bounding boxes shall be used ('false'"false") or ignored ('true'"true"). Only for transformation of samples for detection models of 'instance_type'"instance_type" = 'rectangle2'"rectangle2".

    List of values: 'true'"true", 'false'"false"

    Default: 'false'"false"

  • '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" = 'rectangle2'"rectangle2".

    Default: 'class_ids_no_orientation'"class_ids_no_orientation" = [][]

  • '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: 22

  • '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.50.5

Parameters common to each transform:

ParamNameparamNameparam_name set get
'name'"name" x x
'num_additional_samples'"num_additional_samples" x
'probability'"probability" x x
'type'"type" x
  • 'name'"name": Name of the transform.

  • 'num_additional_samples'"num_additional_samples": Number of additional samples required by the transform.

  • 'probability'"probability": Probability with which the transform is executed.

    Restriction: Not settable for transforms of type 'resize'"resize".

  • '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🔗

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🔗

TransformPipelinetransformPipelinetransform_pipeline (input_control) dl_transform_pipeline → (handle)HTuple (HHandle)HDlTransformPipeline, HTuple (IntPtr)HHandleHtuple (handle)

Transform pipeline handle

TransformNametransformNametransform_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the target transform.

Default: ''""

ParamNameparamNameparam_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the parameter to query.

Default: 'transform_names'"transform_names"
List of values: 'alignment', 'bbox_min_side_length', 'class_ids_no_orientation', 'clip_size', 'deviation', 'direction', 'fill_value', 'height', 'ignore_direction', 'image_dimensions', 'instance_min_visibility', 'interpolation', 'mean', 'method', 'name', 'num_additional_samples', 'probability', 'range_h', 'range_perspective', 'range_rot', 'range_s', 'range_scale', 'range_shear', 'range_strength', 'range_trans', 'range_v', 'transform_names', 'type', 'width', 'zoom_type'"alignment", "bbox_min_side_length", "class_ids_no_orientation", "clip_size", "deviation", "direction", "fill_value", "height", "ignore_direction", "image_dimensions", "instance_min_visibility", "interpolation", "mean", "method", "name", "num_additional_samples", "probability", "range_h", "range_perspective", "range_rot", "range_s", "range_scale", "range_shear", "range_strength", "range_trans", "range_v", "transform_names", "type", "width", "zoom_type"

ParamValueparamValueparam_value (output_control) tuple(-array) → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)Sequence[Union[str, float, int]]Htuple (char* / double / Hlong)

Value of the parameter.

Combinations with other operators🔗

Combinations

Possible predecessors

create_dl_transform_pipelineCreateDlTransformPipeline

See also

set_dl_transform_pipeline_paramSetDlTransformPipelineParam, transform_dl_sample_batchTransformDlSampleBatch

Module🔗

Foundation