forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkRegion.h
93 lines (75 loc) · 3.18 KB
/
itkRegion.h
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
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkRegion.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
Portions of this code are covered under the VTK copyright.
See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkRegion_h
#define __itkRegion_h
#include "itkObject.h"
namespace itk
{
/** \class Region
* \brief A region represents some portion or piece of data.
*
* Region is an abstract class that represents some portion or
* piece of a DataObject. A region is used by the pipeline when
* processing just a portion of the data, either because 1) memory
* limits dictate that the pipeline cannot fit the entire dataset
* into memory; 2) the user has requested that only a piece of the
* dataset is to be processed; or 3) parallel (multi-threaded)
* processing of the data is required.
*
* There are two types of regions in itk: a structured region that
* specifies a rectangular piece of an image (ImageRegion), and a
* unstructured region that specifies piece i of N total pieces
* (MeshRegion). Depending on the filter (its input and output
* types, and its position in the pipeline), ImageRegion or MeshRegion
* will be used to describe the region.
*
* Region is a light-weight object and not reference counted. This
* means that is behaves differently than ITK classes that are
* reference counted. For example, smart pointer access is not
* provided, and the (subclasses') constructor, destructor,
* copy constructor and operator= are all public.
*
* \sa ImageRegion
* \sa MeshRegion
* \ingroup DataRepresentation
*/
class ITKCommon_EXPORT Region
{
public:
/** Standard class typedefs. */
typedef Region Self;
/** Enums used to describe the extent types. */
enum RegionType {ITK_UNSTRUCTURED_REGION,ITK_STRUCTURED_REGION};
/** Standard part of all itk objects. */
itkTypeMacro(Region, None);
/** Subclasses must return a region type describing whether the region
* is structured or unstructured. */
virtual RegionType GetRegionType() const = 0;
/** Print the region. */
virtual void Print(std::ostream& os, Indent indent=0) const;
Region() {}
virtual ~Region() {}
protected:
/** Methods invoked by Print() to print information about the object
* including superclasses. Typically not called by the user (use Print()
* instead) but used in the hierarchical print process to combine the
* output of several classes. */
virtual void PrintSelf(std::ostream& os, Indent indent) const;
virtual void PrintHeader(std::ostream& os, Indent indent) const;
virtual void PrintTrailer(std::ostream& os, Indent indent) const;
private:
};
} // end namespace itk
#endif