mitkPACSPlugin.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef MITKCHILIPLUGIN_H_HEADER_INCLUDED_C1EBD0AD
#define MITKCHILIPLUGIN_H_HEADER_INCLUDED_C1EBD0AD

#include "mitkDataStorage.h"
#include "MitkExtExports.h"

namespace mitk {

class MitkExt_EXPORT PACSPlugin : public itk::Object
{
  public:

    struct MitkExt_EXPORT PACSPluginCapability
    {
      bool IsPACSFunctional;  // is there actually a real PACS connectivity implemented, configured and working right now?
      bool HasLoadCapability; // can the current implementation load data from a PACS?
      bool HasSaveCapability; // can the current implementation save data into the PACS?
    };

    class MitkExt_EXPORT PatientInformation
    {
      public:
        std::string UID; // application specific
        std::string PatientsName;       // tag 0010,0010
        std::string PatientID;          // tag 0010,0020
        std::string PatientsBirthDate;  // tag 0010,0030
        std::string PatientsBirthTime;  // tag 0010,0032
        std::string PatientsSex;        // tag 0010,0040
        std::string PatientComments;    // tag 0010,4000
    };

    typedef std::list<PatientInformation> PatientInformationList;

    class MitkExt_EXPORT StudyInformation
    {
      public:
        std::string StudyInstanceUID;   // tag 0020,000D
        std::string StudyID;            // tag 0020,0010
        std::string StudyDate;          // tag 0008,0020
        std::string StudyTime;          // tag 0008,0030
        std::string AccessionNumber;    // tag 0008,0050
        std::string ModalitiesInStudy;  // tag 0008,0061
        std::string ReferringPhysician; // tag 0008,0090
        std::string StudyDescription;   // tag 0008,1030
    };

    typedef std::list<StudyInformation> StudyInformationList;

    class MitkExt_EXPORT SeriesInformation
    {
      public:
        std::string SeriesInstanceUID;  // tag 0020,000E
        int SeriesNumber;               // tag 0020,0011
        std::string SeriesDate;         // tag 0008,0021
        std::string SeriesTime;         // tag 0008,0031
        std::string SeriesDescription;  // tag 0008,103E
        std::string BodyPartExamined;   // tag 0018,0015
        std::string FrameOfReferenceUID;// tag 0020,0052
        int AcquisitionNumber;          // tag 0020,0012 image specific
        std::string ContrastAgent;      // tag 0018,0010 image specific
        std::string ScanningSequence;   // tag 0018,0020 mr image specific
        int EchoNumber;                 // tag 0018,0086 mr image specific
        int TemporalPosition;           // tag 0020,0100 mr image specific

        SeriesInformation()
          : SeriesNumber(-1),
            AcquisitionNumber(-1),
            EchoNumber(-1),
            TemporalPosition(-1)
        {
        }
    };

    typedef std::list<SeriesInformation> SeriesInformationList;

    class MitkExt_EXPORT DocumentInformation
    {
      public:
        std::string SeriesInstanceUID;  // tag 0020,000E
        unsigned int InstanceNumber;    // tag 0020,0013
        std::string MimeType;           // tag 0042,0012
        std::string ContentDate;        // tag 0008,0023
        std::string DocumentTitle;      // tag 0042,0010

        DocumentInformation()
        :InstanceNumber( (unsigned int)-1 )
        {
        }
    };

    typedef std::list<DocumentInformation> DocumentInformationList;

    mitkClassMacro( PACSPlugin,itk::Object );

    static PACSPlugin* GetInstance( bool destroyInstance = false );

    virtual PACSPluginCapability GetPluginCapabilities();

    virtual PatientInformationList GetPatientInformationList();

    virtual StudyInformationList GetStudyInformationList( const PatientInformation& patient );

    virtual SeriesInformationList GetSeriesInformationList( const std::string& studyInstanceUID = "" );

    virtual DocumentInformationList GetDocumentInformationList( const std::string& seriesInstanceUID = "" );

    virtual PatientInformation GetPatientInformation( const std::string& seriesInstanceUID = "" );

    virtual StudyInformation GetStudyInformation( const std::string& seriesInstanceUID = "" );

    virtual SeriesInformation GetSeriesInformation( const std::string& seriesInstanceUID = "" );

    virtual DocumentInformation GetDocumentInformation( const std::string& seriesInstanceUID,
                                                        unsigned int instanceNumber );

    virtual unsigned int GetLightboxCount();

    virtual unsigned int GetActiveLightbox();

    virtual void SetReaderType( unsigned int readerType = 0 );

    virtual void AbortPACSImport();

    virtual std::vector<DataNode::Pointer> LoadImagesFromLightbox( unsigned int lightboxIndex = 0 );

    virtual std::vector<DataNode::Pointer> LoadFromSeries( const std::string& seriesInstanceUID );

    virtual std::vector<DataNode::Pointer> LoadImagesFromSeries( const std::string& seriesInstanceUID );

    virtual std::vector<mitk::DataNode::Pointer> LoadImagesFromSeries( std::vector<std::string> seriesInstanceUIDs );

    virtual std::vector<DataNode::Pointer> LoadTextsFromSeries( const std::string& seriesInstanceUID );

    virtual DataNode::Pointer LoadSingleText( const std::string& seriesInstanceUID, unsigned int instanceNumber );

    virtual void DownloadSingleFile( const std::string& seriesInstanceUID,
                                     unsigned int instanceNumber,
                                     const std::string& filename );

    virtual void SaveAsNewSeries( DataStorage::SetOfObjects::ConstPointer inputNodes,
                                  const std::string& studyInstanceUID,
                                  int seriesNumber,
                                  const std::string& seriesDescription );

    virtual void SaveToSeries( DataStorage::SetOfObjects::ConstPointer inputNodes,
                               const std::string& seriesInstanceUID,
                               bool overwriteExistingSeries );

    virtual void UploadFileAsNewSeries( const std::string& filename,
                                        const std::string& mimeType,
                                        const std::string& studyInstanceUID,
                                        int seriesNumber,
                                        const std::string& seriesDescription );

    virtual void UploadFileToSeries( const std::string& filename,
                                     const std::string& filebasename,
                                     const std::string& mimeType,
                                     const std::string& seriesInstanceUID,
                                     bool overwriteExistingSeries );

    virtual std::string GuessMIMEType( const std::string& filename );


  protected:

    // All this is hidden, should be instantiated through the GetInstance() method.
    itkNewMacro( PACSPlugin );
    PACSPlugin();
    virtual ~PACSPlugin();

    int m_ReaderType;
};

} // end namespace

#endif