API Overview

This section provides complete API reference documentation for MipMapEngine SDK, including all available interfaces, parameter descriptions, and usage examples.

Before You Start

If you haven't installed the SDK yet, please first check the Installation Guide Windows or Installation Guide Linux.

MipMapEngine SDK provides multiple interfaces to meet different usage scenarios:

📚 Interface Categories

Interface	Function	Type	Applicable Scenarios
ReconstructFull【Recommended】	Full-process reconstruction	0	Quick startup, automatic processing, simple parameter configuration, see ReconstructFull Interface Details
ReconstructAT	Aerotriangulation	1	Fine control, professional users, see ReconstructAT Details
Reconstruct3D	3D Reconstruction	2	Generate models from aerotriangulation results, see Reconstruct3D Details
OptimizeAT	Control point optimization	3	Use control points to improve accuracy, see OptimizeAT Details
DivideTiles	Tile processing	4	Large-scale data tile reconstruction, see DivideTiles Details

📚 >>> Learn more about the ReconstructFull interface

📝 Interface Invocation Methods

1. Command Line Invocation

The SDK supports direct invocation of each engine through the command line, controlling interface usage by controlling Type:

# General format
reconstruct_full_engine -reconstruct_type <type_number> -task_json <config_task_file.json>

# Example: Invoke ReconstructFull (Type=0)
reconstruct_full_engine -reconstruct_type 0 -task_json config_task.json

🎯 Choosing the Right Interface

If you...	Recommended	Reason
Using SDK for the first time	ReconstructFull, see ReconstructFull Interface Details	Automatic processing, simple to get started, suitable for most tasks
Need to use control points to optimize reconstruction	ReconstructAT/OptimizeAT/Reconstruct3D	Supports control point optimization
Regular tile processing of ultra-large data	ReconstructAT/DivideTiles/Reconstruct3D	Supports custom tile processing

📖 JSON Configuration Files

All interfaces use JSON format configuration files, basic structure:

{
  "working_dir": "string",      // Required: Working directory
  "gdal_folder": "string",      // Required: GDAL data directory
  // ... Other parameters depend on the interface
}

For more detailed information, refer to the API manual.

Error Handling

All interfaces return integer error codes:

• 0: Success
• Non-zero: Various error conditions

For details, see error code reference Error Codes.

🚀 Next Steps

• 📚 Learn more about the ReconstructFull interface API manual

---

Tip: Most users can meet their needs using ReconstructFull. Only use other interfaces when fine control is needed.