参考资料 ultralytics/models/sam/predict.py
备注
该文件可在https://github.com/ultralytics/ultralytics/blob/main/ ultralytics/models/ sam/predict .py。如果您发现问题,请通过提交 Pull Request🛠️ 帮助修复。谢谢🙏!
ultralytics.models.sam.predict.Predictor
用于 Segment Anything Model (SAM) 的 Predictor 类,扩展了 BasePredictor。
该类提供了一个针对图像分割任务的模型推理接口。 它具有先进的架构和可提示的分割功能,便于灵活、实时地 生成掩码。该类能够处理各种类型的提示,如边界框、点和低分辨率遮罩、 点和低分辨率掩码。
属性
名称 | 类型 | 说明 |
---|---|---|
cfg |
dict
|
配置字典指定模型和任务相关参数。 |
overrides |
dict
|
包含可覆盖默认配置的值的字典。 |
_callbacks |
dict
|
用户定义的回调函数字典,用于增强行为。 |
args |
namespace
|
用于存放命令行参数或其他操作变量的命名空间。 |
im |
Tensor
|
预处理后的输入图像tensor. |
features |
Tensor
|
提取的图像特征用于推理。 |
prompts |
dict
|
各种提示类型(如边界框和点)的集合。 |
segment_all |
bool
|
标记,用于控制是分割图像中的所有对象,还是只分割指定的对象。 |
源代码 ultralytics/models/sam/predict.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
__init__(cfg=DEFAULT_CFG, overrides=None, _callbacks=None)
使用配置、重载和回调初始化 Predictor。
该方法设置 Predictor 对象,并应用提供的任何配置重载或回调。该方法 初始化SAM 的特定任务设置,例如将 retina_masks 设置为 True 以获得最佳效果。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
cfg |
dict
|
配置字典。 |
DEFAULT_CFG
|
overrides |
dict
|
用于覆盖默认配置的数值字典。 |
None
|
_callbacks |
dict
|
用于自定义行为的回调函数字典。 |
None
|
源代码 ultralytics/models/sam/predict.py
generate(im, crop_n_layers=0, crop_overlap_ratio=512 / 1500, crop_downscale_factor=1, point_grids=None, points_stride=32, points_batch_size=64, conf_thres=0.88, stability_score_thresh=0.95, stability_score_offset=0.95, crop_nms_thresh=0.7)
使用 Segment Anything Model (SAM) 进行图像分割。
该功能通过利用SAM 的先进架构和实时性能功能,将整个图像分割成不同部分。 先进的架构和实时性能。它还可以选择对图像进行裁剪,以实现更精细的分割。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
im |
Tensor
|
输入tensor ,表示尺寸为(N、C、H、W)的预处理图像。 |
所需 |
crop_n_layers |
int
|
指定图像裁剪附加遮罩预测的层数。 每层生成 2**i_ 层数的图像裁剪。 |
0
|
crop_overlap_ratio |
float
|
确定作物之间的重叠度。在后续图层中按比例缩小。 |
512 / 1500
|
crop_downscale_factor |
int
|
每层每边采样点数的缩放因子。 |
1
|
point_grids |
list[ndarray]
|
用于点采样的自定义网格,归一化为 [0,1]。 用于第 n 个作物层。 |
None
|
points_stride |
int
|
沿图像每边采样的点数。 与 "point_grids "排他。 |
32
|
points_batch_size |
int
|
同时处理的点数的批量大小。 |
64
|
conf_thres |
float
|
可信度阈值 [0,1],用于根据模型的掩膜质量预测进行过滤。 |
0.88
|
stability_score_thresh |
float
|
基于掩膜稳定性的掩膜过滤稳定性阈值 [0,1]。 |
0.95
|
stability_score_offset |
float
|
计算稳定性得分的偏移值。 |
0.95
|
crop_nms_thresh |
float
|
用于 NMS 的 IoU 截止值,以去除作物间的重复掩膜。 |
0.7
|
返回:
类型 | 说明 |
---|---|
tuple
|
包含分段掩码、置信度得分和边界框的元组。 |
源代码 ultralytics/models/sam/predict.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
|
inference(im, bboxes=None, points=None, labels=None, masks=None, multimask_output=False, *args, **kwargs)
根据给定的输入线索,使用当前加载的图像执行图像分割推理。这种 该方法利用SAM (分割任何模型)架构,包括图像编码器、提示编码器和掩码解码器。 掩码解码器组成的架构,用于实时和可提示的分割任务。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
im |
Tensor
|
经过预处理的输入图像,格式为tensor ,形状为(N、C、H、W)。 |
所需 |
bboxes |
ndarray | List
|
形状为 (N, 4) 的边界框,格式为 XYXY。 |
None
|
points |
ndarray | List
|
表示物体位置的点,形状为 (N,2),单位为像素。 |
None
|
labels |
ndarray | List
|
点提示的标签,形状 (N,)。1 = 前景,0 = 背景。 |
None
|
masks |
ndarray
|
先前预测形状(N、H、W)的低分辨率掩码。SAM H=W=256。 |
None
|
multimask_output |
bool
|
返回多个掩码的标记。对于模棱两可的提示很有帮助。 |
False
|
返回:
类型 | 说明 |
---|---|
tuple
|
包含以下三个元素 - np.ndarray:形状为 CxHxW 的输出掩码,其中 C 是生成的掩码数。 - np.ndarray:长度为 C 的数组,包含模型为每个掩码预测的质量分数。 - np.ndarray:用于后续推理的 CxHxW 形的低分辨率对数,其中 H=W=256. |
源代码 ultralytics/models/sam/predict.py
postprocess(preds, img, orig_imgs)
对SAM 的推理输出进行后处理,生成物体检测掩码和边界框。
该方法根据原始图像大小缩放掩码和方框,并对掩码预测应用阈值。 SAM 模型采用先进的架构和可提示的分割任务来实现实时性能。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
preds |
tuple
|
SAM 模型推理的输出结果,包含掩码、分数和可选的边界框。 |
所需 |
img |
Tensor
|
经过处理的输入图像tensor 。 |
所需 |
orig_imgs |
list | Tensor
|
未经处理的原始图像。 |
所需 |
返回:
类型 | 说明 |
---|---|
list
|
包含检测掩码、边界框和其他元数据的结果对象列表。 |
源代码 ultralytics/models/sam/predict.py
pre_transform(im)
对输入图像进行初始变换,以便进行预处理。
该方法应用变换(如调整大小),为进一步预处理图像做好准备。 目前不支持分批推理,因此列表长度应为 1。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
im |
List[ndarray]
|
包含 HWC numpy 数组格式图像的列表。 |
所需 |
返回:
类型 | 说明 |
---|---|
List[ndarray]
|
转换图像列表。 |
源代码 ultralytics/models/sam/predict.py
preprocess(im)
对输入图像进行预处理,以便进行模型推理。
该方法通过应用变换和归一化处理来准备输入图像。 它支持torch.Tensor 和 np.ndarray 列表两种输入格式。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
im |
Tensor | List[ndarray]
|
BCHWtensor 格式或 HWC numpy 数组列表。 |
所需 |
返回:
类型 | 说明 |
---|---|
Tensor
|
预处理后的图像tensor 。 |
源代码 ultralytics/models/sam/predict.py
prompt_inference(im, bboxes=None, points=None, labels=None, masks=None, multimask_output=False)
基于边界框、点和遮罩等线索进行图像分割推理的内部功能。 利用SAM 的专业架构进行基于提示的实时分割。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
im |
Tensor
|
经过预处理的输入图像,格式为tensor ,形状为(N、C、H、W)。 |
所需 |
bboxes |
ndarray | List
|
形状为 (N, 4) 的边界框,格式为 XYXY。 |
None
|
points |
ndarray | List
|
表示物体位置的点,形状为 (N,2),单位为像素。 |
None
|
labels |
ndarray | List
|
点提示的标签,形状 (N,)。1 = 前景,0 = 背景。 |
None
|
masks |
ndarray
|
先前预测形状(N、H、W)的低分辨率掩码。SAM H=W=256。 |
None
|
multimask_output |
bool
|
返回多个掩码的标记。对于模棱两可的提示很有帮助。 |
False
|
返回:
类型 | 说明 |
---|---|
tuple
|
包含以下三个元素 - np.ndarray:形状为 CxHxW 的输出掩码,其中 C 是生成的掩码数。 - np.ndarray:长度为 C 的数组,包含模型为每个掩码预测的质量分数。 - np.ndarray:用于后续推理的 CxHxW 形的低分辨率对数,其中 H=W=256. |
源代码 ultralytics/models/sam/predict.py
remove_small_regions(masks, min_area=0, nms_thresh=0.7)
staticmethod
对任何分段模型 (SAM) 生成的分段掩码进行后处理。具体来说,该 功能会从输入掩码中移除小的断开区域和洞,然后执行非最大化抑制(NMS 抑制 (NMS) 以消除任何新创建的重复方框。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
masks |
Tensor
|
tensor 包含要处理的掩码。形状应为 (N、H、W),其中 N 是掩码的数量,H 是高度,W 是宽度。 是掩码的数量,H 是高度,W 是宽度。 |
所需 |
min_area |
int
|
删除断开区域和孔洞的最小面积。默认为 0。 |
0
|
nms_thresh |
float
|
NMS 算法的 IoU 阈值。默认为 0.7。 |
0.7
|
返回:
类型 | 说明 |
---|---|
tuple([Tensor, List[int]])
|
|
源代码 ultralytics/models/sam/predict.py
reset_image()
set_image(image)
预处理和设置用于推理的单个图像。
如果模型尚未初始化,该函数将对模型进行设置,并将数据源配置为指定的图像、 并预处理图像以进行特征提取。一次只能设置一幅图像。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
image |
str | ndarray
|
字符串形式的图像文件路径,或 cv2 读取的 np.ndarray 图像。 |
所需 |
加薪:
类型 | 说明 |
---|---|
AssertionError
|
如果设置了多个图像。 |
源代码 ultralytics/models/sam/predict.py
set_prompts(prompts)
setup_model(model, verbose=True)
初始化用于推理的分段 Anything Model (SAM)。
该方法通过将SAM 模型分配给适当的设备并初始化必要的 参数和其他Ultralytics 兼容性设置。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
model |
Module
|
预先训练的SAM 模型。如果无,将根据配置建立模型。 |
所需 |
verbose |
bool
|
如果为 True,则打印所选设备信息。 |
True
|
属性
名称 | 类型 | 说明 |
---|---|---|
model |
Module
|
分配给所选设备用于推理的SAM 模型。 |
device |
device
|
分配模型和张量的设备。 |
mean |
Tensor
|
图像正常化的平均值。 |
std |
Tensor
|
图像正常化的标准偏差值。 |
源代码 ultralytics/models/sam/predict.py
setup_source(source)
为推理设置数据源。
该方法可配置获取图像进行推理的数据源。数据源可以是 目录、视频文件或其他类型的图像数据源。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
source |
str | Path
|
用于推理的图像数据源路径。 |
所需 |