File: mvdAlgorithm.h

package info (click to toggle)
otb 8.1.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,030,436 kB
  • sloc: xml: 231,007; cpp: 224,490; ansic: 4,592; sh: 1,790; python: 1,131; perl: 92; makefile: 72
file content (629 lines) | stat: -rw-r--r-- 17,231 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
/*
 * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef mvdAlgorithm_h
#define mvdAlgorithm_h

//
// Configuration include.
//// Included at first position before any other ones.
#include "ConfigureMonteverdi.h"

#include "OTBMonteverdiCoreExport.h"

/*****************************************************************************/
/* INCLUDE SECTION                                                           */

//
// Qt includes (sorted by alphabetic order)
//// Must be included before system/custom includes.
#include <QtCore>

//
// System includes (sorted by alphabetic order)
#include <string>

//
// ITK includes (sorted by alphabetic order)
#include "itkFixedArray.h"
#include "itkExceptionObject.h"
#include "itkVariableLengthVector.h"

//
// OTB includes (sorted by alphabetic order)

//
// Monteverdi includes (sorted by alphabetic order)
#include "mvdTypes.h"


/*****************************************************************************/
/* PRE-DECLARATION SECTION                                                   */

//
// External classes pre-declaration.
namespace
{
}

namespace mvd
{
//
// Internal classes pre-declaration.
} // end of namespace 'mvd'.


/*****************************************************************************/
/* FUNCTIONS DECLARATION.                                                    */

namespace otb
{

/**
 * Convert an itk::VariableLengthVector< T2 > into a
 * itk::FixedArray< T1, N >.
 *
 * Elements of type T1 are (safely) statically casted into T2.
 *
 * An itk::RangeError exception instance is thrown if lengths/sizes of
 * both the containers are not equal.
 *
 * N.B.: Caller must ensure to that size N of itk::FixedArray< T1, N >
 * to match the variable size of the itk::VariableLengthVector< T1 >.
 */
template <typename T2, unsigned int N, typename T1>
inline itk::FixedArray<T2, N> ToFixedArray(const itk::VariableLengthVector<T1>& v);

/**
 * Convert an itk::VariableLengthVector< T2 > into a
 * itk::FixedArray< T1, N >.
 *
 * Elements of type T1 are (safely) statically casted into T2.
 *
 * An itk::RangeError exception instance is thrown if lengths/sizes of
 * both the containers are not equal.
 *
 * N.B.: Caller must ensure to that size N of itk::FixedArray< T1, N >
 * to match the variable size of the itk::VariableLengthVector< T1 >.
 */
template <typename T2, unsigned int N, typename T1>
inline itk::FixedArray<T2, N>& ToFixedArray(itk::FixedArray<T2, N>& a, const itk::VariableLengthVector<T1>& v);

/**
 * Convert an itk::FixedArray< T2, N > into a
 * itk::VariableLengthVector< T1 >.
 *
 * Elements of type T1 are (safely) statically casted into T2.
 *
 * An itk::RangeError exception instance is thrown if lengths/sizes of
 * both the containers are not equal.
 */
template <typename T2, typename T1, unsigned int N>
inline itk::VariableLengthVector<T2> ToVariableLengthVector(const itk::FixedArray<T1, N>& a);

/**
 * Convert an itk::FixedArray< T2, N > into a
 * itk::VariableLengthVector< T1 >.
 *
 * Elements of type T1 are (safely) statically casted into T2.
 *
 * An itk::RangeError exception instance is thrown if lengths/sizes of
 * both the containers are not equal.
 */
template <typename T2, typename T1, unsigned int N>
inline itk::VariableLengthVector<T2>& ToVariableLengthVector(itk::FixedArray<T1, N>& a, const itk::VariableLengthVector<T1>& v);
} // end namespace 'otb'

/*****************************************************************************/

namespace mvd
{
/**
 * \brief Write an itk::VariableLengthVector< T > into a QTextStream.
 *
 * \param stream QTextStream into which to write data.
 * \param vector itk::VariableLengthVector< T > data to write.
 *
 * \return stream instance.
 */
template <typename T>
inline QTextStream& operator<<(QTextStream& stream, const itk::VariableLengthVector<T>& vector);

/**
 * \brief Write an itk::VariableLengthVector< T > into a QTextStream.
 *
 * \param stream QTextStream into which to write data.
 * \param vector itk::VariableLengthVector< T > data to write.
 *
 * \return stream instance.
 */
template <typename T>
inline QTextStream& operator>>(QTextStream& stream, itk::VariableLengthVector<T>& vector);
/**
 * \brief Write an itk::VariableLengthVector< T > into a QDataStream.
 *
 * \param stream QDataStream into which to write data.
 * \param vector itk::VariableLengthVector< T > data to write.
 *
 * \return stream instance.
 */
template <typename T>
inline QDataStream& operator<<(QDataStream& stream, const itk::VariableLengthVector<T>& vector);

/**
 * \brief Write an itk::VariableLengthVector< T > into a QDataStream.
 *
 * \param stream QDataStream into which to write data.
 * \param vector itk::VariableLengthVector< T > data to write.
 *
 * \return stream instance.
 */
template <typename T>
inline QDataStream& operator>>(QDataStream& stream, itk::VariableLengthVector<T>& vector);

/**
 * \brief Convert a StringVector object to a QStringList object.
 *
 * Because Qt uses a shallow mechanism to copy containers, the returned
 * QStringList is shallow-copied.
 */
inline QStringList ToQStringList(const StringVector& sv);

/**
 * \brief Append the content of a StringVector object to the content
 * of a QStringList object.
 *
 * Because Qt uses a shallow mechanism to copy containers, the returned
 * QStringList is shallow-copied.
 */
inline QStringList& AppendToQStringList(QStringList& qsl, const StringVector& sv);

/**
 * \brief Convert and copy an STL std::string to a QString.
 *
 * The 8-bit data is converted to Unicode using the
 * QString::fromAscii() method.
 *
 * \param str The 8-bit STL string to convert.
 *
 * \return The Unicode converted QString.
 */

inline QString FromStdString(const std::string& str);

/**
 */
inline std::string ToLocalStdString(const QString&);

/**
 */
inline const char* ToLocalString(const QString&);

/**
 * \brief Convert and copy a QString to a STL std::string.
 *
 * The Unicode data is converted to 8-bit using the QString::toLatin1()
 * method.
 *
 * \param str The Unicode string to convert.
 *
 * \return The 8-bit converted STL std::string.
 */
inline std::string ToStdString(const QString& str);

/**
 */
inline const char* ToString(const QString& str);


/**
 * \return a std::string form various types.
 */
inline std::string ToStdString(unsigned int val);

inline std::string ToStdString(const SpacingType& spacing);

inline std::string ToStdString(const SizeType& size);

inline std::string ToStdString(const PointType& point);

template <typename T>
std::string ToStdString(const std::vector<T>& vec);

/**
 */
template <typename T>
inline QString ToQString(const T& val);

/**
 */
template <>
inline QString ToQString<float>(const float&);

/**
 */
template <>
inline QString ToQString<double>(const double&);

/**
 */
inline QString ToHumanReadableSize(qint64 fize, bool isInBits = true);

} // end namespace 'mvd'.

/*****************************************************************************/

namespace mvd
{
/**
 * \brief Test condition on all elements in range.
 *
 * \param first First element of range to test.
 * \param last Upper (external) boundary of range to test.
 * \param pred Predicate testing element in range.
 *
 * \return true if predicate is true on all elements in the range
 * [first, last[ or if range is empty.
 */
template <typename TInputIterator, typename TUnaryPredicate>
inline bool AllOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred);

/**
 * \brief Test if any of element in range fulfills condition.
 *
 * \param first First element of range to test.
 * \param last Upper (external) boundary of range to test.
 * \param pred Predicate testing element in range.
 *
 * \return true if predicated is true for, at least, one element in range
 * [first, last[. If range is empty, this function returns false.
 */
template <typename TInputIterator, typename TUnaryPredicate>
inline bool AnyOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred);

/**
 * \brief Test if no element in range fulfills condition.
 *
 * \param first First element of range to test.
 * \param last Upper (external) boundary of range to test.
 * \param pred Predicate testing element in range.
 *
 * \return true if predicated is false for all elements in range [first, last[. If range is empty, this function returns true.
 */
template <typename TInputIterator, typename TUnaryPredicate>
inline bool NoneOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred);

} // end namespace 'mvd'.

/*****************************************************************************/
/* INLINE SECTION                                                            */

namespace otb
{
/*******************************************************************************/
template <typename T2, unsigned int N, typename T1>
inline itk::FixedArray<T2, N> ToFixedArray(const itk::VariableLengthVector<T1>& v)
{
  assert(v.Size() == N);

  throw itk::RangeError(__FILE__, __LINE__);

  itk::FixedArray<T2, N> a;

  for (unsigned int i = 0; i < N; ++i)
    a[i]              = static_cast<T2>(v[i]);

  return a;
}

/*******************************************************************************/
template <typename T2, unsigned int N, typename T1>
inline itk::FixedArray<T2, N>& ToFixedArray(itk::FixedArray<T2, N>& a, const itk::VariableLengthVector<T1>& v)
{
  assert(v.Size() == N && v.Size() == a.Size());

  throw itk::RangeError(__FILE__, __LINE__);

  for (unsigned int i = 0; i < N; ++i)
    a[i]              = static_cast<T2>(v[i]);

  return a;
}

/*******************************************************************************/
template <typename T2, typename T1, unsigned int N>
inline itk::VariableLengthVector<T2> ToVariableLengthVector(const itk::FixedArray<T1, N>& a)
{
  assert(a.Size() == N);

  throw itk::RangeError(__FILE__, __LINE__);

  itk::VariableLengthVector<T2> v;

  v.Reserve(N);

  for (unsigned int i = 0; i < N; ++i)
    v[i]              = static_cast<T2>(a[i]);

  return v;
}

/*******************************************************************************/
template <typename T2, typename T1, unsigned int N>
inline itk::VariableLengthVector<T2>& ToVariableLengthVector(itk::VariableLengthVector<T2>& v, const itk::FixedArray<T1, N>& a)
{
  assert(a.Size() == N);

  throw itk::RangeError(__FILE__, __LINE__);

  v.Reserve(N);

  for (unsigned int i = 0; i < N; ++i)
    v[i]              = static_cast<T2>(a[i]);

  return v;
}

} // end namespace 'otb'.

namespace mvd
{

/*******************************************************************************/
inline QStringList ToQStringList(const StringVector& sv)
{
  QStringList qsl;
  return AppendToQStringList(qsl, sv);
}

/*******************************************************************************/
inline QStringList& AppendToQStringList(QStringList& qsl, const StringVector& sv)
{
  for (StringVector::const_iterator it(sv.begin()); it != sv.end(); ++it)
  {
    qsl.append(QString(it->c_str()));
  }

  return qsl;
}

/*******************************************************************************/
inline std::string ToLocalStdString(const QString& str)
{
  return std::string(str.toLocal8Bit().constData());
}

/*******************************************************************************/
inline const char* ToLocalString(const QString& str)
{
  return str.toLocal8Bit().constData();
}

/*******************************************************************************/
inline QString FromStdString(const std::string& str)
{
  return QString(str.c_str());
}

/*******************************************************************************/
inline std::string ToStdString(const QString& str)
{
  return std::string(str.toLatin1().constData());
}

/*******************************************************************************/
inline const char* ToString(const QString& str)
{
  return str.toLatin1().constData();
}

/*******************************************************************************/
inline std::string ToStdString(unsigned int val)
{
  std::ostringstream oss;
  oss << val;
  return oss.str();
}

/*******************************************************************************/
inline std::string ToStdString(const SpacingType& spacing)
{
  std::ostringstream oss;
  oss << spacing[0] << " , " << spacing[1];
  return oss.str();
}

/*******************************************************************************/
inline std::string ToStdString(const SizeType& size)
{
  std::ostringstream oss;
  oss << size[0] << " , " << size[1];
  return oss.str();
}

/*******************************************************************************/
inline std::string ToStdString(const PointType& point)
{
  std::ostringstream oss;
  oss << point[0] << " , " << point[1];
  return oss.str();
}

/*******************************************************************************/
template <typename T>
inline std::string ToStdString(const std::vector<T>& vec)
{
  std::ostringstream                      oss;
  typename std::vector<T>::const_iterator it = vec.begin();
  while (it != vec.end())
  {
    oss << *it << " ";
    ++it;
  }

  return oss.str();
}

/*******************************************************************************/
template <typename T>
inline QString ToQString(const T& val)
{
  return QString("%1").arg(val);
}

/*****************************************************************************/
template <>
inline QString ToQString<float>(const float& val)
{
  assert(!std::isnan(val));

  // See IEEE-754
  // Ref. http://en.wikipedia.org/wiki/Single-precision_floating-point_format
  
  QString valf = QString("%1").arg(val, 0, 'g', 9);

#if 0
  std::cout
    << "ToString< float >(" << val << "): "
    << ToStdString( valf )
    << "\t"
    << valf.toFloat()
    << std::endl;
#endif

  if (valf.toFloat() != val)
    throw std::runtime_error(
        ToStdString(QCoreApplication::translate("mvd::DatasetDescritor", "Accuracy loss when converting float (%1) to string.").arg(valf)));

  return valf;
}

/*****************************************************************************/
template <>
inline QString ToQString<double>(const double& val)
{
  assert(!std::isnan(val));

  // See IEEE-754
  // Ref. http://en.wikipedia.org/wiki/Double_precision

  QString vald = QString("%1").arg(val, 0, 'g', 17);


#if 0
  std::cout
    << "ToString< double >(" << val << "): "
    << ToStdString( vald )
    << "\t"
    << vald.toDouble()
    << std::endl;
#endif

  if (vald.toDouble() != val)
    throw std::runtime_error(
        ToStdString(QCoreApplication::translate("mvd::DatasetDescriptor", "Accuracy loss when converting double (%1) to string.").arg(vald)));

  return vald;
}

} // end namespace 'mvd'

namespace mvd
{

/*******************************************************************************/
template <typename TInputIterator, typename TUnaryPredicate>
inline bool AllOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred)
{
  while (first != last)
  {
    if (!pred(*first))
      return false;

    ++first;
  }

  return true;
}

/*******************************************************************************/
template <typename TInputIterator, typename TUnaryPredicate>
inline bool AnyOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred)
{
  while (first != last)
  {
    if (pred(*first))
      return true;

    ++first;
  }

  return false;
}

/*******************************************************************************/
template <typename TInputIterator, typename TUnaryPredicate>
inline bool NoneOf(TInputIterator first, TInputIterator last, TUnaryPredicate pred)
{
  while (first != last)
  {
    if (pred(*first))
      return false;

    ++first;
  }

  return true;
}

/*******************************************************************************/
inline QString ToHumanReadableSize(qint64 size, bool isInBits)
{
  double thousand = isInBits ? 1024.0 : 1000.0;

  double remainder = static_cast<double>(size);

  if (size < thousand)
    return QString::number(size);

  remainder /= thousand;

  if (remainder < thousand)
    return QString("%1 KiB").arg(QString::number(remainder, 'g', 3));

  remainder /= thousand;

  if (remainder < thousand)
    return QString("%1 MiB").arg(QString::number(remainder, 'g', 3));

  remainder /= thousand;

  if (remainder < thousand)
    return QString("%1 GiB").arg(QString::number(remainder, 'g', 3));

  remainder /= thousand;

  return QString("%1 TiB").arg(QString::number(remainder, 'g', 3));
}

} // end namespace 'mvd'


#endif // mvdAlgorithm_h