itkNumericSeriesFileNames.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 itkNumericSeriesFileNames_h
#define itkNumericSeriesFileNames_h
#include "ITKIOImageBaseExport.h"
 
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"
#include "itkMacro.h"
#include <vector>
 
namespace itk
{
class ITKIOImageBase_EXPORT NumericSeriesFileNames : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NumericSeriesFileNames);

  using Self = NumericSeriesFileNames;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(NumericSeriesFileNames);
 
  /* -------- Define the API for NumericSeriesFileNames ----------- */

  itkSetMacro(StartIndex, SizeValueType);
  itkGetConstMacro(StartIndex, SizeValueType);

  itkSetMacro(EndIndex, SizeValueType);
  itkGetConstMacro(EndIndex, SizeValueType);

  itkSetMacro(IncrementIndex, SizeValueType);
  itkGetConstMacro(IncrementIndex, SizeValueType);

  itkSetStringMacro(SeriesFormat);
  itkGetStringMacro(SeriesFormat);

  const std::vector<std::string> &
  GetFileNames();
 
protected:
  NumericSeriesFileNames();
  ~NumericSeriesFileNames() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  SizeValueType m_StartIndex{ 1 };
  SizeValueType m_EndIndex{ 1 };
  SizeValueType m_IncrementIndex{ 1 };

  std::string m_SeriesFormat{};
 
  std::vector<std::string> m_FileNames{};
};
} // namespace itk
 
#endif // itkNumericSeriesFileNames_h