lsgrmController.txx 16 KB
Newer Older
1
2
#ifndef __LSGRM_CONTROLLER_TXX
#define __LSGRM_CONTROLLER_TXX
remicres's avatar
remicres committed
3
#include "lsgrmController.h"
4
5
6
7

namespace lsgrm
{

remicres's avatar
remicres committed
8
9
10
template<class TSegmenter>
Controller<TSegmenter>::Controller()
{
11
  m_TilingMode = LSGRM_TILING_AUTO;
remicres's avatar
remicres committed
12
13
14
15
16
17
18
19
20
  m_Margin = 0;
  m_NumberOfIterations = 0;
  m_NumberOfFirstIterations = 0;
  m_TileHeight = 0;
  m_TileWidth = 0;
  m_NbTilesX = 0;
  m_NbTilesY = 0;
  m_Threshold = 75;
  m_Memory = 0;
21
22
23
  m_Resuming = false;
  m_ResumeTileRow = 0;
  m_ResumeTileCol = 0;
24

remicres's avatar
remicres committed
25
26
27
28
29
30
31
}

template<class TSegmenter>
Controller<TSegmenter>::~Controller()
{
}

32
33
34
35
36
37
38
template<class TSegmenter>
void Controller<TSegmenter>::Modified()
{
  Superclass::Modified();
  m_Tiles.clear();
}

39
40
41
42
/*
 * Run the segmentation
 * TODO: compute the correct number of iterations !
 */
remicres's avatar
remicres committed
43
44
45
template<class TSegmenter>
void Controller<TSegmenter>::RunSegmentation()
{
remicres's avatar
remicres committed
46
  itkDebugMacro(<< "Entering RunSegmentation()");
remicres's avatar
remicres committed
47

48
49
  CheckMemorySize();

50
  if (m_TilingMode == LSGRM_TILING_AUTO || m_TilingMode == LSGRM_TILING_USER)
remicres's avatar
remicres committed
51
    {
52
53
54
55
    if(m_TilingMode == LSGRM_TILING_AUTO)
      {
      this->GetAutomaticConfiguration();
      }
56
    else // m_TilingMode is LSGRM_TILING_USER
57
      {
remicres's avatar
remicres committed
58
59
      m_NbTilesX = std::floor(m_InputImage->GetLargestPossibleRegion().GetSize()[0] / m_TileWidth);
      m_NbTilesY = std::floor(m_InputImage->GetLargestPossibleRegion().GetSize()[1] / m_TileHeight);
60
61
62
63
      m_Margin = static_cast<unsigned int>(pow(2, m_NumberOfFirstIterations + 1) - 2);
      }

    std::cout <<
remicres's avatar
remicres committed
64
65
66
67
68
69
70
        "--- Configuration: " <<
        "\n\tAvailable RAM: " << m_Memory <<
        "\n\tInput image dimensions: " << m_InputImage->GetLargestPossibleRegion().GetSize() <<
        "\n\tNumber of first iterations: " << m_NumberOfFirstIterations <<
        "\n\tStability margin: " << m_Margin <<
        "\n\tRegular tile size: " << m_TileWidth << " x " << m_TileHeight <<
        "\n\tTiling layout: " << m_NbTilesX << " x " << m_NbTilesY << std::endl;
remicres's avatar
remicres committed
71
72

    // Compute the splitting scheme
73
74
    m_Tiles = SplitOTBImage<ImageType>(m_InputImage, m_TileWidth, m_TileHeight, m_Margin,
        m_NbTilesX, m_NbTilesY, m_TemporaryFilesPrefix);
remicres's avatar
remicres committed
75

76
    // If there is only one tile, then fallback to LSGRM_TILING_NONE case
77
78
79
80
81
    if (m_Tiles.size() == 1)
      {
      std::cout << "Only one tile is needed. Fallback to tiling=none." << std::endl;
      SetTilingModeNone();
      }
82
83
84
85
    }

  if (m_TilingMode == LSGRM_TILING_AUTO || m_TilingMode == LSGRM_TILING_USER)
    {
86
    const unsigned int numberOfIterationsForPartialSegmentations = 3; // TODO: find a smart value
87
88
    unsigned int numberOfIterationsRemaining = m_NumberOfIterations;

remicres's avatar
remicres committed
89
90
91
92
93
    // Boolean indicating if there are remaining fusions
    bool isFusion = false;

    // Run first partial segmentation
    boost::timer t; t.restart();
94
	
95
96
    if (!m_Resuming) {
	auto accumulatedMemory = RunFirstPartialSegmentation<TSegmenter>(
remicres's avatar
remicres committed
97
98
99
100
        m_InputImage,
        m_SpecificParameters,
        m_Threshold,
        m_NumberOfFirstIterations,
101
        numberOfIterationsForPartialSegmentations,
remicres's avatar
remicres committed
102
103
104
105
106
107
        m_Tiles,
        m_NbTilesX,
        m_NbTilesY,
        m_TileWidth,
        m_TileHeight,
        isFusion);
108
109
110
111
	} else {
		// temp. patch, maybe calculate real current memory after resuming graphs.
		auto accumulatedMemory = 2 * m_Memory;
	}
remicres's avatar
remicres committed
112

113
#ifdef OTB_USE_MPI
remicres's avatar
remicres committed
114
    GatherUsefulVariables(accumulatedMemory, isFusion);
115
#endif
remicres's avatar
remicres committed
116
117
118
119
120

    // Time monitoring
    ShowTime(t);

    while(accumulatedMemory > m_Memory && isFusion)
remicres's avatar
remicres committed
121
      {
remicres's avatar
remicres committed
122
123
      isFusion = false;
      accumulatedMemory = RunPartialSegmentation<TSegmenter>(
remicres's avatar
remicres committed
124
125
          m_SpecificParameters,
          m_Threshold,
126
          numberOfIterationsForPartialSegmentations,
remicres's avatar
remicres committed
127
128
129
130
131
132
          m_Tiles,
          m_NbTilesX,
          m_NbTilesY,
          m_InputImage->GetLargestPossibleRegion().GetSize()[0],
          m_InputImage->GetLargestPossibleRegion().GetSize()[1],
          m_InputImage->GetNumberOfComponentsPerPixel(),
133
134
135
136
137
138
          isFusion,
		  m_Resuming,
		  m_ResumeTileRow,
		  m_ResumeTileCol);
      
	  if (m_Resuming) StopResumingMode();
remicres's avatar
remicres committed
139

140
#ifdef OTB_USE_MPI
remicres's avatar
remicres committed
141
      GatherUsefulVariables(accumulatedMemory, isFusion);
142
#endif
143

remicres's avatar
remicres committed
144
145
      // Time monitoring
      ShowTime(t);
146

147
148
149
      // Update number of remaining iterations
      if (numberOfIterationsRemaining < numberOfIterationsForPartialSegmentations)
        {
150
        break;
151
152
153
154
155
        }
      else
        {
        numberOfIterationsRemaining -= numberOfIterationsForPartialSegmentations;
        }
remicres's avatar
remicres committed
156
      }
157
	
remicres's avatar
remicres committed
158
#ifdef OTB_USE_MPI
159
    // Only the master process is doing the next part
remicres's avatar
remicres committed
160
    // TODO: Use the MPI process wich has the largest amount of memory
remicres's avatar
remicres committed
161
162
163
164
165
166
167
    if (otb::MPIConfig::Instance()->GetMyRank() != 0)
      return;
#endif

    if(accumulatedMemory <= m_Memory)
      {
      // Merge all the graphs
168
        m_OutputGraph = MergeAllGraphsAndAchieveSegmentation<TSegmenter>(
remicres's avatar
remicres committed
169
170
171
172
173
174
175
          m_SpecificParameters,
          m_Threshold,
          m_Tiles,
          m_NbTilesX,
          m_NbTilesY,
          m_InputImage->GetLargestPossibleRegion().GetSize()[0],
          m_InputImage->GetLargestPossibleRegion().GetSize()[1],
176
          m_InputImage->GetNumberOfComponentsPerPixel(),
remicres's avatar
remicres committed
177
          numberOfIterationsRemaining);
remicres's avatar
remicres committed
178

179
      ShowTime(t);
remicres's avatar
remicres committed
180
181

      }
182
    else // accumulatedMemory > m_Memory
remicres's avatar
remicres committed
183
      {
remicres's avatar
remicres committed
184
      // That means there are no more possible fusions but we can not store the output graph
remicres's avatar
remicres committed
185
186
      // Todo do not clean up temporary directory before copying resulting graph to the output directory
      // In the output directory add an info file to give the number of tiles.
187
      itkExceptionMacro(<< "No more possible fusions, but can not store the output graph");
remicres's avatar
remicres committed
188
189
      }
    }
remicres's avatar
remicres committed
190
  else if (m_TilingMode == LSGRM_TILING_NONE)// tiling_mode is none
remicres's avatar
remicres committed
191
    {
remicres's avatar
remicres committed
192
193
194
195
196
197
198
199
200
#ifdef OTB_USE_MPI
    // Only the master process is doing the next part
    if (otb::MPIConfig::Instance()->GetMyRank() > 0)
      return;
    else
      // Warn that there is some unused MPI processes
      if (otb::MPIConfig::Instance()->GetNbProcs() > 1)
        itkWarningMacro(<< "Only 1 MPI process will be used");
#endif
201
202
203
    // Update input image
    m_InputImage->Update();

remicres's avatar
remicres committed
204
205
206
207
    // Use classic grm
    TSegmenter segmenter;
    segmenter.SetParam(m_SpecificParameters);
    segmenter.SetThreshold(m_Threshold);
208
    segmenter.SetDoFastSegmentation(false);
remicres's avatar
remicres committed
209
210
211
    segmenter.SetNumberOfIterations(m_NumberOfIterations);
    segmenter.SetInput(m_InputImage);
    segmenter.Update();
212

213
    m_OutputGraph = segmenter.m_Graph;
remicres's avatar
remicres committed
214
215
216
217
    }
  else
    {
    itkExceptionMacro(<<"Unknow tiling mode!");
remicres's avatar
remicres committed
218
219
    }

220
221
  // TODO: [MPI] broadcast the graph to other nodes

remicres's avatar
remicres committed
222
223
}

224
225
/*
 * Compute the memory occupied by one node
remicres's avatar
remicres committed
226
227
 * TODO: compute the exact value, e.g. on a given UNIX system,
 * experimental measures shows that
228
 * for one Baatz node (+pixel) memory is about 700-730 bytes...
remicres's avatar
remicres committed
229
 * And our estimation is about 600
230
231
232
233
 */
template<class TSegmenter>
unsigned int Controller<TSegmenter>::GetNodeMemory()
{
234
  // Create a n*n image
235
  const unsigned int n = 100;
236
237
238
239
  typename ImageType::Pointer onePixelImage = ImageType::New();
  typename ImageType::IndexType start;
  start.Fill(0);
  typename ImageType::SizeType size;
240
  size.Fill(n);
241
242
243
244
  typename ImageType::RegionType region(start, size);
  onePixelImage->SetRegions(region);
  onePixelImage->SetNumberOfComponentsPerPixel(m_InputImage->GetNumberOfComponentsPerPixel());
  onePixelImage->Allocate();
245
246

  // Instanciate and initialize a segmenter
247
248
  TSegmenter segmenter;
  segmenter.SetInput(onePixelImage);
249
  grm::GraphOperations<TSegmenter>::InitNodes(onePixelImage,segmenter,FOUR);
250

251
  // Get the memory occupied by the graph, normalize it by n*n
252
  unsigned int memory = segmenter.GetGraphMemory() / (n*n);
253

254
  itkDebugMacro(<<"Size of a node is " << memory);
255
256

  // Get the memory occupied by one pixel of the image
remicres's avatar
remicres committed
257
258
  unsigned int pixelMemory =  sizeof(m_InputImage->GetBufferPointer())
      * m_InputImage->GetNumberOfComponentsPerPixel();
259

260
  itkDebugMacro(<<"Size of an image pixel is " << pixelMemory);
261
262
263

  memory += pixelMemory;

264
  itkDebugMacro(<<"Size of a node+pixel is " << memory);
265

266
  return memory;
267
}
remicres's avatar
remicres committed
268

remicres's avatar
remicres committed
269
template<class TSegmenter>
270
void Controller<TSegmenter>::CheckMemorySize()
remicres's avatar
remicres committed
271
{
272
273
274
275
276
  if (m_Memory == 0)
    {
    m_Memory = getMemorySize();
    assert(m_Memory > 0);
    }
remicres's avatar
remicres committed
277
  m_Memory /= 2; // For safety and can prevent out of memory troubles
278
279
280
281
282
}
/*
 * Compute the maximum number of nodes which can fit in the memory
 */
template<class TSegmenter>
283
std::size_t Controller<TSegmenter>::GetMaximumNumberOfNodesInMemory()
284
285
{
  itkDebugMacro(<< "Computing maximum number of nodes in memory");
remicres's avatar
remicres committed
286

287
  return std::ceil(((float) m_Memory) / ((float) GetNodeMemory()));
remicres's avatar
remicres committed
288
289
290
}

template<class TSegmenter>
291
void Controller<TSegmenter>::ComputeMaximumStabilityMargin(unsigned int width,
remicres's avatar
remicres committed
292
    unsigned int height, unsigned int &niter, unsigned int &margin)
293
    {
remicres's avatar
remicres committed
294
295
296
297
  itkDebugMacro(<< "Computing maximum stability margin");

  // Compute the stability margin. The naive strategy consider a margin value and a stable size equal.
  niter = 1;
298
299
300
  unsigned int maxMargin = std::min(width, height)/2;
  unsigned int currMargin = static_cast<unsigned int>(pow(2, niter + 1) - 2);
  margin = currMargin;
remicres's avatar
remicres committed
301

302
  while(currMargin < maxMargin)
remicres's avatar
remicres committed
303
    {
304
    margin = currMargin;
remicres's avatar
remicres committed
305
    niter++;
306
    currMargin = static_cast<unsigned int>(pow(2, niter + 1) - 2);
remicres's avatar
remicres committed
307
308
309
310
    }
  niter--;

  itkDebugMacro(<< "Number of iterations=" << niter << " margin=" << margin);
remicres's avatar
remicres committed
311

312
    }
remicres's avatar
remicres committed
313

314
/*
315
 * Compute a tiling layout which minimizes a criterion based on tile compactness
remicres's avatar
remicres committed
316
 * and memory usage
317
318
 *
 * TODO: use the lsgrmSplitter to truly compute the largest tile of a given layout
319
 */
remicres's avatar
remicres committed
320
321
322
323
template<class TSegmenter>
void Controller<TSegmenter>::GetAutomaticConfiguration()
{

remicres's avatar
remicres committed
324
325
  itkDebugMacro(<<"Get automatic configuration");

remicres's avatar
remicres committed
326
  // Compute the maximum number of nodes that can fit the memory
remicres's avatar
remicres committed
327
  // TODO: Use the smallest number amongst MPI processes
remicres's avatar
remicres committed
328
  unsigned long int maximumNumberOfNodesInMemory = GetMaximumNumberOfNodesInMemory();
remicres's avatar
remicres committed
329
  itkDebugMacro(<<"Maximum number of nodes in memory is " << maximumNumberOfNodesInMemory);
remicres's avatar
remicres committed
330

remicres's avatar
remicres committed
331
  // Number of nodes in the entire image
332
333
334
  const std::size_t imageWidth = m_InputImage->GetLargestPossibleRegion().GetSize()[0];
  const std::size_t imageHeight = m_InputImage->GetLargestPossibleRegion().GetSize()[1];
  const std::size_t nbOfNodesInImage = imageWidth*imageHeight;
remicres's avatar
remicres committed
335

336
  // Default layout: 1x1
remicres's avatar
remicres committed
337
338
  m_NbTilesX = 1;
  m_NbTilesY = 1;
339

remicres's avatar
remicres committed
340
341
342
343
344
  // Without margins, the number of tiles maximizing memory use
  // is equal to: nbOfNodesInImage / maximumNumberOfNodesInMemory.
  // Actually, there is tile margins. And the best scenario is to have
  // square tiles with margin = width/2, that is tiles 4x larger.
  // Hence the number of tiles maximizing memory use is 4x larger.
345
  unsigned int minimumNumberOfTiles = std::ceil(4.0 * ((float) nbOfNodesInImage) / ((float) maximumNumberOfNodesInMemory));
remicres's avatar
remicres committed
346
347
348
349
  itkDebugMacro(<<"Minimum number of tiles is " << minimumNumberOfTiles);

  // In the following steps, we will optimize tiling layout, starting from a number
  // of tiles equal to "minimumNumberOfTiles", up to a number of tiles equal to
350
  // 4 times the number of tiles (that is double rows/cols)
remicres's avatar
remicres committed
351
352
353
354
355
356
357
358
  unsigned int maximumNumberOfTiles = minimumNumberOfTiles * 4;

  // Search for layout which minimizes the criterion
  // The criterion is the ratio between compactness and memory usage
  // (i.e. tileWidth * tileHeight / maximumNumberOfNodesInMemory)
  itkDebugMacro(<<"Computing layouts properties:");
  float lowestCriterionValue = itk::NumericTraits<float>::max();
  for (unsigned int nbOfTiles = minimumNumberOfTiles ; nbOfTiles <= maximumNumberOfTiles ; nbOfTiles++)
359
    {
remicres's avatar
remicres committed
360
361
    // Get the multiples of k. For each one, compute the criterion of the tiling
    for (unsigned int layoutNCol = 1; layoutNCol<=nbOfTiles; layoutNCol++)
remicres's avatar
remicres committed
362
      {
remicres's avatar
remicres committed
363
364
#ifdef OTB_USE_MPI
      // We want number of tiles which is a multiple of the number of MPI processes
365
366
      if (nbOfTiles % layoutNCol == 0 && // Is it a multiple of the nb of Tiles and nProcs?
          nbOfTiles % otb::MPIConfig::Instance()->GetNbProcs() == 0)
remicres's avatar
remicres committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
#else
        if (nbOfTiles % layoutNCol == 0) // Is it a multiple of the nb of Tiles?
#endif
          {
          // Tiling layout
          unsigned int layoutNRow = nbOfTiles / layoutNCol;
          unsigned int tileWidth = imageWidth / layoutNCol;
          unsigned int tileHeight = imageHeight / layoutNRow;

          // Compute margin for regular tiles of this layout
          unsigned int maxMargin, maxIter;
          ComputeMaximumStabilityMargin(tileWidth, tileHeight, maxIter, maxMargin);
          tileWidth += 2*maxMargin;
          tileHeight += 2*maxMargin;

          // Memory use efficiency
383
          float percentMemory = tileWidth * tileHeight / (float) maximumNumberOfNodesInMemory; // is > 0. Could be greater than 1 in some cases!
remicres's avatar
remicres committed
384
385
386
387

          // Compactness
          float perimeter = tileWidth + tileHeight;
          float surface = tileWidth * tileHeight;
388
          float compactness = perimeter / surface * (float) std::max(tileWidth,tileHeight); // [1,+inf]
remicres's avatar
remicres committed
389
390
391
392

          // Update minimum criterion
          float criterion = compactness / percentMemory; // ]0, +inf]

393
          itkDebugMacro(//<< std::setprecision (2) << std::fixed
remicres's avatar
remicres committed
394
395
396
397
398
399
400
401
402
              << "Nb. tiles=" << nbOfTiles
              << " Layout: " << layoutNRow << "x" << layoutNCol
              << " Mem. use=" << percentMemory
              << " Compactness=" << compactness
              << " Criterion=" << criterion
              << " Size (no margin): " << (tileWidth-2*maxMargin)<< "x"<< (tileHeight-2*maxMargin)
              << " Size (with margin): " << tileWidth << "x" << tileHeight
              << " (margin=" << maxMargin << "/nb. iter=" << maxIter << ")" );

403
          if (criterion < lowestCriterionValue && percentMemory <= 1.0)
remicres's avatar
remicres committed
404
405
406
407
408
409
410
411
            {
            lowestCriterionValue = criterion;
            m_NbTilesX = layoutNCol;
            m_NbTilesY = layoutNRow;
            }
          }
      } // for each multiple of k
    }
remicres's avatar
remicres committed
412
413
414
415

  // Compute the tile size
  m_TileWidth = static_cast<unsigned int>(imageWidth/m_NbTilesX);
  m_TileHeight = static_cast<unsigned int>(imageHeight/m_NbTilesY);
remicres's avatar
remicres committed
416
417
418
419
420
421
  itkDebugMacro(<<"Selected layout: " << m_NbTilesX << "x" << m_NbTilesY
      << " (criterion=" << lowestCriterionValue << ")");

  // Compute the stability margin
  ComputeMaximumStabilityMargin(m_TileWidth, m_TileHeight,m_NumberOfFirstIterations, m_Margin);

422
423
424
  long long unsigned int memoryUsed = GetNodeMemory();
  memoryUsed *= static_cast<long long unsigned int>(m_TileHeight + 2*m_Margin);
  memoryUsed *= static_cast<long long unsigned int>(m_TileWidth + 2*m_Margin);
425
  itkDebugMacro(<< "An amount of " << memoryUsed/(1024.0*1024.0) << " Mbytes of RAM will be used for regular tiles of size "
remicres's avatar
remicres committed
426
      << (m_TileWidth + 2*m_Margin) << "x" << (m_TileHeight + 2*m_Margin) );
remicres's avatar
remicres committed
427

remicres's avatar
remicres committed
428
429
}

remicres's avatar
remicres committed
430
431
432
template <class TSegmenter>
void Controller<TSegmenter>::SetInternalMemoryAvailable(long long unsigned int v) // expecting a value in Mbytes.
{
433
434
435
436
  if (v<=0)
    {
    itkExceptionMacro(<<"Memory value is not valid (value=" << v << ")");
    }
remicres's avatar
remicres committed
437
438
439
440
  m_Memory = v * 1024ul * 1024ul;
}

template<class TSegmenter>
remicres's avatar
remicres committed
441
void Controller<TSegmenter>::SetInputImage(ImageType * inputImage)
remicres's avatar
remicres committed
442
{
remicres's avatar
remicres committed
443
  m_InputImage = inputImage;
remicres's avatar
remicres committed
444
445
446
447
448
449
450
451
}

template<class TSegmenter>
void Controller<TSegmenter>::SetSpecificParameters(const SegmentationParameterType& params)
{
  m_SpecificParameters = params;
}

452
453
454
455
456
457
458
459
460
461
//template<class TSegmenter>
//typename Controller<TSegmenter>::LabelImageType::Pointer
//Controller<TSegmenter>::GetLabeledClusteredOutput()
//{
//#ifdef OTB_USE_MPI
//  // Get the label image from the master process (the one which achieves segmentation)
//  BroadcastImage<typename TSegmenter::LabelImageType>(m_LabelImage);
//#endif
//  return m_LabelImage;
//}
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

template <class TSegmenter>
std::vector<std::string> Controller<TSegmenter>::GetTemporaryFilesList()
{
  std::vector<std::string> list;
  for (unsigned int i = 0; i < m_Tiles.size(); i++)
    {
    list.push_back(m_Tiles[i].edgeFileName);
    list.push_back(m_Tiles[i].edgeMarginFileName);
    list.push_back(m_Tiles[i].nodeFileName);
    list.push_back(m_Tiles[i].nodeMarginFileName);
    }
  return list;
}

477
template<class TSegmenter>
478
void Controller<TSegmenter>::SetResumingMode(unsigned int rRow, unsigned int rCol)
479
480
{
  m_Resuming = true;
481
482
  m_ResumeTileRow = rRow;
  m_ResumeTileCol = rCol;
483
484
}

485
486
487
488
489
490
491
492
template<class TSegmenter>
void Controller<TSegmenter>::StopResumingMode()
{
  m_Resuming = false;
  m_ResumeTileRow = 0;
  m_ResumeTileCol = 0;
}

remicres's avatar
remicres committed
493
} // end of namespace lsgrm
494
#endif