mitkDICOMFileReader.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkDICOMFileReader_h
#define mitkDICOMFileReader_h
 
#include "itkObjectFactory.h"
#include "mitkCommon.h"
 
#include "MitkDICOMExports.h"
 
#include "mitkDICOMTagCache.h"
 
#include "mitkDICOMImageBlockDescriptor.h"
 
#include <unordered_map>
 
namespace mitk
{
// TODO Philips3D!
// TODO https://phabricator.mitk.org/T11572 ?
 
class MITKDICOM_EXPORT DICOMFileReader : public itk::Object
{
public:
  mitkClassMacroItkParent( DICOMFileReader, itk::Object );
 
  static bool IsDICOM( const std::string& filename );
  virtual bool CanHandleFile( const std::string& filename ) = 0;
 
  void SetInputFiles( const StringList& filenames );
  const StringList& GetInputFiles() const;
 
  virtual void AnalyzeInputFiles() = 0;
 
  unsigned int GetNumberOfOutputs() const;
  const DICOMImageBlockDescriptor& GetOutput( unsigned int index ) const;
 
  // void AllocateOutputImages(); TODO for later implementation of slice-by-slice loading
 
  virtual bool LoadImages() = 0;
 
  virtual DICOMTagPathList GetTagsOfInterest() const = 0;
 
  virtual void SetTagCache( const DICOMTagCache::Pointer& ) = 0;
 
  void SetConfigurationLabel( const std::string& );
  std::string GetConfigurationLabel() const;
  void SetConfigurationDescription( const std::string& );
  std::string GetConfigurationDescription() const;
 
  void PrintConfiguration( std::ostream& os ) const;
  void PrintOutputs( std::ostream& os, bool filenameDetails = false ) const;
 
  virtual bool operator==( const DICOMFileReader& other ) const = 0;
 
  typedef DICOMImageBlockDescriptor::AdditionalTagsMapType AdditionalTagsMapType;
  virtual void SetAdditionalTagsOfInterest(const AdditionalTagsMapType& tagList);
 
  virtual void SetTagLookupTableToPropertyFunctor(
    mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor functor );
 
protected:
  DICOMFileReader();
  ~DICOMFileReader() override;
 
  DICOMFileReader( const DICOMFileReader& other );
  DICOMFileReader& operator=( const DICOMFileReader& other );
 
  void ClearOutputs();
  void SetNumberOfOutputs( unsigned int numberOfOutputs );
  void SetOutput( unsigned int index, const DICOMImageBlockDescriptor& output );
 
  DICOMImageBlockDescriptor& InternalGetOutput( unsigned int index );
 
  virtual void InternalPrintConfiguration( std::ostream& os ) const = 0;
 
  virtual AdditionalTagsMapType GetAdditionalTagsOfInterest() const;
 
  mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor GetTagLookupTableToPropertyFunctor() const;
 
 
private:
  StringList m_InputFilenames;
  std::vector<DICOMImageBlockDescriptor> m_Outputs;
 
  std::string m_ConfigLabel;
  std::string m_ConfigDescription;
 
  AdditionalTagsMapType m_AdditionalTagsOfInterest;
  mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor m_TagLookupTableToPropertyFunctor;
};
}
 
#endif