File: Modules.dox

package info (click to toggle)
insighttoolkit5 5.4.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704,404 kB
  • sloc: cpp: 783,697; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 461; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (629 lines) | stat: -rw-r--r-- 17,420 bytes parent folder | download | duplicates (2)
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
/**
  \defgroup DataRepresentation Data Representation Objects

  ITK includes several data representation objects such as
  itk::Image, itk::Mesh, itk::Point, etc.
*/

/**
  \defgroup ImageObjects Image Representation Objects
  \ingroup DataRepresentation

  Objects required to represent images in ITK.
*/

/**
  \defgroup MeshObjects Mesh Representation Objects
  \ingroup DataRepresentation

  Objects required to represent meshes in ITK.
*/

/**
  \defgroup PathObjects Path Representation Objects
  \ingroup DataRepresentation

  Objects required to represent paths in ITK.
*/

/**
  \defgroup Geometry Geometry Representation Objects
  \ingroup DataRepresentation

  Objects required to represent geometrical entities like positions, vectors
  and space mappings.

  A detailed description of the rationale for these classes can be found in
  \ref GeometryPage.
*/

/**
  \defgroup DataAccess Data Access Objects

  ITK includes several ways to access data through the user of
  iterators, pointers, indexes, etc.
*/

/**
  \defgroup TensorObjects Tensor Image Objects

  Objects required for representing diffusion tensor images in ITK.
*/

/**
  \defgroup ImageAccess Image Access Objects
  \ingroup DataAccess
*/

/**
  \defgroup MeshAccess Mesh Access Objects
  \ingroup DataAccess
*/

/**
  \defgroup Iterators Iterators
  \ingroup DataAccess

  Iterators are the mechanism used to walk over the content of a particular
  data object. They allow to define paths and directions along which the data
  should be walked through.
*/

/**
  \defgroup ImageIterators Image Iterators
  \ingroup Iterators

  Image iterators allow to go through the content of an image in a predefined
  way. For a detailed description of the iterators' rationale see
  \ref ImageIteratorsPage.
*/

/**
  \defgroup DataProcessing Data Processing Objects

  ITK includes several ways to process the data using objects such as adaptors,
  functions, filters, and transforms.
*/

/**
  \defgroup Filters Filters
  \ingroup DataProcessing

  Filters implementing the operations on the pipeline architecture.
*/

/**
  \defgroup ImageFilters Image Filters
  \ingroup Filters

  Image filters process input images and produce output images. Inputs are
  unmodified. The pipeline architecture makes provisions for supporting
  streaming by using packets of data defined by regions.

  \sa itk::Image
  \sa itk::ImageRegion
*/

/**
  \defgroup MeshFilters Mesh Filters
  \ingroup Filters

  Mesh filters process input meshes and produce output meshes. Inputs are
  unmodified.

  \sa itk::Mesh
*/

/**
  \defgroup IntensityImageFilters Intensity Image Filters
  \ingroup ImageFilters

  Intensity image filters only alter the values stored in image pixels.

  \sa itk::Image
  \sa itk::ImageRegion
*/

/**
  \defgroup MathematicalMorphologyImageFilters Mathematical Morphology Image Filters
  \ingroup IntensityImageFilters

  Mathematical morphology filters are a particular class of cellular automata.
  They modify the value of a pixel based on the values of a neighborhood.
  The neighborhood is now as the structured element.

  \sa itk::Image
  \sa itk::ImageRegion
  \sa itk::BinaryMorphologyImageFilter
*/


/**
 \ defgroup ImageEnhancement Image Enhancement Filters
  \ingroup ImageFilters

  Image enhancement filters process an image to enhance the appearance
  of an image either for visualization purposes or for further processing.
  Examples of image enhancement filters available in ITK are: anisotropic diffusion,
  Gaussian filter, and histogram equalization.
*/

/**
  \defgroup ImageFeatureExtraction Image Feature Extraction Filters
  \ingroup ImageFilters

  Image feature extraction filters process an image to extract features of interest
  such as gradients, edges, distances, etc.

  Examples of image feature extraction algorithms available in ITK are: image gradients,
  first and second derivatives, and Danielson distance.
*/

/**
  \defgroup GradientFilters Image Gradient Filters
  \ingroup ImageFeatureExtraction

  These filters compute local gradients of images.
*/


/**
  \defgroup GeometricTransform Geometric Transformation Filters
  \ingroup Filters

  Geometric transformation Filters transform the coordinates of an image in
  various ways.

  Examples of geometric transformation Filters available in ITK are: image
  shrinking, and affine transformation.
*/

/**
  \defgroup PyramidImageFilter Image Pyramid Filters
  \ingroup GeometricTransform

  Image pyramid filters generate a set of downsampled versions of an image
  according to a user defined multi-resolution schedule.
*/

/**
  \defgroup ImageSegmentation Image Segmentation Filters
  \ingroup ImageFilters

  Image segmentation filters process an image to partition it into meaningful
  regions. Various types of image segmentation algorithms are available in ITK,
  such as unsupervised pixel classification methods, region-growing methods,
  watershed-based methods, deformable-model based methods, and level-set based
  methods.
*/

/**
  \defgroup IntensityImageSegmentation Intensity-Based Image Segmentation Filters
  \ingroup ImageSegmentation

  Intensity based image segmentation filters use intensity values of image
  pixels to segment an image. Typically, spatial contiguity is not considered
  in intensity-based segmentation filters.

  Examples of intensity-based algorithms in ITK are supervised and unsupervised
  pixel classification algorithms.
*/

/**
  \defgroup ClassificationFilters Pixel Classification Filters
  \ingroup IntensityImageSegmentation

  Pixel classification filters use statistical classification algorithms to
  assign a label to a given image pixel. Classification algorithms can be
  supervised when training data is available or unsupervised when no training
  data is available.
*/

/**
  \defgroup SupervisedClassificationFilters Supervised Classification Filters
  \ingroup ClassificationFilters

  Supervised classification filters rely on the existence of training data to
  classify pixels into different types. An example of supervised
  classification algorithm in ITK is the Gaussian classifier that uses the
  training data to build Gaussian models of intensity distributions.
*/

/**
  \defgroup UnSupervisedClassificationFilters Unsupervised Classification Filters
  \ingroup ClassificationFilters

  Unsupervised classification filters typically cluster the image intensity
  data into different groups.

  An example of unsupervised classification algorithm in ITK is the K-Means
  clustering algorithm.
*/

/**
  \defgroup WatershedSegmentation Watershed-based Segmentation Filters
  \ingroup IntensityImageSegmentation

  These filters segment an image based on intensity values using the watershed
  algorithm.
*/

/**
  \defgroup RegionBasedSegmentation Region-Based Segmentation Filters
  \ingroup ImageSegmentation

  These filters segment an image based on similarity of intensity values
  between spatially adjacent pixels. Examples of region-based segmentation
  filters in ITK include fuzzy connectedness, region growing, and Markov
  Random Fields (MRF).
*/

/**
  \defgroup FuzzyConnectednessSegmentation Fuzzy Connectedness-based Segmentation Filters
  \ingroup RegionBasedSegmentation

  These filters segment an image based on fuzzy connectedness principles.
  These methods typically start with one or more seed points and grow regions
  around these seed points based on fuzzy affinity.
*/

/**
  \defgroup RegionGrowingSegmentation Region Growing Filters
  \ingroup RegionBasedSegmentation

  Typically region growing involves starting several small regions on an image
  and merging them iteratively based on some pixel intensity similarity
  criterion. ITK provides an intensity and edge-based region-growing algorithm
  for segmentation.
*/

/**
  \defgroup MRFFilters Markov Random Field-based Filters
  \ingroup RegionBasedSegmentation

  Markov Random Field (MRF)-based Filters assume that the segmented image is
  Markovian in nature, i.e., adjacent pixels are likely to be of the same
  class. These methods typically combine intensity-based filters with MRF
  prior models also known as Gibbs prior models.
*/

/**
  \defgroup ModelImageSegmentation Model-Based Image Segmentation Filters
  \ingroup ImageSegmentation

  These filters segment an image by starting with a model and then updating
  the model based on image features and the updates are typically
  constrained by a-priori knowledge about the models.

  Examples of these types of algorithms in ITK include: deformable model
  (snakes)-based algorithms and level set-based algorithms.
*/

/**
  \defgroup MeshSegmentation Mesh Segmentation Filters
  \ingroup ModelImageSegmentation

  These algorithms represent models using a mesh and update the models based
  on image features.

  Examples of this type of filter in ITK include: balloon force filter and the
  deformable mesh filter.
*/

/**
  \defgroup LevelSetSegmentation Level Set-Based Segmentation Filters
  \ingroup ModelImageSegmentation

  These algorithms represent models implicitly using level-sets and update the
  models based on image features.

  Examples of these types of segmentation methods in ITK include: curvature
  flow-based filters, fast marching filters, and shape-detection filters.
*/

/**
  \defgroup HybridSegmentation Hybrid Segmentation Filters
  \ingroup ImageSegmentation

  These filters are hybrid between intensity-based, region-based, or
  model-based image segmentation filters.
*/

/**
  \defgroup RegistrationFilters Registration Filters
  \ingroup Filters
*/

/**
  \defgroup RegistrationComponents Components of Registration Methods
  \ingroup RegistrationFilters

  Registration methods are implemented by combining basic components. This
  framework allows great flexibility in the construction of registration
  methods, and maximizes code reuse. The basic components of a registration
  method are described in \ref RegistrationPage.
*/

/**
  \defgroup RegistrationMetrics Similarity Metrics of Registration Methods
  \ingroup RegistrationComponents

  Similarity metrics are the objects that evaluate how similar two objects
  are. They are used in registration to quantify how well a transform is
  mapping the reference object on top of the target object.
*/

/**
  \defgroup ImageRegistration Image Registration Methods
  \ingroup RegistrationFilters
*/

/**
  \defgroup RigidImageRegistration Rigid Registration Methods
  \ingroup ImageRegistration
*/

/**
  \defgroup AffineImageRegistration Affine Registration Methods
  \ingroup ImageRegistration
*/

/**
  \defgroup DeformableImageRegistration Deformable Registration Methods
  \ingroup ImageRegistration
*/

/**
  \defgroup ModelImageRegistration Model - Image Registration Methods
  \ingroup RegistrationFilters
*/

/**
  \defgroup PointSetToImageRegistration PointSet to Image Registration Methods
  \ingroup ModelImageRegistration
*/

/**
  \defgroup IOFilters Input and Output Filters
  \ingroup Filters
*/

/**
  \defgroup DataSources Data Sources
  \ingroup DataProcessing
*/

  \defgroup ITKTransform Transforms
  \ingroup DataProcessing
*/

/**
  \defgroup ImageAdaptors Image Adaptors
  \ingroup DataProcessing

  Image adaptors are an implementation of the <em>Adaptor Design Pattern</em>.
  They are designed to present an image of a particular type as being an image
  of a different type. Adaptors perform simple operations on pixel values for
  which is not easy to justify the use of an image filter.

  One of the principal tasks of Image adaptors is to perform casting.

  For example: you have an image whose pixels are of type
  <tt>unsigned char</tt> and you need to feed this image in a process that
  expects pixels of type <tt>double</tt>. You have the option of using an
  image filter (see \ref ImageFilters) that converts the
  <tt>unsigned char</tt> input image into another of <tt>double</tt> pixel
  type. However this filter will allocate memory for this second image and
  will need to be executed. Image adaptors allow to simulate that you have
  made the conversion but will avoid the overhead in memory. There is however
  a penalty in performance.

  The mechanism used by image adaptors is to provide a simple function that
  will be used by image iterators (see \ref ImageIteratorsPage) to convert the
  value of a pixel, in a pixel-by-pixel basis.
*/

/**
  \defgroup Functions Functions
  \ingroup DataProcessing

  Functions providing an efficient mechanism for computing values.
*/

/**
  \defgroup ImageFunctions Image Functions
  \ingroup Functions

  Image functions compute single values using data from a previously specified
  image. A value can be computed at an image index, continuous index or point.

  \sa itk::Image
  \sa itk::Index
  \sa itk::ImageFunction
*/

/**
  \defgroup ImageInterpolators Image Interpolators
  \ingroup ImageFunctions

  Image interpolators compute pixel values in non-grid positions. A value can
  be computed at an image index, continuous index or point.

  \sa itk::Image
  \sa itk::ImageFunction
*/

/**
  \defgroup SpatialFunctions Spatial Functions
  \ingroup Functions
*/

/**
  \defgroup FiniteDifferenceFunctions Finite Difference Functions
  \ingroup Functions

  Finite difference functions are used in the finite difference solver (FDS)
  framework for solving partial differential equations on images using an
  iterative, finite difference update scheme.

  \sa itk::FiniteDifferenceImageFilter
  \sa itk::FiniteDifferenceFunction
*/

/**
  \defgroup Operators Operators
  \ingroup DataProcessing

  Operators implement the abstraction of performing an operation using data
  from a neighborhood of a pixel. ITK Operators work in conjunction with
  neighborhood iterators in order to walk over an image.
*/

/**
  \defgroup Numerics Numerics

  ITK provides support for numerical operations at two levels. First, ITK uses
  an external library called VNL, which is one component of the VXL toolkit.
  This library provides linear algebra, optimization, and FFTs. Second, ITK
  provides numerical optimizers designed for the registration framework and
  statistical classes designed to be used for classification and segmentation.
 */

/**
  \defgroup Optimizers Optimizers
  \ingroup Numerics RegistrationComponents

  Set of Optimization methods. Some of these methods are adaptors for
  classes already defined in the VNL library. These methods have been
  particularly tailored to be used as modular components in the
  registration framework.

  \sa RegistrationComponents
 */

/**
  \defgroup SystemObjects System Objects
*/

/**
  \defgroup ITKSystemObjects ITK System Objects
  \ingroup SystemObjects

  Basic system objects used in building ITK.
*/

/**
  \defgroup OSSystemObjects OS System Objects
  \ingroup SystemObjects

  Basic operating system related system objects in ITK.
*/

/**
  \defgroup ThreadSafetyGroup Thread Safety

  Classes catalogued according to their compliance with thread safety.

  ITK is designed to be thread-safe, but in some particular cases this
  capability cannot be supported and for this reason a classification is
  needed.
*/

/**
  \defgroup ThreadSafe Thread Safe classes
  \ingroup ThreadSafetyGroup
*/

/**
  \defgroup ThreadUnSafe Thread Unsafe Classes
  \ingroup ThreadSafetyGroup
*/

/**
  \defgroup ThreadSafetyUnknown Thread Safety Unknown
  \ingroup ThreadSafetyGroup
*/

/**
  \defgroup MultiThreadingGroup MultiThreading Support

  Filters classified according to their support for performing processing in
  multiple threads.
*/

/**
  \defgroup MultiThreaded MultiThreaded Filters
  \ingroup MultiThreadingGroup

  Filters dividing the processing across several threads.
*/

/**
  \defgroup SingleThreaded  SingleThreaded Filters
  \ingroup MultiThreadingGroup

  Filters performing all its processing in a single thread.
*/


/**
  \defgroup ShouldBeThreaded Threading-friendly Filters
  \ingroup MultiThreadingGroup

  Filters that could benefit from a multi-threading implementation.
*/

/**
  \defgroup StreamingGroup Region-wise Processing Objects

  Filters processing images region by region. These filters may support
  streaming.
*/

/**
  \defgroup Streamed Streaming Filters
  \ingroup StreamingGroup

  Filters that can respond to a request for a portion of the output using
  only a portion of the input.
*/

/**
  \defgroup CannotBeStreamed Streaming-unfriendly Filters
  \ingroup StreamingGroup

  Filters that cannot be streamed. These filters require either all the input
  or produce all the output.
*/


/**
  \defgroup ShouldBeStreamed Streaming-friendly Filters
  \ingroup StreamingGroup

  Filters that can potentially be modified to support streaming but currently
  are not supporting it.
*/

/**
  \defgroup Deprecated Deprecated Classes

  Classes that are scheduled to be removed from the toolkit. Their
  funcionality is now provided by other classes or changes in the toolkit have
  made them useless. Please report to their documentation and look in to their
  "Deprecated" section. This section should indicate what to do to replace
  this class in any affected code.
*/

/**
  \defgroup DataReadWrite Data Reading/Writing Objects

  Classes related to reading/writing data from/to disk.
*/

/**
  \defgroup WriterObjects Image Writing Objects
  \ingroup DataReadWrite

  Objects that allow writing to a file data produced by ITK filters.
*/