Write out a SimpleITK image to the specified file location.
More...
#include <sitkImageFileWriter.h>
|
| 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 void | SetGlobalDefaultNumberOfThreads (unsigned int n) |
| |
| static unsigned int | GetGlobalDefaultNumberOfThreads () |
| |
| 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...
|
| |
| virtual unsigned long | AddITKObserver (const itk::EventObject &, itk::Command *) |
| |
| virtual itk::ProcessObject * | GetActiveProcess () |
| |
| virtual void | OnActiveProcessDelete () |
| |
| virtual void | onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT |
| |
| virtual void | PreUpdate (itk::ProcessObject *p) |
| |
| virtual void | RemoveITKObserver (EventCommand &e) |
| |
| | NonCopyable () |
| |
| template<class TImageType > |
| static TImageType::ConstPointer | CastImageToITK (const Image &img) |
| |
| template<class TImageType > |
| static Image | CastITKToImage (TImageType *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) |
| |
| static const itk::EventObject & | GetITKEventObject (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) |
| |
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.
| typedef Self&(Self::* itk::simple::ImageFileWriter::MemberFunctionType) (const Image &) |
|
private |
| virtual itk::simple::ImageFileWriter::~ImageFileWriter |
( |
| ) |
|
|
virtual |
| itk::simple::ImageFileWriter::ImageFileWriter |
( |
| ) |
|
| Self& itk::simple::ImageFileWriter::Execute |
( |
const Image & |
| ) |
|
| Self& itk::simple::ImageFileWriter::Execute |
( |
const Image & |
, |
|
|
const std::string & |
inFileName, |
|
|
bool |
useCompression |
|
) |
| |
template<class T >
| Self& itk::simple::ImageFileWriter::ExecuteInternal |
( |
const Image & |
| ) |
|
|
private |
| std::string itk::simple::ImageFileWriter::GetFileName |
( |
| ) |
const |
| virtual std::string itk::simple::ImageFileWriter::GetImageIO |
( |
void |
| ) |
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.
| bool itk::simple::ImageFileWriter::GetKeepOriginalImageUID |
( |
void |
| ) |
const |
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.
| virtual std::string itk::simple::ImageFileWriter::GetName |
( |
| ) |
const |
|
inlinevirtual |
| virtual std::vector<std::string> itk::simple::ImageFileWriter::GetRegisteredImageIOs |
( |
| ) |
const |
|
virtual |
Get a vector of the names of registered itk ImageIOs.
| bool itk::simple::ImageFileWriter::GetUseCompression |
( |
void |
| ) |
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.
| Self& itk::simple::ImageFileWriter::KeepOriginalImageUIDOff |
( |
void |
| ) |
|
|
inline |
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.
Definition at line 114 of file sitkImageFileWriter.h.
| Self& itk::simple::ImageFileWriter::KeepOriginalImageUIDOn |
( |
void |
| ) |
|
|
inline |
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.
Definition at line 113 of file sitkImageFileWriter.h.
| Self& itk::simple::ImageFileWriter::SetFileName |
( |
const std::string & |
fileName | ) |
|
| 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.
| 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.
| 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.
| virtual std::string itk::simple::ImageFileWriter::ToString |
( |
| ) |
const |
|
virtual |
| Self& itk::simple::ImageFileWriter::UseCompressionOff |
( |
void |
| ) |
|
|
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.
| Self& itk::simple::ImageFileWriter::UseCompressionOn |
( |
void |
| ) |
|
|
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.
| std::string itk::simple::ImageFileWriter::m_FileName |
|
private |
| std::string itk::simple::ImageFileWriter::m_ImageIOName |
|
private |
| bool itk::simple::ImageFileWriter::m_KeepOriginalImageUID |
|
private |
| bool itk::simple::ImageFileWriter::m_UseCompression |
|
private |
The documentation for this class was generated from the following file:
Inheritance diagram for itk::simple::ImageFileWriter:
