fw4spl
fwGdcmIO::writer::ie::SpatialFiducials Class Reference

Spatial Fiducials Information Entity class. More...

#include <SpatialFiducials.hpp>

+ Inheritance diagram for fwGdcmIO::writer::ie::SpatialFiducials:
+ Collaboration diagram for fwGdcmIO::writer::ie::SpatialFiducials:

Public Member Functions

FWGDCMIO_API SpatialFiducials (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const ::fwData::Image::csptr &series, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~SpatialFiducials ()
 Destructor.
 
virtual FWGDCMIO_API void writeSpatialFiducialsModule ()
 Write Spatial Fiducials Module tags. More...
 
virtual FWGDCMIO_API void writeCommonInstanceReferenceModule ()
 Write Common Instance Reference Module tags. More...
 
virtual FWGDCMIO_API void writeSOPCommonModule ()
 Write SOP Common Module tags. More...
 
- Public Member Functions inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
FWGDCMIO_API InformationEntity (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const std::shared_ptr< const ::fwData::Image > &object, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~InformationEntity ()
 Destructor.
 

Protected Member Functions

void writeLandmarks (::gdcm::SmartPointer< ::gdcm::SequenceOfItems > sequence) throw (::fwGdcmIO::exception::Failed)
 Write image landmarks into sequence.
 
void writeDistances (::gdcm::SmartPointer< ::gdcm::SequenceOfItems > sequence)
 Write image distances into sequence.
 
void addReferencedImage (int frameNumber,::gdcm::SmartPointer< ::gdcm::SequenceOfItems > referencedImageSequence) throw (::fwGdcmIO:: exception:: Failed)
 Add a frame number to the referenced image sequence. More...
 

Additional Inherited Members

- Public Types inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
typedef std::function< void(std::uint64_t) > ProgressCallback
 
typedef std::function< bool() > CancelRequestedCallback
 
- Protected Attributes inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
std::shared_ptr< ::gdcm::Writer > m_writer
 GDCM Writer.
 
std::shared_ptr< ::fwGdcmIO::container::DicomInstancem_instance
 DICOM Instance.
 
std::shared_ptr< const ::fwData::Imagem_object
 FW4SPL Object.
 
::fwLog::Logger::sptr m_logger
 Logger.
 
ProgressCallback m_progressCallback
 Progress callback for jobs.
 
CancelRequestedCallback m_cancelRequestedCallback
 Cancel information for jobs.
 

Detailed Description

Spatial Fiducials Information Entity class.

Definition at line 24 of file writer/ie/SpatialFiducials.hpp.

Constructor & Destructor Documentation

fwGdcmIO::writer::ie::SpatialFiducials::SpatialFiducials ( const std::shared_ptr< ::gdcm::Writer > &  writer,
const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &  instance,
const ::fwData::Image::csptr &  series,
const ::fwLog::Logger::sptr &  logger = nullptr,
ProgressCallback  progress = nullptr,
CancelRequestedCallback  cancel = nullptr 
)

Constructor.

Parameters
[in]writerGDCM writer that must be enriched
[in]instanceDICOM instance used to share information between modules
[in]seriesSeries data
[in]loggerLogger
[in]progressProgress callback
[in]cancelCancel requested callback

Definition at line 35 of file writer/ie/SpatialFiducials.cpp.

Member Function Documentation

void fwGdcmIO::writer::ie::SpatialFiducials::addReferencedImage ( int  frameNumber,
::gdcm::SmartPointer< ::gdcm::SequenceOfItems >  referencedImageSequence 
)
throw (::fwGdcmIO:: exception:: Failed
)
protected

Add a frame number to the referenced image sequence.

Parameters
[in]frameNumberFrame Number
[in]referencedImageSequenceDestination sequence

Definition at line 289 of file writer/ie/SpatialFiducials.cpp.

References fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_instance.

Referenced by writeLandmarks().

+ Here is the caller graph for this function:

void fwGdcmIO::writer::ie::SpatialFiducials::writeCommonInstanceReferenceModule ( )
virtual

Write Common Instance Reference Module tags.

See also
PS 3.3 C.12.2

Definition at line 205 of file writer/ie/SpatialFiducials.cpp.

References fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_instance, and fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer.

void fwGdcmIO::writer::ie::SpatialFiducials::writeSOPCommonModule ( )
virtual

Write SOP Common Module tags.

See also
PS 3.3 C.12.1

Definition at line 272 of file writer/ie/SpatialFiducials.cpp.

References fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer.

void fwGdcmIO::writer::ie::SpatialFiducials::writeSpatialFiducialsModule ( )
virtual

Write Spatial Fiducials Module tags.

See also
PS 3.3 C.21.2

Definition at line 54 of file writer/ie/SpatialFiducials.cpp.

References fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_instance, fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer, and writeLandmarks().

+ Here is the call graph for this function:


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