Skip to content
Snippets Groups Projects
Commit 5663d7cd authored by Emmanuelle Sarrazin's avatar Emmanuelle Sarrazin
Browse files

DOC: Add comment for MPIVrtWriter

parent ef041039
No related branches found
No related tags found
No related merge requests found
......@@ -35,7 +35,20 @@
namespace otb {
// Update MPI
/**
*\brief Write image data to multiple files with MPI processus and add a VRT file.
*
* The image is divided into several pieces.
* Each pieces is distributed to a MPI processus.
* Each MPI processus write their pieces into a separate
* file.
* The master processus writes a VRT file (optional).
*
*\param img Image
*\param output Output Filename
*\param availableRAM Available memory for streaming
*\param writeVRTFile Activate the VRT file writing
*/
template <typename TImage> void WriteMPI(TImage *img, const std::string &output, unsigned int availableRAM = 0, bool writeVRTFile=true)
{
typename otb::MPIConfig::Pointer mpiConfig = otb::MPIConfig::Instance();
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment