ITK  5.4.0
Insight Toolkit
itkLabelObjectLine.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkLabelObjectLine_h
19 #define itkLabelObjectLine_h
20 
21 #include "itkIndex.h"
22 #include "itkIndent.h"
23 
24 namespace itk
25 {
41 template <unsigned int VImageDimension>
42 class ITK_TEMPLATE_EXPORT LabelObjectLine
43 {
44 public:
45  static constexpr unsigned int ImageDimension = VImageDimension;
46 
49 
51  LabelObjectLine(const IndexType & idx, const LengthType & length);
52  virtual ~LabelObjectLine() = default;
53 
57  void
58  SetIndex(const IndexType & idx);
59 
60  const IndexType &
61  GetIndex() const;
62 
66  void
67  SetLength(const LengthType length);
68 
69  const LengthType &
70  GetLength() const;
71 
75  bool
76  HasIndex(const IndexType idx) const;
77 
78  bool
79  IsNextIndex(const IndexType & idx) const;
80 
82  void
83  Print(std::ostream & os, Indent indent = 0) const;
84 
85 protected:
90  virtual void
91  PrintSelf(std::ostream & os, Indent indent) const;
92 
93  virtual void
94  PrintHeader(std::ostream & os, Indent indent) const;
95 
96  virtual void
97  PrintTrailer(std::ostream & os, Indent indent) const;
98 
99 private:
100  IndexType m_Index{};
101  LengthType m_Length{};
102 };
103 } // end namespace itk
104 
105 #ifndef ITK_MANUAL_INSTANTIATION
106 # include "itkLabelObjectLine.hxx"
107 #endif
108 
109 #endif
itk::Index< VImageDimension >
itk::LabelObjectLine::LengthType
SizeValueType LengthType
Definition: itkLabelObjectLine.h:48
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itkIndent.h
itkIndex.h
itk::LabelObjectLine
Definition: itkLabelObjectLine.h:42
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83