API Summary

The EasyIDP package have the following modules:

• Data Module : Download and provide path to example files.

• Point cloud Module : read, write, check and crop operation.

• GeoTiff Module : read, write, crop, and statistics operation.

  • cvtools Submodule : processing ndarray images.

• ROI Module : read region of interest from shp and txt file.

  • shp Submodule: read shape (*.shp) file.

  • jsonfile Submodule: read and write json and geojson file.

  • geotools Submodule: transform geo-coordinate.

• reconstruct Module : process 3D reconstruction software project.

  • Pix4D Submodule: handle Pix4D projects.

  • Metashape Submodule: handle Metashape projects.

• visualize Module : Draw visualization figures for the output.

For each module, consisted by several base functions (e.g. easyidp.geotiff.* ) and an advanced wrapper class for them (e.g. easyidp.GeoTiff). In the most cases, please use the upper case class wrapper rather than the lowercase base functions unless you really need them.

For example, this function can be used to read geotiff meta infomation:

>>> import easyidp as idp
>>> header = idp.geotiff.get_header("one_geotiff_file.tif")

But it is more recommended use the advanced wrapper in most application cases:

>>> geo = idp.GeoTiff("one_geotiff_files.tif")
>>> header = geo.header

Although it may seem like more code, advanced wrappers have more convenient functions to use without caring about specific data structure details. Most of our example cases are using the advanced class wrapper.

Caution

The easyidp.Container object, its child objects, and objects contains this object, like easyidp.ROI , ProjectPool , easyidp.Recons , easyidp.Pix4D , easyidp.Metashape, can not be saved by pickle.

Please check this link for more details What can be pickled and unpickled .