Medical Imaging Interaction Toolkit  2018.4.99-0a90f175
Medical Imaging Interaction Toolkit
mitk::CESTDICOMManualReaderService Class Reference

#include <mitkCESTGenericDICOMReaderService.h>

Inheritance diagram for mitk::CESTDICOMManualReaderService:
Collaboration diagram for mitk::CESTDICOMManualReaderService:

Public Member Functions

 CESTDICOMManualReaderService (const CustomMimeType &mimeType, const std::string &description)
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads the specified file or input stream and returns its contents. More...
 
Options GetOptions () const override
 returns a list of the supported options More...
 
us::Any GetOption (const std::string &name) const override
 
- Public Member Functions inherited from mitk::BaseDICOMReaderService
IFileReader::ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
- Public Member Functions inherited from mitk::AbstractFileReader
void SetInput (const std::string &location) override
 Set the input location. More...
 
void SetInput (const std::string &location, std::istream *is) override
 Set an input stream to read from. More...
 
std::string GetInputLocation () const override
 Get the current input location. More...
 
std::istream * GetInputStream () const override
 Get the input stream. More...
 
MimeType GetRegisteredMimeType () const
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
 
DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
 Reads the specified file or input stream, loading its contents into the provided DataStorage. More...
 
Options GetOptions () const override
 returns a list of the supported options More...
 
us::Any GetOption (const std::string &name) const override
 
void SetOptions (const Options &options) override
 
void SetOption (const std::string &name, const us::Any &value) override
 
void AddProgressCallback (const ProgressCallback &callback) override
 
void RemoveProgressCallback (const ProgressCallback &callback) override
 
us::ServiceRegistration< IFileReaderRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
std::vector< std::string > GetReadFiles () override
 
- Public Member Functions inherited from mitk::IFileReader
 ~IFileReader () override
 
virtual ~IFileReader ()
 
- Public Member Functions inherited from mitk::IFileIO
virtual ~IFileIO ()
 

Protected Member Functions

 CESTDICOMManualReaderService (const CESTDICOMManualReaderService &)=default
 
CESTDICOMManualReaderServiceoperator= (const CESTDICOMManualReaderService &)=delete
 
std::string GetCESTMetaFilePath () const
 
std::string GetTRECFilePath () const
 
std::string GetLISTFilePath () const
 
mitk::DICOMFileReader::Pointer GetReader (const mitk::StringList &relevantFiles) const override
 
- Protected Member Functions inherited from mitk::BaseDICOMReaderService
 BaseDICOMReaderService (const std::string &description)
 
 BaseDICOMReaderService (const mitk::CustomMimeType &customType, const std::string &description)
 
std::vector< itk::SmartPointer< BaseData > > DoRead () override
 
mitk::StringList GetDICOMFilesInSameDirectory () const
 
void SetOnlyRegardOwnSeries (bool)
 
bool GetOnlyRegardOwnSeries () const
 
- Protected Member Functions inherited from mitk::AbstractFileReader
 AbstractFileReader ()
 
 ~AbstractFileReader () override
 
 AbstractFileReader (const AbstractFileReader &other)
 
 AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 
std::string GetDescription () const
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 
std::string GetLocalFileName () const
 Get a local file name for reading. More...
 
virtual void SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
 

Additional Inherited Members

- Public Types inherited from mitk::IFileIO
enum  ConfidenceLevel { Unsupported, PartiallySupported, Supported }
 A confidence level describing the confidence of the reader or writer in handling the given data. More...
 
typedef std::map< std::string, us::AnyOptions
 Options for reading or writing data. More...
 
typedef mitk::MessageAbstractDelegate1< float > ProgressCallback
 
- Static Public Member Functions inherited from mitk::IFileIO
static std::string PROP_DESCRIPTION ()
 Service property name for a description. More...
 
static std::string PROP_MIMETYPE ()
 Service property name for the mime-type associated with this file writer. More...
 
- Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string > m_ReadFiles
 

Detailed Description

Service wrapper that auto selects (using the mitk::DICOMFileReaderSelector) the best DICOMFileReader from the DICOM module and loads the CEST relevant meta data from a provided cest_meta.json file or provided from the user as reader options.

Definition at line 25 of file mitkCESTGenericDICOMReaderService.h.

Constructor & Destructor Documentation

◆ CESTDICOMManualReaderService() [1/2]

mitk::CESTDICOMManualReaderService::CESTDICOMManualReaderService ( const CustomMimeType mimeType,
const std::string &  description 
)

◆ CESTDICOMManualReaderService() [2/2]

mitk::CESTDICOMManualReaderService::CESTDICOMManualReaderService ( const CESTDICOMManualReaderService )
protecteddefault

Member Function Documentation

◆ GetCESTMetaFilePath()

std::string mitk::CESTDICOMManualReaderService::GetCESTMetaFilePath ( ) const
protected

◆ GetLISTFilePath()

std::string mitk::CESTDICOMManualReaderService::GetLISTFilePath ( ) const
protected

◆ GetOption()

us::Any mitk::CESTDICOMManualReaderService::GetOption ( const std::string &  name) const
overridevirtual

Implements mitk::IFileIO.

◆ GetOptions()

Options mitk::CESTDICOMManualReaderService::GetOptions ( ) const
overridevirtual

returns a list of the supported options

Options are strings that are treated as flags when passed to the write method.

Implements mitk::IFileIO.

◆ GetReader()

mitk::DICOMFileReader::Pointer mitk::CESTDICOMManualReaderService::GetReader ( const mitk::StringList relevantFiles) const
overrideprotectedvirtual

Returns the reader instance that should be used. The decision may be based one the passed list of relevant files.

Implements mitk::BaseDICOMReaderService.

◆ GetTRECFilePath()

std::string mitk::CESTDICOMManualReaderService::GetTRECFilePath ( ) const
protected

◆ operator=()

CESTDICOMManualReaderService& mitk::CESTDICOMManualReaderService::operator= ( const CESTDICOMManualReaderService )
protecteddelete

◆ Read()

std::vector<itk::SmartPointer<BaseData> > mitk::CESTDICOMManualReaderService::Read ( )
overridevirtual

Reads the specified file or input stream and returns its contents.

Returns
A list of created BaseData objects.

If GetInputStream() returns a non-null value, this method must use the returned stream object to read the data from. If no input stream was set, the data must be read from the path returned by GetInputLocation().

Exceptions
mitk::Exception

Implements mitk::IFileReader.


The documentation for this class was generated from the following file: