itkLabelObjectLine.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkLabelObjectLine_h
#define itkLabelObjectLine_h
 
#include "itkMacro.h"
#include "itkIndex.h"
#include "itkIndent.h"
 
namespace itk
{
template <unsigned int VImageDimension>
class ITK_TEMPLATE_EXPORT LabelObjectLine
{
public:
  ITK_DEFAULT_COPY_AND_MOVE(LabelObjectLine);
 
  static constexpr unsigned int ImageDimension = VImageDimension;
 
  using IndexType = Index<VImageDimension>;
  using LengthType = SizeValueType;
 
  LabelObjectLine();
  LabelObjectLine(const IndexType & idx, const LengthType & length);
  virtual ~LabelObjectLine() = default;

  void
  SetIndex(const IndexType & idx);
 
  [[nodiscard]] const IndexType &
  GetIndex() const;

  void
  SetLength(const LengthType length);
 
  [[nodiscard]] const LengthType &
  GetLength() const;

  [[nodiscard]] bool
  HasIndex(const IndexType idx) const;
 
  [[nodiscard]] bool
  IsNextIndex(const IndexType & idx) const;

  void
  Print(std::ostream & os, Indent indent = 0) const;
 
protected:
  virtual void
  PrintSelf(std::ostream & os, Indent indent) const;
 
  virtual void
  PrintHeader(std::ostream & os, Indent indent) const;
 
  virtual void
  PrintTrailer(std::ostream & itkNotUsed(os), Indent itkNotUsed(indent)) const
  {}
 
private:
  IndexType  m_Index{};
  LengthType m_Length{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLabelObjectLine.hxx"
#endif
 
#endif