We highly recommend migrating to the PIX4Dengine SDK. To get access to the latest documentation, please visit PIX4Dengine Server SDK.
It is possible to use the command line to create and process projects. Not all options can be changed. In many cases, it is possible to create a .p4d file to change the options that cannot be changed through the command line: .p4d minimum format.
To use the command line access the folder where PIX4Dmapper is installed and run the command:
pix4dmapper.exe -h
This displays the help which lists the options and commands that can be used.
The syntax of the command line is:
pix4dmapper [options] [project file]
The following command line options are available:
When processing a project, the processing parameters saved in the .p4d project file are used. If the processing parameters are modified through the command line using a template file, they are saved in the .p4d project file and used for processing.
If nothing is specified will use --run. Can also be used with --initial, --dense, --ortho or --new.
Can only be used together with --run.
It is ignored when used in command line mode.
Can only be used together with --password.
Can only be used together with --email.
Open a project
pix4dmapper <project_file>
pix4dmapper D:\mining\quarry.p4d
Print the software help
pix4dmapper -h
pix4dmapper -h
Print the software version
pix4dmapper -v
pix4dmapper -v
Running the processing steps defined in the .p4d processing options in command line mode, without opening the user interface
pix4dmapper -c -r <project_file>
pix4dmapper -c -r D:\mining\quarry.p4d
Running the processing steps defined in the .p4d processing options, opening the user interface before processing and closing it after processing
pix4dmapper -r --close-gui <project_file>
pix4dmapper -r --close-gui D:\mining\quarry.p4d
Running step 1. Initial Processing, using the camera parameters from the project .p4d file, without opening the user interface
pix4dmapper -c --cam-param-project -i <project_file>
pix4dmapper -c --cam-param-project -i D:\mining\quarry.p4d
Running step 1. Initial Processing, using the camera parameters from the internal camera model database, without opening the user interface
pix4dmapper -c --cam-param-db -i <project_file>
pix4dmapper -c --cam-param-db -i D:\mining\quarry.p4d
Example --disable-user-cam-db
pix4dmapper -c --disable-user-cam-db -i <project_file>
pix4dmapper -c --disable-user-cam-db -i D:\mining\quarry.p4d
Log in the software, without opening the user interface
pix4dmapper -c --email <email> --password <password>
pix4dmapper -c --email j.doe@pix4d.com --password jpwd
Log in the software and run the project, without opening the user interface
pix4dmapper -c --email <email> --password <password> -r <project_file>
pix4dmapper -c --email j.doe@pix4d.com --password jpwd -r D:\mining\quarry.p4d
Log out from the software, without opening the user interface
pix4dmapper --logout
pix4dmapper --logout
Can only be used with --new and --cmdline.
selected:
- 3drobotics: for "3D Robotics" flight log.
- pix4d-lat-long: for "Latitude - Longitude - Altitude" Pix4D's file format.
- pix4d-long-lat: for "Longitude - Latitude - Altitude" Pix4D's file format.
- pix4d-x-y: For "X - Y - Z" Pix4D's file format.
- pix4d-y-x: For "Y - X - Z" Pix4D's file format.
Can only be used with --new and --cmdline.
If the band names contain spaces, the list has be surrounded by quotation marks. Example: "Red edge, Green, Blue".
Creating a new project with image geolocation in the EXIF data, without opening the user interface
pix4dmapper -c -n --image-dir <image_directory> <project_file>
pix4dmapper -c -n --image-dir D:\mining\Images D:\mining\quarry.p4d
Creating a new project without image geolocation, without opening the user interface
pix4dmapper -c -n --image-dir <image_directory> <project_file>
pix4dmapper -c -n --image-dir D:\mining\Images D:\mining\quarry.p4d
Creating a new project with image geolocation from file, without opening the user interface
pix4dmapper -c -n --image-dir <image_directory> --geolocation-format <geolocation_file_format> --geolocation-file <geolocation_file> <project_file>
pix4dmapper -c -n --image-dir D:\mining\Images --geolocation-format pix4d-lat-long --geolocation-file D:\mining\Inputs\imagePositionsLatLongAlt.csv D:\mining\quarry.p4d
Can only be used if step 1. Initial Processing is completed or if it used together with --initial.
Can only be used if step 1. Initial Processing is completed or if it is used together with --initial.
Can also be used in combination with --dense or after step 2. Point Cloud and Mesh has been completed.
Running all processing steps defined in the processing options, without opening the user interface
pix4dmapper -c -r <project_file>
pix4dmapper -c -r D:\mining\quarry.p4d
Running step 1. Initial Processing, without opening the user interface
pix4dmapper -c -i <project_file>
pix4dmapper -c -i D:\mining\quarry.p4d
Running step 2. Point Cloud and Mesh, without opening the user interface
pix4dmapper -c -d <project_file>
pix4dmapper -c -d D:\mining\quarry.p4d
Running step 3. DSM, Orthomosaic and Index, without opening the user interface
pix4dmapper -c -o <project_file>
pix4dmapper -c -o D:\mining\quarry.p4d
Creating a new project, using the 3D Maps pre-defined template to initialize the processing options, without opening the user interface. The image geolocation is loaded from the EXIF data.
pix4dmapper -c -n --image-dir <image_directory> --template 3d-maps <project_file>
pix4dmapper -c -n --image-dir D:\mining\Images --template 3d-maps D:\mining\quarry.p4d
Creating a new project, using a .tmpl template file to initialize the processing options, without opening the user interface. The image geolocation is loaded from the EXIF data.
pix4dmapper -c -n --image-dir <image_directory> --template <template_file> <project_file>
pix4dmapper -c -n --image-dir D:\mining\Images --template D:\mining\dsm_with_contours.tmpl D:\mining\quarry.p4d
Display pre-defined template list
pix4dmapper --template-list
pix4dmapper --template-list
Can only be used with --run, --initial, --dense, --ortho.
Enable/disable all CUDA capable GPUs. <arg> can be:
- yes
- no
Running the processing steps defined in the processing options, using a maximum of 16 CPU threads, without opening the user interface
pix4dmapper -c -r --max-cpus 16 <project_file>
pix4dmapper -c -r --max-cpus 16 D:\mining\quarry.p4d
Running step 1. Initial Processing, using a maximum of 16 CPU threads, without opening the user interface
pix4dmapper -c -i --max-cpus 16 <project_file>
pix4dmapper -c -i --max-cpus D:\mining\quarry.p4d
Running the processing steps defined in the processing options, with all CUDA capable GPUs enabled, without opening the user interface
pix4dmapper -c -r --use-cuda yes <project_file>
pix4dmapper -c -r --use-cuda yes D:\mining\quarry.p4d
PIX4Dmapper outputs two different streams: Stdout (containing the messages labeled as Info, UI, and Processing) and Stderr (containing the messages labeled as Error and Warning). For more information about these labels: Menu View > Log Output.
The Stderr messages are always outputted. The outputting of the stdout messages depends on whether PIX4Dmapper is running in command line mode (using the -c option) or not. The options --stdout and --no-stdout allow the user to modify this behavior.