SimpleITK  2.0.0rc2.post21
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ImageFileWriter Class Reference

Write out a SimpleITK image to the specified file location. More...

#include <sitkImageFileWriter.h>

+ Inheritance diagram for itk::simple::ImageFileWriter:
+ Collaboration diagram for itk::simple::ImageFileWriter:

Public Types

using PixelIDTypeList = NonLabelPixelIDTypeList
 
using Self = ImageFileWriter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

SelfExecute (const Image &)
 
SelfExecute (const Image &, const std::string &inFileName, bool useCompression, int compressionLevel)
 
std::string GetFileName () const
 
std::string GetName () const override
 
virtual std::vector< std::string > GetRegisteredImageIOs () const
 Get a vector of the names of registered itk ImageIOs. More...
 
 ImageFileWriter ()
 
SelfSetFileName (const std::string &fileName)
 
std::string ToString () const override
 
 ~ImageFileWriter () override
 
SelfSetUseCompression (bool UseCompression)
 Enable compression if available for file type. More...
 
bool GetUseCompression () const
 Enable compression if available for file type. More...
 
SelfUseCompressionOn ()
 Enable compression if available for file type. More...
 
SelfUseCompressionOff ()
 Enable compression if available for file type. More...
 
SelfSetCompressionLevel (int)
 A hint for the amount of compression to be applied during writing. More...
 
int GetCompressionLevel () const
 A hint for the amount of compression to be applied during writing. More...
 
SelfSetCompressor (const std::string &)
 A compression algorithm hint. More...
 
std::string GetCompressor ()
 A compression algorithm hint. More...
 
virtual SelfSetImageIO (const std::string &imageio)
 Set/Get name of ImageIO to use. More...
 
virtual std::string GetImageIO () const
 Set/Get name of ImageIO to use. More...
 
SelfSetKeepOriginalImageUID (bool KeepOriginalImageUID)
 Use the original study/series/frame of reference. More...
 
bool GetKeepOriginalImageUID () const
 Set/Get name of ImageIO to use. More...
 
SelfKeepOriginalImageUIDOn ()
 Set/Get name of ImageIO to use. More...
 
SelfKeepOriginalImageUIDOff ()
 Set/Get name of ImageIO to use. More...
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

typedef Self &(Self::* MemberFunctionType) (const Image &)
 

Private Member Functions

template<class T >
SelfExecuteInternal (const Image &)
 
itk::SmartPointer< ImageIOBaseGetImageIOBase (const std::string &fileName)
 

Private Attributes

int m_CompressionLevel
 
std::string m_Compressor
 
std::string m_FileName
 
std::string m_ImageIOName
 
bool m_KeepOriginalImageUID
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseCompression
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Write out a SimpleITK image to the specified file location.

This writer tries to write the image out using the image's type to the location specified in FileName. If writing fails, an ITK exception is thrown.

See also
itk::simple::WriteImage for the procedural interface
Examples
FilterProgressReporting/FilterProgressReporting.cxx, ITKIntegration/ITKIntegration.cxx, Segmentation/ConnectedThresholdImageFilter.cxx, Segmentation/NeighborhoodConnectedImageFilter.cxx, and SimpleGaussian/SimpleGaussian.cxx.

Definition at line 48 of file sitkImageFileWriter.h.

Member Typedef Documentation

◆ MemberFunctionType

typedef Self&(Self::* itk::simple::ImageFileWriter::MemberFunctionType) (const Image &)
private

Definition at line 159 of file sitkImageFileWriter.h.

◆ PixelIDTypeList

Definition at line 55 of file sitkImageFileWriter.h.

◆ Self

Definition at line 52 of file sitkImageFileWriter.h.

Constructor & Destructor Documentation

◆ ~ImageFileWriter()

itk::simple::ImageFileWriter::~ImageFileWriter ( )
override

◆ ImageFileWriter()

itk::simple::ImageFileWriter::ImageFileWriter ( )

Member Function Documentation

◆ Execute() [1/2]

Self& itk::simple::ImageFileWriter::Execute ( const Image )

◆ Execute() [2/2]

Self& itk::simple::ImageFileWriter::Execute ( const Image ,
const std::string &  inFileName,
bool  useCompression,
int  compressionLevel 
)

◆ ExecuteInternal()

template<class T >
Self& itk::simple::ImageFileWriter::ExecuteInternal ( const Image )
private

◆ GetCompressionLevel()

int itk::simple::ImageFileWriter::GetCompressionLevel ( ) const

A hint for the amount of compression to be applied during writing.

After compression is enabled and if the itk::ImageIO support this option, then this value may be used. The range is dependent upon the compression algorithm used. It is generally 0-100 for JPEG like lossy compression and 0-9 for lossless zip or LZW like compression algorithms. Please see the specific itk::ImageIO for details.

◆ GetCompressor()

std::string itk::simple::ImageFileWriter::GetCompressor ( )

A compression algorithm hint.

The default is an empty string which enables the default compression of the ImageIO if compression is enabled. If the string identifier is not known a warning is produced and the default compressor is used. Please see the itk::ImageIO for details.

◆ GetFileName()

std::string itk::simple::ImageFileWriter::GetFileName ( ) const

◆ GetImageIO()

virtual std::string itk::simple::ImageFileWriter::GetImageIO ( ) const
virtual

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to write the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

◆ GetImageIOBase()

itk::SmartPointer<ImageIOBase> itk::simple::ImageFileWriter::GetImageIOBase ( const std::string &  fileName)
private

◆ GetKeepOriginalImageUID()

bool itk::simple::ImageFileWriter::GetKeepOriginalImageUID ( ) const

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to write the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

◆ GetName()

std::string itk::simple::ImageFileWriter::GetName ( ) const
inlineoverridevirtual

return user readable name of the filter

Implements itk::simple::ProcessObject.

Definition at line 65 of file sitkImageFileWriter.h.

◆ GetRegisteredImageIOs()

virtual std::vector<std::string> itk::simple::ImageFileWriter::GetRegisteredImageIOs ( ) const
virtual

Get a vector of the names of registered itk ImageIOs.

◆ GetUseCompression()

bool itk::simple::ImageFileWriter::GetUseCompression ( ) const

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formats support compression.

◆ KeepOriginalImageUIDOff()

Self& itk::simple::ImageFileWriter::KeepOriginalImageUIDOff ( )
inline

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to write the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

Definition at line 135 of file sitkImageFileWriter.h.

◆ KeepOriginalImageUIDOn()

Self& itk::simple::ImageFileWriter::KeepOriginalImageUIDOn ( )
inline

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to write the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

Definition at line 134 of file sitkImageFileWriter.h.

◆ SetCompressionLevel()

Self& itk::simple::ImageFileWriter::SetCompressionLevel ( int  )

A hint for the amount of compression to be applied during writing.

After compression is enabled and if the itk::ImageIO support this option, then this value may be used. The range is dependent upon the compression algorithm used. It is generally 0-100 for JPEG like lossy compression and 0-9 for lossless zip or LZW like compression algorithms. Please see the specific itk::ImageIO for details.

◆ SetCompressor()

Self& itk::simple::ImageFileWriter::SetCompressor ( const std::string &  )

A compression algorithm hint.

The default is an empty string which enables the default compression of the ImageIO if compression is enabled. If the string identifier is not known a warning is produced and the default compressor is used. Please see the itk::ImageIO for details.

◆ SetFileName()

Self& itk::simple::ImageFileWriter::SetFileName ( const std::string &  fileName)

◆ SetImageIO()

virtual Self& itk::simple::ImageFileWriter::SetImageIO ( const std::string &  imageio)
virtual

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to write the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

◆ SetKeepOriginalImageUID()

Self& itk::simple::ImageFileWriter::SetKeepOriginalImageUID ( bool  KeepOriginalImageUID)

Use the original study/series/frame of reference.

These methods Set/Get/Toggle the KeepOriginalImageUID flag which get's passed to image file's itk::ImageIO object. This is relevant only for the DICOM file format, configuring the writer to use the information in the image's meta-data dictionary or to create new study/series/frame of reference values.

◆ SetUseCompression()

Self& itk::simple::ImageFileWriter::SetUseCompression ( bool  UseCompression)

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formats support compression.

◆ ToString()

std::string itk::simple::ImageFileWriter::ToString ( ) const
overridevirtual

Print ourselves to string

Reimplemented from itk::simple::ProcessObject.

◆ UseCompressionOff()

Self& itk::simple::ImageFileWriter::UseCompressionOff ( )
inline

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formats support compression.

Definition at line 82 of file sitkImageFileWriter.h.

◆ UseCompressionOn()

Self& itk::simple::ImageFileWriter::UseCompressionOn ( )
inline

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formats support compression.

Definition at line 81 of file sitkImageFileWriter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 162 of file sitkImageFileWriter.h.

Member Data Documentation

◆ m_CompressionLevel

int itk::simple::ImageFileWriter::m_CompressionLevel
private

Definition at line 151 of file sitkImageFileWriter.h.

◆ m_Compressor

std::string itk::simple::ImageFileWriter::m_Compressor
private

Definition at line 152 of file sitkImageFileWriter.h.

◆ m_FileName

std::string itk::simple::ImageFileWriter::m_FileName
private

Definition at line 154 of file sitkImageFileWriter.h.

◆ m_ImageIOName

std::string itk::simple::ImageFileWriter::m_ImageIOName
private

Definition at line 156 of file sitkImageFileWriter.h.

◆ m_KeepOriginalImageUID

bool itk::simple::ImageFileWriter::m_KeepOriginalImageUID
private

Definition at line 155 of file sitkImageFileWriter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ImageFileWriter::m_MemberFactory
private

Definition at line 164 of file sitkImageFileWriter.h.

◆ m_UseCompression

bool itk::simple::ImageFileWriter::m_UseCompression
private

Definition at line 150 of file sitkImageFileWriter.h.


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