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
|
/*=========================================================================
*
* 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.
*
*=========================================================================*/
#ifndef itkRegionConstrainedSubsampler_h
#define itkRegionConstrainedSubsampler_h
#include "itkSubsamplerBase.h"
#include "itkImageRegion.h"
namespace itk
{
namespace Statistics
{
/**
* \class RegionConstrainedSubsampler
* \brief This an abstract subsampler that constrains subsamples
* to be contained within a given image region.
*
* This is an Abstract class that can not be instantiated.
* There are multiple subsamplers that derive from this class and
* provide specific implementations of subsampling strategies.
*
* This class is templatized over both the Sample and the Region
* with an assumed consistency between the Region and the way
* the Sample is generated.
*
* Use SetRegionConstraint(region) to provide the region
* constraint. All returned subsamples will be contained
* within this region. This assumes that the instance
* identifiers in the sample correspond to an offset
* computed with the provided region.
*
* \sa SubsamplerBase, SpatialNeighborSubsampler
* \sa GaussianRandomSpatialNeighborSubsampler
* \sa UniformRandomSpatialNeighborSubsampler
* \ingroup ITKStatistics
*/
template <typename TSample, typename TRegion>
class ITK_TEMPLATE_EXPORT RegionConstrainedSubsampler : public SubsamplerBase<TSample>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(RegionConstrainedSubsampler);
/** Standard class type aliases */
using Self = RegionConstrainedSubsampler<TSample, TRegion>;
using Superclass = SubsamplerBase<TSample>;
using Baseclass = typename Superclass::Baseclass;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(RegionConstrainedSubsampler);
/** type alias alias for the source data container */
using SampleType = TSample;
using SampleConstPointer = typename SampleType::ConstPointer;
using MeasurementVectorType = typename TSample::MeasurementVectorType;
using InstanceIdentifier = typename TSample::InstanceIdentifier;
using SubsampleType = Subsample<TSample>;
using SubsamplePointer = typename SubsampleType::Pointer;
using SubsampleConstIterator = typename SubsampleType::ConstIterator;
using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder;
/** type alias related to image region */
using RegionType = TRegion;
using IndexType = typename RegionType::IndexType;
using IndexValueType = typename IndexType::IndexValueType;
using SizeType = typename RegionType::SizeType;
/** Method to set the sample domain.
* This should correspond to the entire region of the input sample. */
void
SetSampleRegion(const RegionType & region);
/** Method to get the sample domain. */
itkGetConstReferenceMacro(SampleRegion, RegionType);
/** Method to get the flag indicating that the sample region has been initialized */
itkGetConstReferenceMacro(SampleRegionInitialized, bool);
/** Method to set the region constraint.
* Any subsamples selected must ALSO be inside this region. */
void
SetRegionConstraint(const RegionType & region);
/** Method to get the region constraint. */
itkGetConstReferenceMacro(RegionConstraint, RegionType);
/** Method to get the flag indicating that the region constraint has been initialized */
itkGetConstReferenceMacro(RegionConstraintInitialized, bool);
/** Main Search method that MUST be implemented by each subclass
* The Search method will find all points similar to query and return
* them as a Subsample. The definition of similar will be subclass-
* specific. And could mean spatial similarity or feature similarity
* etc. */
void
Search(const InstanceIdentifier & query, SubsamplePointer & results) override = 0;
protected:
/**
* Clone the current subsampler.
* This does a complete copy of the subsampler state
* to the new subsampler
*/
typename LightObject::Pointer
InternalClone() const override;
RegionConstrainedSubsampler();
~RegionConstrainedSubsampler() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
RegionType m_RegionConstraint{};
bool m_RegionConstraintInitialized{};
RegionType m_SampleRegion{};
bool m_SampleRegionInitialized{};
}; // end of class RegionConstrainedSubsampler
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkRegionConstrainedSubsampler.hxx"
#endif
#endif
|
