openvino.preprocess.PreProcessSteps#

class openvino.preprocess.PreProcessSteps#

Bases: pybind11_object

openvino.runtime.preprocess.PreProcessSteps wraps ov::preprocess::PreProcessSteps

__init__(*args, **kwargs)#

Methods

__delattr__(name, /)

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

__ge__(value, /)

Return self>=value.

__getattribute__(name, /)

Return getattr(self, name).

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(*args, **kwargs)

__init_subclass__

This method is called when a class is subclassed.

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__new__(**kwargs)

__reduce__()

Helper for pickle.

__reduce_ex__(protocol, /)

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return str(self).

__subclasshook__

Abstract classes can override this to customize issubclass().

convert_color(self, dst_format)

convert_element_type(self[, type])

Converts input tensor element type to specified type.

convert_layout(*args, **kwargs)

Overloaded function.

crop(self, begin, end)

custom(self, operation)

Adds custom preprocessing operation.

mean(*args, **kwargs)

Overloaded function.

pad(*args, **kwargs)

Overloaded function.

resize(*args, **kwargs)

Overloaded function.

reverse_channels(self)

scale(*args, **kwargs)

Overloaded function.

__class__#

alias of pybind11_type

__delattr__(name, /)#

Implement delattr(self, name).

__dir__()#

Default dir() implementation.

__eq__(value, /)#

Return self==value.

__format__(format_spec, /)#

Default object formatter.

__ge__(value, /)#

Return self>=value.

__getattribute__(name, /)#

Return getattr(self, name).

__gt__(value, /)#

Return self>value.

__hash__()#

Return hash(self).

__init__(*args, **kwargs)#
__init_subclass__()#

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(value, /)#

Return self<=value.

__lt__(value, /)#

Return self<value.

__ne__(value, /)#

Return self!=value.

__new__(**kwargs)#
__reduce__()#

Helper for pickle.

__reduce_ex__(protocol, /)#

Helper for pickle.

__repr__()#

Return repr(self).

__setattr__(name, value, /)#

Implement setattr(self, name, value).

__sizeof__()#

Size of object in memory, in bytes.

__str__()#

Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

convert_color(self: openvino._pyopenvino.preprocess.PreProcessSteps, dst_format: ov::preprocess::ColorFormat) openvino._pyopenvino.preprocess.PreProcessSteps#
convert_element_type(self: openvino._pyopenvino.preprocess.PreProcessSteps, type: openvino._pyopenvino.Type = openvino.runtime.Type.undefined) openvino._pyopenvino.preprocess.PreProcessSteps#

Converts input tensor element type to specified type. Input tensor must have openvino.Type data type.

Parameters:

type (openvino.runtime.Type) – Destination type. If not specified, type will be taken from model input’s element type

Returns:

Reference to itself to allow chaining of calls in client’s code in a builder-like manner.

Return type:

openvino.runtime.preprocess.PreProcessSteps

convert_layout(*args, **kwargs)#

Overloaded function.

  1. convert_layout(self: openvino._pyopenvino.preprocess.PreProcessSteps, dst_layout: openvino._pyopenvino.Layout) -> openvino._pyopenvino.preprocess.PreProcessSteps

  2. convert_layout(self: openvino._pyopenvino.preprocess.PreProcessSteps, dims: list[int]) -> openvino._pyopenvino.preprocess.PreProcessSteps

crop(self: openvino._pyopenvino.preprocess.PreProcessSteps, begin: list[int], end: list[int]) openvino._pyopenvino.preprocess.PreProcessSteps#
custom(self: openvino._pyopenvino.preprocess.PreProcessSteps, operation: Callable) openvino._pyopenvino.preprocess.PreProcessSteps#

Adds custom preprocessing operation.

Parameters:

operation (function) – Python’s function which takes openvino.runtime.Output as input argument and returns`openvino.runtime.Output`.

Returns:

Reference to itself, allows chaining of calls in client’s code in a builder-like manner.

Return type:

openvino.runtime.preprocess.PreProcessSteps

mean(*args, **kwargs)#

Overloaded function.

  1. mean(self: openvino._pyopenvino.preprocess.PreProcessSteps, value: float) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Subtracts single float value from each element in input tensor. Input tensor must have ov.Type.f32 data type.

    param value:

    Value to subtract.

    type value:

    float

    return:

    Reference to itself to allow chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.runtime.preprocess.PreProcessSteps

  2. mean(self: openvino._pyopenvino.preprocess.PreProcessSteps, values: list[float]) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Subtracts a given single float value from each element in a given channel from input tensor. Input tensor must have ov.Type.f32 data type.

    param values:

    Values to subtract.

    type values:

    List[float]

    return:

    Reference to itself to allow chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.runtime.preprocess.PreProcessSteps

pad(*args, **kwargs)#

Overloaded function.

  1. pad(self: openvino._pyopenvino.preprocess.PreProcessSteps, pads_begin: list[int], pads_end: list[int], value: float, mode: ov::op::PadMode) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Adds padding preprocessing operation.

    param pads_begin:

    Number of elements matches the number of indices in data attribute. Specifies the number of padding elements at the ending of each axis.

    type pads_begin:

    1D tensor of type T_INT.

    param pads_end:

    Number of elements matches the number of indices in data attribute. Specifies the number of padding elements at the ending of each axis.

    type pads_end:

    1D tensor of type T_INT.

    param value:

    All new elements are populated with this value or with 0 if input not provided. Shouldn’t be set for other pad_mode values.

    type value:

    scalar tensor of type T.

    param mode:

    pad_mode specifies the method used to generate new element values.

    type mode:

    string

    return:

    Reference to itself, allows chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.preprocess.PreProcessSteps

  2. pad(self: openvino._pyopenvino.preprocess.PreProcessSteps, pads_begin: list[int], pads_end: list[int], value: list[float], mode: ov::op::PadMode) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Adds padding preprocessing operation.

    param pads_begin:

    Number of elements matches the number of indices in data attribute. Specifies the number of padding elements at the ending of each axis.

    type pads_begin:

    1D tensor of type T_INT.

    param pads_end:

    Number of elements matches the number of indices in data attribute. Specifies the number of padding elements at the ending of each axis.

    type pads_end:

    1D tensor of type T_INT.

    param value:

    All new elements are populated with this value or with 0 if input not provided. Shouldn’t be set for other pad_mode values.

    type value:

    scalar tensor of type T.

    param mode:

    pad_mode specifies the method used to generate new element values.

    type mode:

    string

    return:

    Reference to itself, allows chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.runtime.PreProcessSteps

resize(*args, **kwargs)#

Overloaded function.

  1. resize(self: openvino._pyopenvino.preprocess.PreProcessSteps, alg: ov::preprocess::ResizeAlgorithm, dst_height: int, dst_width: int) -> openvino._pyopenvino.preprocess.PreProcessSteps

  2. resize(self: openvino._pyopenvino.preprocess.PreProcessSteps, alg: ov::preprocess::ResizeAlgorithm) -> openvino._pyopenvino.preprocess.PreProcessSteps

reverse_channels(self: openvino._pyopenvino.preprocess.PreProcessSteps) openvino._pyopenvino.preprocess.PreProcessSteps#
scale(*args, **kwargs)#

Overloaded function.

  1. scale(self: openvino._pyopenvino.preprocess.PreProcessSteps, value: float) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Divides each element in input tensor by specified constant float value. Input tensor must have ov.Type.f32 data type.

    param value:

    Value used in division.

    type value:

    float

    return:

    Reference to itself to allow chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.runtime.preprocess.PreProcessSteps

  2. scale(self: openvino._pyopenvino.preprocess.PreProcessSteps, values: list[float]) -> openvino._pyopenvino.preprocess.PreProcessSteps

    Divides each element in a given channel from input tensor by a given single float value. Input tensor must have ov.Type.f32 data type.

    param values:

    Values which are used in division.

    type values:

    List[float]

    return:

    Reference to itself to allow chaining of calls in client’s code in a builder-like manner.

    rtype:

    openvino.runtime.preprocess.PreProcessSteps