forked from mindspore-Ecosystem/mindspore
add part of vision api doc
This commit is contained in:
ms_yan
parent
6c301b6e1f
commit
90f665726a
|
|
@ -0,0 +1,10 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomResizeWithBBox
|
||||
==========================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomResizeWithBBox(size)
|
||||
|
||||
使用随机选择的插值模式来调整输入图像的大小，并相应地调整边界框的大小。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 调整后图像的输出大小。如果 `size` 是一个整数，图像的短边将被调整为`size`大小，并依据短边的调整比例相应调整图像长边的大小。如果 `size` 是一个长度为2的序列，其输入格式应该为 (height, width)。
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomResizedCrop
|
||||
=======================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomResizedCrop(size, scale=(0.08, 1.0), ratio=(3. / 4., 4. / 3.), interpolation=Inter.BILINEAR, max_attempts=10)
|
||||
|
||||
对输入图像进行随机裁剪，并使用指定的插值模式调整裁剪后的图像为指定的大小。
|
||||
|
||||
.. note:: 如果输入图像不止一张，需要保证输入的多张图像大小一致。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 图像的输出大小。 如果 `size` 是整数，则返回大小为 (size, size) 的正方形图像。 如果 `size` 是一个长度为2的序列，其输入格式应该为 (height, width)。
|
||||
- **scale** (list, tuple, optional) - 裁剪子图的大小相对原图比例的随机选取范围，需要在[min, max)区间，默认值：(0.08, 1.0)。
|
||||
- **ratio** (list, tuple, optional) - 裁剪子图的宽高比的随机选取范围，需要在[min, max)区间，默认值：(3./4., 4./3.)。
|
||||
- **interpolation** (Inter mode, optional) - 调整大小采用的的图像插值模式。它可以是 [Inter.BILINEAR, Inter.NEAREST, Inter.BICUBIC, Inter.PILCUBIC] 中的任何一个，默认值：Inter.BILINEAR。
|
||||
|
||||
- Inter.BILINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
- Inter.AREA，像素区域插值。
|
||||
- Inter.PILCUBIC，与 `pillow` 中实现的双三次插值效果一致，输入应为3通道格式。
|
||||
|
||||
- **max_attempts** (int, optional): 生成随机裁剪位置的最大尝试次数，超过该次数时将使用中心裁剪，默认值：10。
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomResizedCropWithBBox
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomResizedCropWithBBox(size, scale=(0.08, 1.0), ratio=(3. / 4., 4. / 3.), interpolation=Inter.BILINEAR, max_attempts=10)
|
||||
|
||||
对输入图像进行随机裁剪且随机调整纵横比，并将处理后的图像调整为指定的大小，并相应地调整边界框。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 图像的输出大小。 如果 `size` 是整数，则返回大小为 (size, size) 的正方形图像。 如果 `size` 是一个长度为2的序列，其输入格式应该为 (height, width)。
|
||||
- **scale** (list, tuple, optional) - 裁剪子图的大小相对原图比例的随机选取范围，需要在[min, max)区间，默认值：(0.08, 1.0)。
|
||||
- **ratio** (list, tuple, optional) - 裁剪子图的宽高比的随机选取范围，需要在[min, max)区间，默认值：(3./4., 4./3.)。
|
||||
- **interpolation** (Inter, optional) - 调整大小采用的的图像插值模式。它可以是 [Inter.BILINEAR, Inter.NEAREST, Inter.BICUBIC] 中的任何一个，默认值：Inter.BILINEAR。
|
||||
|
||||
- Inter.BILINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
|
||||
- **max_attempts** (int, optional): 生成随机裁剪位置的最大尝试次数，超过该次数时将使用中心裁剪，默认值：10。
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomRotation
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomRotation(degrees, resample=Inter.NEAREST, expand=False, center=None, fill_value=0)
|
||||
|
||||
在指定的角度范围内，随机旋转输入图像。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **degrees** (Union[int, float, sequence]) - 旋转角度的随机选取范围。若输入单个数字，则从(-degrees, degrees)中随机生成旋转角度；若输入2元素序列，需按(min, max)顺序排列。
|
||||
- **resample** (Inter mode, optional) - 插值方式。 它可以是 [Inter.BILINEAR, Inter.NEAREST, Inter.BICUBIC] 中的任何一个，默认值：Inter.NEAREST。
|
||||
|
||||
- Inter.BILINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
|
||||
- **expand** (bool, optional) - 图像大小拓宽标志，若为True，将扩展图像大小使其足以容纳整个旋转图像；若为False或未指定，则保持输出图像与输入图像大小一致。请注意，扩展时将假设图像为中心旋转且未进行平移，默认值：False。
|
||||
- **center** (tuple, optional) - 可选的旋转中心，以图像左上角为原点，旋转中心的位置按照 (width, height) 格式指定。默认值：None，表示中心旋转。
|
||||
- **fill_value** (Union[int, tuple], optional) - 旋转图像之外区域的像素填充值。若输入3元素元组，将分别用于填充R、G、B通道；若输入整型，将以该值填充RGB通道。 `fill_value` 值必须在 [0, 255] 范围内，默认值：0。
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomSelectSubpolicy
|
||||
===========================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomSelectSubpolicy(policy)
|
||||
|
||||
从策略列表中选择一个随机子策略以应用于输入图像。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **policy** (list(list(tuple(TensorOp, prob (float))))) - 可供选择的子策略列表。 子策略是一系列 (op, prob) 格式的元组组成的列表，其中 `op` 是针对 Tensor 的操作， `prob` 是应用此操作的概率， `prob` 值必须在 [0, 1] 范围内。 一旦选择了子策略，子策略中的每个操作都将根据其概率依次应用。
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomSharpness
|
||||
=====================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomSharpness(degrees=(0.1, 1.9))
|
||||
|
||||
在给定的范围随机内地调整输入图像的锐度。调节系数为0.0时将返回模糊图像；调节系数为1.0时将返回原始图像；调节系数为2.0时将返回锐化图像。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **degrees** (Union[list, tuple], optional) - 锐度调节系数的随机选取范围，按照(min, max)顺序排列。如果 min=max，那么它是一个单一的固定锐度调整操作，默认值：(0.1, 1.9)。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 如果 `degree` 不是列表或元组。
|
||||
- **ValueError** - 如果 `degree` 为负数。
|
||||
- **ValueError** - 如果 `degree` 采用 (max, min) 格式而不是 (min, max)。
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomSolarize
|
||||
====================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomSolarize(threshold=(0, 255))
|
||||
|
||||
从给定阈值范围内随机选择一个子范围，并对像素值位于给定子范围内的像素，将其值设置为（255 - 原本像素值）。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **threshold** (tuple, optional) - 随机曝光的阈值范围，默认值：（0, 255）。`threshold` 输入格式应该为 (min, max)，其中 `min` 和 `max` 是 (0, 255) 范围内的整数，并且 min <= max。 如果 min=max，则反转所有高于 min(或max) 的像素值。
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomVerticalFlip
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomVerticalFlip(prob=0.5)
|
||||
|
||||
以给定的概率对输入图像在垂直方向进行随机翻转。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **prob** (float, optional) - 图像被翻转的概率，默认值：0.5。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 如果 `prob` 不是float类型。
|
||||
- **ValueError** - 如果 `prob` 不在 [0, 1] 范围。
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或 <H, W, C> 格式。
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
mindspore.dataset.vision.c_transforms.RandomVerticalFlipWithBBox
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.RandomVerticalFlipWithBBox(prob=0.5)
|
||||
|
||||
以给定的概率对输入图像和边界框在垂直方向进行随机翻转。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **prob** (float, optional) - 图像被翻转的概率，默认值：0.5。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 如果 `prob` 不是float类型。
|
||||
- **ValueError** - 如果 `prob` 不在 [0, 1] 范围。
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或<H, W, C> 格式。
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
mindspore.dataset.vision.c_transforms.Rescale
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.Rescale(rescale, shift)
|
||||
|
||||
基于给定的缩放和平移因子调整图像的大小。输出图像的大小为：output = image * rescale + shift。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **rescale** (float) - 缩放因子。
|
||||
- **shift** (float) - 平移因子。
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
mindspore.dataset.vision.c_transforms.Resize
|
||||
============================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.Resize(size, interpolation=Inter.LINEAR)
|
||||
|
||||
使用给定的插值模式将输入图像调整为给定的大小。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 图像的输出大小。如果 `size` 是整数，将调整图像的较短边长度为 `size`，且保持图像的宽高比不变；若输入是2元素组成的序列，其输入格式需要是 (height, width) 。
|
||||
- **interpolation** (Inter mode, optional) - 图像插值模式。它可以是 [Inter.LINEAR, Inter.NEAREST, Inter.BICUBIC, Inter.PILCUBIC] 中的任何一个，默认值：Inter.LINEAR。
|
||||
|
||||
- Inter.LINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
- Inter.AREA，像素区域插值。
|
||||
- Inter.PILCUBIC，与 `pillow` 中实现的双三次插值效果一致，输入应为3通道格式。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `size` 的类型不为整型或整型序列。
|
||||
- **TypeError** - 当 `interpolation` 的类型不为 :class:`Inter` 。
|
||||
- **ValueError** - 当 `size` 不为正数。
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或 <H, W, C> 格式。
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
mindspore.dataset.vision.c_transforms.ResizeWithBBox
|
||||
====================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.ResizeWithBBox(size, interpolation=Inter.LINEAR)
|
||||
|
||||
将输入图像调整为给定的大小并相应地调整边界框的大小。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 图像的输出大小。如果 `size` 是整数，将调整图像的较短边长度为 `size`，且保持图像的宽高比不变；若输入是2元素组成的序列，其输入格式需要是 (height, width) 。
|
||||
- **interpolation** (Inter mode, optional) - 图像插值模式。它可以是 [Inter.LINEAR, Inter.NEAREST, Inter.BICUBIC, Inter.PILCUBIC] 中的任何一个，默认值：Inter.LINEAR。
|
||||
|
||||
- Inter.LINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `size` 的类型不为整型或整型序列。
|
||||
- **TypeError** - 当 `interpolation` 的类型不为 :class:`Inter` 。
|
||||
- **ValueError** - 当 `size` 不为正数。
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或 <H, W, C> 格式。
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
mindspore.dataset.vision.c_transforms.Rotate
|
||||
============================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.Rotate(degrees, resample=Inter.NEAREST, expand=False, center=None, fill_value=0)
|
||||
|
||||
将输入图像旋转指定的度数。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **degrees** (Union[int, float]) - 旋转角度。
|
||||
- **resample** (Inter mode, optional) - 插值方式。 它可以是 [Inter.BILINEAR, Inter.NEAREST, Inter.BICUBIC] 中的任何一个，默认值：Inter.NEAREST。
|
||||
|
||||
- Inter.BILINEAR，双线性插值。
|
||||
- Inter.NEAREST，最近邻插值。
|
||||
- Inter.BICUBIC，双三次插值。
|
||||
|
||||
- **expand** (bool, optional) - 图像大小拓宽标志，若为True，将扩展图像大小使其足以容纳整个旋转图像；若为False或未指定，则保持输出图像与输入图像大小一致。请注意，扩展时将假设图像为中心旋转且未进行平移，默认值：False。
|
||||
- **center** (tuple, optional) - 可选的旋转中心，以图像左上角为原点，旋转中心的位置按照 (width, height) 格式指定。默认值：None，表示中心旋转。
|
||||
- **fill_value** (Union[int, tuple], optional) - 旋转图像之外区域的像素填充值。若输入3元素元组，将分别用于填充R、G、B通道；若输入整型，将以该值填充RGB通道。 `fill_value` 值必须在 [0, 255] 范围内，默认值：0。
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
mindspore.dataset.vision.c_transforms.SlicePatches
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.SlicePatches(num_height=1, num_width=1, slice_mode=SliceMode.PAD, fill_value=0)
|
||||
|
||||
在水平和垂直方向上将Tensor切片为多个块。适合于Tensor高宽较大的使用场景。如果将 `num_height` 和 `num_width` 都设置为 1，则Tensor将保持不变。输出Tensor的数量等于 num_height*num_width。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **num_height** (int, optional) - 垂直方向的切块数量，默认值：1。
|
||||
- **num_width** (int, optional) - 水平方向的切块数量，默认值：1。
|
||||
- **slice_mode** (Inter mode, optional) - 表示填充或丢弃，它可以是 [SliceMode.PAD, SliceMode.DROP] 中的任何一个，默认值：SliceMode.PAD。
|
||||
- **fill_value** (int, optional) - 如果 `slice_mode` 取值为 SliceMode.PAD，该值表示在右侧和底部方向上的填充的边界宽度（以像素数计），默认值：0。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `num_height` 不是整型。
|
||||
- **TypeError** - 当 `num_width` 不是整型。
|
||||
- **TypeError** - 当 `slice_mode` 不是整型。
|
||||
- **TypeError** - 当 `fill_value` 不是整型。
|
||||
- **ValueError** - 当 `num_height` 不为正数。
|
||||
- **ValueError** - 当 `num_width` 不为正数。
|
||||
- **ValueError** - 当 `fill_value` 不在 [0, 255]范围内。
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或<H, W, C> 格式。
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
mindspore.dataset.vision.c_transforms.SoftDvppDecodeRandomCropResizeJpeg
|
||||
========================================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.SoftDvppDecodeRandomCropResizeJpeg(size, scale=(0.08, 1.0), ratio=(3. / 4., 4. / 3.), max_attempts=10)
|
||||
|
||||
使用Ascend系列芯片DVPP模块的模拟算法组合了 `Crop` 、 `Decode` 和 `Resize` 。
|
||||
使用场景与数据增强算子 `SoftDvppDecodeResizeJpeg` 一致。 输入图像大小应在 [32*32, 8192*8192] 范围内。图像长度和宽度的缩小和放大倍数应在 [1/32, 16] 范围内。使用该算子只能输出具有均匀分辨率的图像，不支持奇数分辨率的输出。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size** (Union[int, sequence]) - 输出图像的大小。如果 `size` 是整数，则返回大小为 (size, size) 的正方形图像。 如果 `size` 是一个长度为2的序列，其输入格式应该为 (height, width)。
|
||||
- **scale** (list, tuple, optional) - 裁剪子图的大小相对原图比例的随机选取范围，需要在[min, max)区间，默认值：(0.08, 1.0)。
|
||||
- **ratio** (list, tuple, optional) - 裁剪子图的宽高比的随机选取范围，需要在[min, max)区间，默认值：(3./4., 4./3.)。
|
||||
- **max_attempts** (int, optional) - 生成随机裁剪位置的最大尝试次数，超过该次数时将使用中心裁剪，默认值：10。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `size` 不是整型或不是整型序列。
|
||||
- **TypeError** - 当 `scale` 不是元组类型。
|
||||
- **TypeError** - 当 `ratio` 不是元组类型。
|
||||
- **TypeError** - 当 `max_attempts` 不是整型。
|
||||
- **ValueError** - 当 `size` 不为正数。
|
||||
- **ValueError** - 当 `scale` 是负数。
|
||||
- **ValueError** - 当 `ratio` 是负数。
|
||||
- **ValueError** - 当 `max_attempts` 不为正数。
|
||||
- **RuntimeError** - 如果输入的Tensor不是一个一维序列。
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
mindspore.dataset.vision.c_transforms.SoftDvppDecodeResizeJpeg
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.SoftDvppDecodeResizeJpeg(size)
|
||||
|
||||
使用Ascend系列芯片DVPP模块的仿真算法对JPEG图像进行解码和缩放。
|
||||
|
||||
建议在以下场景使用该算法：训练时不使用Ascend芯片的DVPP模块，推理时使用Ascend芯片的DVPP模块，推理的准确率低于训练的准确率； 并且输入图像大小应在 [32*32, 8192*8192] 范围内。 图像长度和宽度的缩小和放大倍数应在 [1/32, 16] 范围内。使用该算子只能输出具有均匀分辨率的图像，不支持奇数分辨率的输出。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **size (Union[int, sequence]) - 图像的输出大小。如果 `size` 是整数，将调整图像的较短边长度为 `size`，且保持图像的宽高比不变；若输入是2元素组成的序列，其输入格式需要是 (height, width) 。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `size` 不是整型或不是整型序列。
|
||||
- **ValueError** - 当 `size` 不为正数。
|
||||
- **RuntimeError** - 如果输入的Tensor不是一个一维序列。
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
mindspore.dataset.vision.c_transforms.UniformAugment
|
||||
====================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.UniformAugment(transforms, num_ops=2)
|
||||
|
||||
对输入图像执行随机选取的数据增强操作。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **transforms** - C++ 操作列表（不接受Python操作）。
|
||||
- **num_ops** (int, optional) - 要选择和执行的操作数量，默认值：2。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **TypeError** - 当 `transforms` 包含不可调用的Python对象。
|
||||
- **TypeError** - 当 `num_ops` 不是整数。
|
||||
- **ValueError** - 当 `num_ops` 不为正数。
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
mindspore.dataset.vision.c_transforms.VerticalFlip
|
||||
=================================================
|
||||
|
||||
.. py:class:: mindspore.dataset.vision.c_transforms.VerticalFlip
|
||||
|
||||
对输入图像进行垂直翻转。
|
||||
|
||||
**异常：**
|
||||
|
||||
- **RuntimeError** - 如果输入的Tensor不是 <H, W> 或 <H, W, C> 格式。
|
||||
|
|
@ -1627,8 +1627,7 @@ class RandomPosterize(ImageTensorOperation):
|
|||
|
||||
class RandomResizedCrop(ImageTensorOperation):
|
||||
"""
|
||||
Crop the input image to a random size and aspect ratio. This operator will crop the input image randomly, and
|
||||
resize the cropped image using a selected interpolation mode.
|
||||
This operator will crop the input image randomly, and resize the cropped image using a selected interpolation mode.
|
||||
|
||||
Note:
|
||||
If the input image is more than one, then make sure that the image size is the same.
|
||||
|
|
|
|||
Loading…
Reference in New Issue