fw4spl
|
This class handles DICOM files writing. It defines needs of data storage and delegates writing to appropriate tools. It manages all related data of one patient. More...
#include <Series.hpp>
Public Types | |
enum | FiducialsExportMode { SPATIAL_FIDUCIALS = 1, COMPREHENSIVE_SR = 2, COMPREHENSIVE_3D_SR = 3 } |
typedef std::map< std::string, std::shared_ptr< ::fwGdcmIO::container::DicomInstance > > | DicomInstanceMapType |
![]() | |
typedef ::fwMedData::Series | DataType |
the object type related | |
![]() | |
typedef std::function< void(std::uint64_t) > | ProgressCallback |
typedef std::function< void() > | CancelCallback |
typedef ::fwDataIO::writer::factory::Key | Key |
![]() | |
typedef ::boost::signals2::signal< void(float, std::string) > | ProgessSignal |
define a boost signal signature for the ProgessHandler | |
typedef ProgessSignal::slot_type | ProgessHandler |
define the ProgessHandler type | |
Public Member Functions | |
virtual bool | isA (const std::string &type) const override |
FWGDCMIO_API | Series (::fwDataIO::writer::IObjectWriter::Key key) |
Constructor. | |
FWGDCMIO_API | ~Series () |
Destructor. | |
FWGDCMIO_API void | write () override throw (::fwGdcmIO::exception::Failed) |
Load and start appropriate writing tools. In addition, it creates an adapted folder tree where DICOM files will be stored. It manages writing of the following general DICOM modules : patient, study and series. More... | |
FWGDCMIO_API std::string | extension () override |
Do nothing. More... | |
const FiducialsExportMode & | getFiducialsExportMode () const |
Get Fiducials Export Mode. | |
void | setFiducialsExportMode (const FiducialsExportMode &fiducialsExportMode) |
Set Fiducials Export Mode);. | |
![]() | |
GenericObjectWriter () | |
Constructor. Do nothing. | |
virtual | ~GenericObjectWriter () |
Destructor. Do nothing. | |
virtual void | setObject (::fwTools::Object::csptr obj) override |
m_object setter. More... | |
virtual std::shared_ptr< const DataType > | getConcreteObject () const |
m_object getter. More... | |
![]() | |
virtual FWDATAIO_API void | setLocation (const ::fwData::location::ILocation::sptr location) |
m_location setter. More... | |
virtual FWDATAIO_API::fwData::location::ILocation::sptr | getLocation () |
m_location getter. More... | |
virtual FWDATAIO_API::fwTools::Object::csptr | getObject () const |
m_object getter. More... | |
virtual FWDATAIO_API void | cancel () |
Requests writer abortion. | |
virtual std::shared_ptr< ::fwJobs::IJob > | getJob () const |
Returns the internal job, nullptr by default. | |
![]() | |
![]() | |
enableFolder (::fwDataIO::writer::IObjectWriter *rw) | |
constructor More... | |
void | setFolder (ILocation::PathType folder) |
Set folder filesystem path. | |
ILocation::PathType | getFolder () |
Get folder filesystem path. | |
void | setRecursive (bool val) |
Set the flag if folder location is recursive. | |
bool | getRecursive () |
Get the flag if folder location is recursive. | |
![]() | |
FWTOOLS_API void | addHandler (const ProgessHandler &handler) |
FWTOOLS_API void | notifyProgress (float percent, const std::string &msg="") const |
notify modification for all handler | |
Static Public Member Functions | |
static bool | isTypeOf (const std::string &type) |
![]() | |
static bool | isTypeOf (const std::string &type) |
static const std::string & | classname () |
return full object's classname with its namespace, i.e. fwCore::BaseObject | |
![]() | |
static bool | isTypeOf (const std::string &type) |
static const std::string & | leafClassname () |
return object's classname without its namespace, i.e. BaseObject | |
static const std::string & | classname () |
return object's classname without its namespace, i.e. BaseObject | |
![]() | |
static bool | isTypeOf (const std::string &type) |
static const std::string & | leafClassname () |
return object's classname without its namespace, i.e. BaseObject | |
static const std::string & | classname () |
return object's classname without its namespace, i.e. BaseObject | |
Friends | |
template<class , class , class > | |
class | ::fwTools::ClassFactory |
class | ::fwTools::Factory |
Demangling methods | |
virtual const std::string & | getLeafClassname () const override |
return object's classname without its namespace, i.e. BaseObject | |
virtual const std::string & | getClassname () const override |
return full object's classname with its namespace, i.e. fwCore::BaseObject | |
static const std::string & | leafClassname () |
return object's classname without its namespace, i.e. BaseObject | |
static const std::string & | classname () |
return object's classname without its namespace, i.e. BaseObject | |
Additional Inherited Members | |
![]() | |
FWDATAIO_API | IObjectWriter () |
Constructor. Do nothing. | |
virtual FWDATAIO_API | ~IObjectWriter () |
Destructor. Do nothing. | |
![]() | |
::fwTools::Object::cwptr | m_object |
Object write on filesystem by the process. More... | |
::fwData::location::ILocation::sptr | m_location |
Object location ( file path, directory path, url, etc ) | |
std::string | m_extension |
Extension of file format. | |
![]() | |
ProgessSignal | m_progressSignal |
to notify progress simply use m_progressSignal( percent,msg ) to notify to Handler | |
This class handles DICOM files writing. It defines needs of data storage and delegates writing to appropriate tools. It manages all related data of one patient.
Definition at line 31 of file io/fwGdcmIO/include/fwGdcmIO/writer/Series.hpp.
Enumerator | |
---|---|
COMPREHENSIVE_SR |
Export Fiducials using SpatialFiducialsIOD |
COMPREHENSIVE_3D_SR |
Export Fiducials using ComprehensiveSRIOD |
Definition at line 41 of file io/fwGdcmIO/include/fwGdcmIO/writer/Series.hpp.
|
overridevirtual |
Do nothing.
Override
Implements fwDataIO::writer::IObjectWriter.
Definition at line 138 of file io/fwGdcmIO/src/fwGdcmIO/writer/Series.cpp.
|
overridevirtual |
Load and start appropriate writing tools. In addition, it creates an adapted folder tree where DICOM files will be stored. It manages writing of the following general DICOM modules : patient, study and series.
Implements fwDataIO::writer::IObjectWriter.
Definition at line 51 of file io/fwGdcmIO/src/fwGdcmIO/writer/Series.cpp.
References COMPREHENSIVE_3D_SR, fwDataIO::writer::GenericObjectWriter< ::fwMedData::Series >::getConcreteObject(), fwData::Object::getField(), fwData::location::enableFolder< ::fwDataIO::writer::IObjectWriter >::getFolder(), fwDataTools::fieldHelper::Image::m_imageDistancesId, fwDataTools::fieldHelper::Image::m_imageLandmarksId, SLM_ASSERT, SLM_WARN, SPTR, fwGdcmIO::writer::iod::CTMRImageIOD::write(), fwGdcmIO::writer::iod::ComprehensiveSRIOD::write(), fwGdcmIO::writer::iod::SpatialFiducialsIOD::write(), and fwGdcmIO::writer::iod::SurfaceSegmentationIOD::write().