lsgrmController.txx 15.7 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
	
remicres's avatar
remicres committed
95
96
97
98
99
    auto accumulatedMemory = RunFirstPartialSegmentation<TSegmenter>(
        m_InputImage,
        m_SpecificParameters,
        m_Threshold,
        m_NumberOfFirstIterations,
100
        numberOfIterationsForPartialSegmentations,
remicres's avatar
remicres committed
101
102
103
104
105
106
107
        m_Tiles,
        m_NbTilesX,
        m_NbTilesY,
        m_TileWidth,
        m_TileHeight,
        isFusion);

108
#ifdef OTB_USE_MPI
remicres's avatar
remicres committed
109
    GatherUsefulVariables(accumulatedMemory, isFusion);
110
#endif
remicres's avatar
remicres committed
111
112
113
114
115

    // Time monitoring
    ShowTime(t);

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

135
#ifdef OTB_USE_MPI
remicres's avatar
remicres committed
136
      GatherUsefulVariables(accumulatedMemory, isFusion);
137
#endif
138

remicres's avatar
remicres committed
139
140
      // Time monitoring
      ShowTime(t);
141

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

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

174
      ShowTime(t);
remicres's avatar
remicres committed
175
176

      }
177
    else // accumulatedMemory > m_Memory
remicres's avatar
remicres committed
178
      {
remicres's avatar
remicres committed
179
      // That means there are no more possible fusions but we can not store the output graph
remicres's avatar
remicres committed
180
181
      // 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.
182
      itkExceptionMacro(<< "No more possible fusions, but can not store the output graph");
remicres's avatar
remicres committed
183
184
      }
    }
remicres's avatar
remicres committed
185
  else if (m_TilingMode == LSGRM_TILING_NONE)// tiling_mode is none
remicres's avatar
remicres committed
186
    {
remicres's avatar
remicres committed
187
188
189
190
191
192
193
194
195
#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
196
197
198
    // Update input image
    m_InputImage->Update();

remicres's avatar
remicres committed
199
200
201
202
    // Use classic grm
    TSegmenter segmenter;
    segmenter.SetParam(m_SpecificParameters);
    segmenter.SetThreshold(m_Threshold);
203
    segmenter.SetDoFastSegmentation(false);
remicres's avatar
remicres committed
204
205
206
    segmenter.SetNumberOfIterations(m_NumberOfIterations);
    segmenter.SetInput(m_InputImage);
    segmenter.Update();
207

208
    m_OutputGraph = segmenter.m_Graph;
remicres's avatar
remicres committed
209
210
211
212
    }
  else
    {
    itkExceptionMacro(<<"Unknow tiling mode!");
remicres's avatar
remicres committed
213
214
    }

215
216
  // TODO: [MPI] broadcast the graph to other nodes

remicres's avatar
remicres committed
217
218
}

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

  // Instanciate and initialize a segmenter
242
243
  TSegmenter segmenter;
  segmenter.SetInput(onePixelImage);
244
  grm::GraphOperations<TSegmenter>::InitNodes(onePixelImage,segmenter,FOUR);
245

246
  // Get the memory occupied by the graph, normalize it by n*n
247
  unsigned int memory = segmenter.GetGraphMemory() / (n*n);
248

249
  itkDebugMacro(<<"Size of a node is " << memory);
250
251

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

255
  itkDebugMacro(<<"Size of an image pixel is " << pixelMemory);
256
257
258

  memory += pixelMemory;

259
  itkDebugMacro(<<"Size of a node+pixel is " << memory);
260

261
  return memory;
262
}
remicres's avatar
remicres committed
263

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

282
  return std::ceil(((float) m_Memory) / ((float) GetNodeMemory()));
remicres's avatar
remicres committed
283
284
285
}

template<class TSegmenter>
286
void Controller<TSegmenter>::ComputeMaximumStabilityMargin(unsigned int width,
remicres's avatar
remicres committed
287
    unsigned int height, unsigned int &niter, unsigned int &margin)
288
    {
remicres's avatar
remicres committed
289
290
291
292
  itkDebugMacro(<< "Computing maximum stability margin");

  // Compute the stability margin. The naive strategy consider a margin value and a stable size equal.
  niter = 1;
293
294
295
  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
296

297
  while(currMargin < maxMargin)
remicres's avatar
remicres committed
298
    {
299
    margin = currMargin;
remicres's avatar
remicres committed
300
    niter++;
301
    currMargin = static_cast<unsigned int>(pow(2, niter + 1) - 2);
remicres's avatar
remicres committed
302
303
304
305
    }
  niter--;

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

307
    }
remicres's avatar
remicres committed
308

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

remicres's avatar
remicres committed
319
320
  itkDebugMacro(<<"Get automatic configuration");

remicres's avatar
remicres committed
321
  // Compute the maximum number of nodes that can fit the memory
remicres's avatar
remicres committed
322
  // TODO: Use the smallest number amongst MPI processes
remicres's avatar
remicres committed
323
  unsigned long int maximumNumberOfNodesInMemory = GetMaximumNumberOfNodesInMemory();
remicres's avatar
remicres committed
324
  itkDebugMacro(<<"Maximum number of nodes in memory is " << maximumNumberOfNodesInMemory);
remicres's avatar
remicres committed
325

remicres's avatar
remicres committed
326
  // Number of nodes in the entire image
327
328
329
  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
330

331
  // Default layout: 1x1
remicres's avatar
remicres committed
332
333
  m_NbTilesX = 1;
  m_NbTilesY = 1;
334

remicres's avatar
remicres committed
335
336
337
338
339
  // 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.
340
  unsigned int minimumNumberOfTiles = std::ceil(4.0 * ((float) nbOfNodesInImage) / ((float) maximumNumberOfNodesInMemory));
remicres's avatar
remicres committed
341
342
343
344
  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
345
  // 4 times the number of tiles (that is double rows/cols)
remicres's avatar
remicres committed
346
347
348
349
350
351
352
353
  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++)
354
    {
remicres's avatar
remicres committed
355
356
    // 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
357
      {
remicres's avatar
remicres committed
358
359
#ifdef OTB_USE_MPI
      // We want number of tiles which is a multiple of the number of MPI processes
360
361
      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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
#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
378
          float percentMemory = tileWidth * tileHeight / (float) maximumNumberOfNodesInMemory; // is > 0. Could be greater than 1 in some cases!
remicres's avatar
remicres committed
379
380
381
382

          // Compactness
          float perimeter = tileWidth + tileHeight;
          float surface = tileWidth * tileHeight;
383
          float compactness = perimeter / surface * (float) std::max(tileWidth,tileHeight); // [1,+inf]
remicres's avatar
remicres committed
384
385
386
387

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

388
          itkDebugMacro(//<< std::setprecision (2) << std::fixed
remicres's avatar
remicres committed
389
390
391
392
393
394
395
396
397
              << "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 << ")" );

398
          if (criterion < lowestCriterionValue && percentMemory <= 1.0)
remicres's avatar
remicres committed
399
400
401
402
403
404
405
406
            {
            lowestCriterionValue = criterion;
            m_NbTilesX = layoutNCol;
            m_NbTilesY = layoutNRow;
            }
          }
      } // for each multiple of k
    }
remicres's avatar
remicres committed
407
408
409
410

  // 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
411
412
413
414
415
416
  itkDebugMacro(<<"Selected layout: " << m_NbTilesX << "x" << m_NbTilesY
      << " (criterion=" << lowestCriterionValue << ")");

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

417
418
419
  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);
420
  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
421
      << (m_TileWidth + 2*m_Margin) << "x" << (m_TileHeight + 2*m_Margin) );
remicres's avatar
remicres committed
422

remicres's avatar
remicres committed
423
424
}

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

template<class TSegmenter>
remicres's avatar
remicres committed
436
void Controller<TSegmenter>::SetInputImage(ImageType * inputImage)
remicres's avatar
remicres committed
437
{
remicres's avatar
remicres committed
438
  m_InputImage = inputImage;
remicres's avatar
remicres committed
439
440
441
442
443
444
445
446
}

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

447
448
449
450
451
452
453
454
455
456
//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;
//}
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471

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;
}

472
473
474
475
476
477
478
479
template<class TSegmenter>
void Controller<TSegmenter>::SetResumingMode(unsigned int rX, unsigned int rY)
{
  m_Resuming = true;
  m_ResumeTileX = rx;
  m_ResumeTileY = ry;
}

remicres's avatar
remicres committed
480
} // end of namespace lsgrm
481
#endif