| Label | Explanation | Data Type |
Input Video File
| The input video file in any of the supported video file types, including PS, TS, MPG, MPEG, MP2, MPG2, MPEG2, MP4, MPG4, MPEG4, H264, VOB, and M2TS. | File |
Output Folder
| The file directory where the output images and metadata will be saved. | Folder |
Image Type
| The output image format.
| String |
Maximum Overlap Percentage
(Optional) | The maximum overlap percentage between two images. If the overlap between a candidate image and the last image written to disk is greater than this value, the candidate image will be ignored. The default percentage is 100%, which writes all images to disk. | Double |
Require Fresh Metadata (Optional) | Specifies whether video frames with associated metadata will be extracted and saved.
| Boolean |
Minimum Time Between Features (Optional) | The minimum time interval between video frames to be saved. If this is not specified, all video frames will be saved as images. | Time Unit |
Available with Image Analyst license.
Summary
Extracts video frame images and associated metadata from a FMV-compliant video stream. The extracted images can be added to a mosaic dataset or other tools and functions for further analysis.
Usage
This tool works with archived video data only. Live stream videos are not supported.
Images from a FMV-compliant video stream will be extracted and stored in a directory as TIFF, NITF, or JPEG files.
Metadata associated with the video imagery will be written to a comma delimitated values (CSV) file in the same directory.
Parameters
ExtractVideoFramesToImages(in_video, out_folder, image_type, {image_overlap}, {require_fresh_metadata}, {min_time})| Name | Explanation | Data Type |
in_video | The input video file in any of the supported video file types, including PS, TS, MPG, MPEG, MP2, MPG2, MPEG2, MP4, MPG4, MPEG4, H264, VOB, and M2TS. | File |
out_folder | The file directory where the output images and metadata will be saved. | Folder |
image_type | The output image format.
| String |
image_overlap (Optional) | The maximum overlap percentage between two images. If the overlap between a candidate image and the last image written to disk is greater than this value, the candidate image will be ignored. The default percentage is 100%, which writes all images to disk. | Double |
require_fresh_metadata (Optional) | Specifies whether video frames with associated metadata will be extracted and saved.
| Boolean |
min_time (Optional) | The minimum time interval between video frames to be saved. If this is not specified, all video frames will be saved as images. | Time Unit |
Code sample
This example extracts video frame images and associated metadata from a video stream and saves the data to a directory.
arcpy.ia.ExtractVideoFramesToImages(r"c:\test\video.ts", r"C:\temp2\outimages",
"TIFF", 100, "", "20 Seconds")This example extracts video frame images and associated metadata from a video stream and saves the data to a directory.
import arcpy
from arcpy.ia import *
arcpy.CheckOutExtension("ImageAnalyst")
in_video = "c:\\test\\drone_vid.ts"
out_folder = "c:\\output"
outformat = "NITF"
maxoverlap = 100
requirefreshmeta = “REQUIRE_FRESH_METADATA”
mintimebetween = "1 minute"
arcpy.ia.ExtractVideoFramesToImages(in_video, out_folder, outformat, maxoverlap,
requirefreshmeta, mintimebetween)Environments
This tool does not use any geoprocessing environments.
Licensing information
- Basic: Requires Image Analyst
- Standard: Requires Image Analyst
- Advanced: Requires Image Analyst