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

Writer series of image from a SimpleITK image. More...

#include <sitkImageSeriesWriter.h>

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

Public Types

using Self = ImageSeriesWriter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

SelfExecute (const Image &)
 
SelfExecute (const Image &image, const std::vector< std::string > &inFileNames, bool useCompression, int compressionLevel)
 
virtual std::vector< std::string > GetRegisteredImageIOs () const
 Get a vector of the names of registered itk ImageIOs. More...
 
 ImageSeriesWriter ()
 
std::string ToString () const override
 
 ~ImageSeriesWriter () override
 
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...
 
std::string GetName () const override
 
SelfSetUseCompression (bool UseCompression)
 Enable compression if available for file type. More...
 
bool GetUseCompression () const
 Set/Get name of ImageIO to use. More...
 
SelfUseCompressionOn ()
 Set/Get name of ImageIO to use. More...
 
SelfUseCompressionOff ()
 Set/Get name of ImageIO to use. 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...
 
SelfSetFileNames (const std::vector< std::string > &fileNames)
 
const std::vector< std::string > & GetFileNames () const
 
- 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
 

Protected Member Functions

template<class TImageType >
SelfExecuteInternal (const Image &inImage)
 
- 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
 

Private Types

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

Private Member Functions

itk::SmartPointer< ImageIOBaseGetImageIOBase (const std::string &fileName)
 

Private Attributes

int m_CompressionLevel
 
std::string m_Compressor
 
std::vector< std::string > m_FileNames
 
std::string m_ImageIOName
 
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...
 
- 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

Writer series of image from a SimpleITK image.

The ImageSeriesWriter is for writing a 3D image as a series of 2D images. A list of names for the series of 2D images must be provided, and an exception will be generated if the number of file names does not match the size of the image in the z-direction.

DICOM series cannot be written with this class, as an exception will be generated. To write a DICOM series the individual slices must be extracted, proper DICOM tags must be added to the dictionaries, then written with the ImageFileWriter.

See also
itk::simple::WriteImage for the procedural interface

Definition at line 49 of file sitkImageSeriesWriter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Definition at line 140 of file sitkImageSeriesWriter.h.

◆ Self

Definition at line 53 of file sitkImageSeriesWriter.h.

Constructor & Destructor Documentation

◆ ~ImageSeriesWriter()

itk::simple::ImageSeriesWriter::~ImageSeriesWriter ( )
override

◆ ImageSeriesWriter()

itk::simple::ImageSeriesWriter::ImageSeriesWriter ( )

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Self& itk::simple::ImageSeriesWriter::Execute ( const Image image,
const std::vector< std::string > &  inFileNames,
bool  useCompression,
int  compressionLevel 
)

◆ ExecuteInternal()

template<class TImageType >
Self& itk::simple::ImageSeriesWriter::ExecuteInternal ( const Image inImage)
protected

◆ GetCompressionLevel()

int itk::simple::ImageSeriesWriter::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::ImageSeriesWriter::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.

◆ GetFileNames()

const std::vector<std::string>& itk::simple::ImageSeriesWriter::GetFileNames ( ) const

The filenames to where the image slices are written.

The number of filenames must match the number of slices in the image.

◆ GetImageIO()

virtual std::string itk::simple::ImageSeriesWriter::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::ImageSeriesWriter::GetImageIOBase ( const std::string &  fileName)
private

◆ GetName()

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

return user readable name of the filter

Implements itk::simple::ProcessObject.

Definition at line 83 of file sitkImageSeriesWriter.h.

◆ GetRegisteredImageIOs()

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

Get a vector of the names of registered itk ImageIOs.

◆ GetUseCompression()

bool itk::simple::ImageSeriesWriter::GetUseCompression ( ) 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.

◆ SetCompressionLevel()

Self& itk::simple::ImageSeriesWriter::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::ImageSeriesWriter::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.

◆ SetFileNames()

Self& itk::simple::ImageSeriesWriter::SetFileNames ( const std::vector< std::string > &  fileNames)

The filenames to where the image slices are written.

The number of filenames must match the number of slices in the image.

◆ SetImageIO()

virtual Self& itk::simple::ImageSeriesWriter::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.

◆ SetUseCompression()

Self& itk::simple::ImageSeriesWriter::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 formatts support compression.

◆ ToString()

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

Print ourselves to string

Reimplemented from itk::simple::ProcessObject.

◆ UseCompressionOff()

Self& itk::simple::ImageSeriesWriter::UseCompressionOff ( )
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 95 of file sitkImageSeriesWriter.h.

◆ UseCompressionOn()

Self& itk::simple::ImageSeriesWriter::UseCompressionOn ( )
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 94 of file sitkImageSeriesWriter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 143 of file sitkImageSeriesWriter.h.

Member Data Documentation

◆ m_CompressionLevel

int itk::simple::ImageSeriesWriter::m_CompressionLevel
private

Definition at line 147 of file sitkImageSeriesWriter.h.

◆ m_Compressor

std::string itk::simple::ImageSeriesWriter::m_Compressor
private

Definition at line 148 of file sitkImageSeriesWriter.h.

◆ m_FileNames

std::vector<std::string> itk::simple::ImageSeriesWriter::m_FileNames
private

Definition at line 150 of file sitkImageSeriesWriter.h.

◆ m_ImageIOName

std::string itk::simple::ImageSeriesWriter::m_ImageIOName
private

Definition at line 152 of file sitkImageSeriesWriter.h.

◆ m_MemberFactory

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

Definition at line 144 of file sitkImageSeriesWriter.h.

◆ m_UseCompression

bool itk::simple::ImageSeriesWriter::m_UseCompression
private

Definition at line 146 of file sitkImageSeriesWriter.h.


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