itkGDCMSeriesFileNames.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 itkGDCMSeriesFileNames_h
#define itkGDCMSeriesFileNames_h
 
#include "itkProcessObject.h"
#include "itkObjectFactory.h"
#include "itkMacro.h"
#include <map>
#include <utility>
#include <vector>
#include "ITKIOGDCMExport.h"
 
namespace itk
{

using FilenamesContainer = std::vector<std::string>;
using SerieUIDContainer = std::vector<std::string>;
 
class ITKIOGDCM_EXPORT GDCMSeriesFileNames : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GDCMSeriesFileNames);

  using Self = GDCMSeriesFileNames;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;

  using FileNamesContainerType = FilenamesContainer;

  using SeriesUIDContainerType = SerieUIDContainer;

  itkNewMacro(Self);

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

  void
  SetInputDirectory(const char * name);

  void
  SetInputDirectory(const std::string & name);

  void
  SetDirectory(const std::string & name)
  {
    SetInputDirectory(name);
  }

  const FileNamesContainerType &
  GetInputFileNames();

  void
  SetOutputDirectory(const std::string & name)
  {
    m_OutputDirectory = name;
    this->Modified();
  }

  const FileNamesContainerType &
  GetOutputFileNames();

  const FileNamesContainerType &
  GetFileNames(const std::string serie);

  const SeriesUIDContainerType &
  GetSeriesUIDs();

  itkSetMacro(Recursive, bool);
  itkGetConstMacro(Recursive, bool);
  itkBooleanMacro(Recursive);

  void
  SetUseSeriesDetails(bool useSeriesDetails);

  bool
  GetUseSeriesDetails() const
  {
    return m_UseSeriesDetails;
  }

  void
  AddSeriesRestriction(const std::string & tag);

  itkSetMacro(FailOnAmbiguousOrdering, bool);
  itkGetConstMacro(FailOnAmbiguousOrdering, bool);
  itkBooleanMacro(FailOnAmbiguousOrdering);

  itkGetConstMacro(DidUseAmbiguousOrdering, bool);

  itkSetMacro(LoadSequences, bool);
  itkGetConstMacro(LoadSequences, bool);
  itkBooleanMacro(LoadSequences);

  itkSetMacro(LoadPrivateTags, bool);
  itkGetConstMacro(LoadPrivateTags, bool);
  itkBooleanMacro(LoadPrivateTags);
protected:
  GDCMSeriesFileNames();
  ~GDCMSeriesFileNames() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  std::string m_InputDirectory = "";

  std::string m_OutputDirectory = "";

  FileNamesContainerType m_InputFileNames{};
  FileNamesContainerType m_OutputFileNames{};

  void
  BuildSeriesMap();

  struct SeriesEntry
  {
    FileNamesContainerType Files{};
    bool                   Ordered{ false };
  };

  void
  OrderSeries(SeriesEntry & entry);

  std::map<std::string, SeriesEntry> m_SeriesFiles{};

  std::map<std::string, std::string> m_InstanceNumbers{};

  std::vector<std::pair<unsigned short, unsigned short>> m_UserRefineTags{};

  TimeStamp m_CacheBuildTime{};

  SeriesUIDContainerType m_SeriesUIDs{};
 
  bool m_UseSeriesDetails = false;
  bool m_FailOnAmbiguousOrdering = true;
  bool m_DidUseAmbiguousOrdering = false;
  bool m_Recursive = false;
  bool m_LoadSequences = false;
  bool m_LoadPrivateTags = false;
};
} // namespace itk
 
#endif // itkGDCMSeriesFileNames_h