mkazhdan / PoissonRecon

Poisson Surface Reconstruction
MIT License
1.59k stars 430 forks source link

Describing build process for the package #275

Open dhruvmalik007 opened 1 year ago

dhruvmalik007 commented 1 year ago

Hi I wanted to add the paragraph that defines the dependencies for the build . currently the compilation section doesnt explain the process clearly.

mkazhdan commented 1 year ago

Do you have an example of the text you would like to add that you could share? (If it looks good, I'll be happy to incorporate it within the repo.)

dhruvmalik007 commented 1 year ago

in the compilation section:

COMPILATION
For efficiency, the code is designed to compile for the specific FEM degree and boundary condition specified in PoissonRecon.h. (Specifically, DEFAULT_FEM_DEGREE is set to 1 and DEFAULT_FEM_BOUNDARY is set to Neumann.) You can change the default values in PoissonRecon.h. You can also compile the code so that it supports varying FEM degrees and boundary conditions by un-#define-ing FAST_COMPILE in PreProcess.h. However, this will make the compilation significantly slower.
By default, the implementation assumes that all indexing can be done with 32-bit integers. If you are reconstructing large scenes and need more bits for indexing, you should enable the BIG_DATA flag in PreProcessor.h. Note that if the generated mesh has more primitives than can be indexed by a 32-bit integer, the output .ply file will store the integers using 64-bit precision (designated by the long long type) instead of the standard 32-bit precision (designated by the int type). Note that this is not a standard format and software like [MeshLab](https://www.meshlab.net/) may not be able to read the file.
The distributed PSR code uses sockets for communication between the client and the server. These are supported in a cross-platform way via [Boost](https://www.boost.org/). (The code was developed and tested under Boost [version 1.80.0](https://www.boost.org/users/history/version_1_80_0.html).)
To support reading/writing images, the code requires installation of the zlib, png, and jpg libraries. Source code for these is included for compilation using Visual Studios. The Makefile assumes that the header files can be found in /usr/local/include/ and that the library files can be found in /usr/local/lib/.

they have mentioned the details of the various libraries but have not defined clearly the details along with the fact that in image.h, the dependency libjpeg.cpp is not correctly referred.

mkazhdan commented 1 year ago

That's the original text, right? What, in particular, were you looking to add/amend?

dhruvmalik007 commented 1 year ago

I just wanted to get more clarity regarding what are the various dependencies that are to be linkedin with the executable (PoissonRecon)

mkazhdan commented 1 year ago

You mean in addition to the Boost (version 1.80.0), zlib, jpeg, and png library dependencies?