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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* 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.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkRegion_h
#define itkRegion_h
#include "itkObject.h"
#include "itkCommonEnums.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
* \ingroup ITKCommon
*/
class ITKCommon_EXPORT Region
{
public:
ITK_DEFAULT_COPY_AND_MOVE(Region);
/** Standard class type aliases. */
using Self = Region;
using RegionEnum = ObjectEnums::RegionEnum;
#if !defined(ITK_LEGACY_REMOVE)
/**Exposes enums values for backwards compatibility*/
static constexpr RegionEnum ITK_UNSTRUCTURED_REGION = RegionEnum::ITK_UNSTRUCTURED_REGION;
static constexpr RegionEnum ITK_STRUCTURED_REGION = RegionEnum::ITK_STRUCTURED_REGION;
#endif
/** \see LightObject::GetNameOfClass() */
itkVirtualGetNameOfClassMacro(Region);
/** Subclasses must return a region type describing whether the region
* is structured or unstructured. */
virtual RegionEnum
GetRegionType() const = 0;
/** Print the region. */
virtual void
Print(std::ostream & os, Indent indent = 0) const;
Region() = default;
virtual ~Region() = default;
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
|
