albumentations.core.transform_params

Invocation-local target metadata and structured transform parameters.

Members

classSampledParamsError
classTargetDescriptor
classTargetView
classTargetRequirement
classTargetParams
classTargetSet
classSampledParams
functionrequired_parameter_names
functionrequirements_for_views

SampledParamsErrorclass

SampledParamsError()

Raised when sampled parameters cannot be applied to an invocation.

TargetDescriptorclass

TargetDescriptor()

Representation metadata for one active target.

TargetViewclass

TargetView()

A borrowed target value and its invocation-local descriptor.

TargetRequirementclass

TargetRequirement()

Representation constraints required by a materialized target parameter.

TargetParamsclass

TargetParams()

Parameters for a named set of actual targets with compatible representations.

TargetSetclass

TargetSet(
    views: tuple[TargetView, ...]
)

Deterministically ordered active targets for one transform step.

Parameters

Name	Type	Default	Description
views	tuple[TargetView, ...]	-	-

SampledParamsclass

SampledParams()

Parameters and target-specific values sampled for one transform event.

required_parameter_namesfunction

required_parameter_names(
    function: Callable[..., Any]
)

Return required keyword parameters after the target value argument.

Parameters

Name	Type	Default	Description
function	Callable[..., Any]	-	-

requirements_for_viewsfunction

requirements_for_views(
    views: tuple[TargetView, ...],
    shape: bool = False,
    spatial_shape: bool = False,
    spatial_shape_suffix: bool = False,
    channels: bool = False,
    dtype: bool = False,
    value_scale: bool = False,
    layout: bool = False,
    sampling_topology: bool = False
)

Build replay constraints from a deterministic compatible target group.

Parameters

Name	Type	Default	Description
views	tuple[TargetView, ...]	-	-
shape	bool	False	-
spatial_shape	bool	False	-
spatial_shape_suffix	bool	False	-
channels	bool	False	-
dtype	bool	False	-
value_scale	bool	False	-
layout	bool	False	-
sampling_topology	bool	False	-