ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImageFileWriter< TInputImage > Class Template Reference
Data Processing Objects » Filters » Input and Output FiltersGroup IO » | Module ITKIOImageBase

#include <itkImageFileWriter.h>

Detailed Description

template<typename TInputImage>
class itk::ImageFileWriter< TInputImage >

Writes image data to a single file.

ImageFileWriter writes its input data to a single output file. ImageFileWriter interfaces with an ImageIO class to write out the data. If you wish to write data into a series of files (e.g., a slice per file) use ImageSeriesWriter.

A plugable factory pattern is used that allows different kinds of writers to be registered (even at run time) without having to modify the code in this class. You can either manually instantiate the ImageIO object and associate it with the ImageFileWriter, or let the class figure it out from the extension. Normally just setting the filename with a suitable suffix (".png", ".jpg", etc) and setting the input to the writer is enough to get the writer to work properly.

See also
ImageSeriesReader
ImageIOBase
ITK Sphinx Examples:
Examples
Examples/DataRepresentation/Image/Image5.cxx, Examples/DataRepresentation/Image/ImageAdaptor2.cxx, Examples/DataRepresentation/Image/ImageAdaptor3.cxx, Examples/DataRepresentation/Image/ImageAdaptor4.cxx, Examples/Filtering/AntiAliasBinaryImageFilter.cxx, Examples/Filtering/BilateralImageFilter.cxx, Examples/Filtering/BinaryMedianImageFilter.cxx, Examples/Filtering/BinaryMinMaxCurvatureFlowImageFilter.cxx, Examples/Filtering/BinaryThresholdImageFilter.cxx, Examples/Filtering/BinomialBlurImageFilter.cxx, Examples/Filtering/CannyEdgeDetectionImageFilter.cxx, Examples/Filtering/CompositeFilterExample.cxx, Examples/Filtering/CurvatureAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/CurvatureFlowImageFilter.cxx, Examples/Filtering/DanielssonDistanceMapImageFilter.cxx, Examples/Filtering/DerivativeImageFilter.cxx, Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/Filtering/DiscreteGaussianImageFilter.cxx, Examples/Filtering/FFTDirectInverse.cxx, Examples/Filtering/FFTDirectInverse2.cxx, Examples/Filtering/FFTImageFilter.cxx, Examples/Filtering/FFTImageFilterFourierDomainFiltering.cxx, Examples/Filtering/FlipImageFilter.cxx, Examples/Filtering/GaussianBlurImageFunction.cxx, Examples/Filtering/GradientAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/GradientMagnitudeImageFilter.cxx, Examples/Filtering/GradientMagnitudeRecursiveGaussianImageFilter.cxx, Examples/Filtering/GradientRecursiveGaussianImageFilter.cxx, Examples/Filtering/GradientVectorFlowImageFilter.cxx, Examples/Filtering/GrayscaleFunctionDilateImageFilter.cxx, Examples/Filtering/LaplacianImageFilter.cxx, Examples/Filtering/LaplacianRecursiveGaussianImageFilter1.cxx, Examples/Filtering/LaplacianRecursiveGaussianImageFilter2.cxx, Examples/Filtering/LaplacianSharpeningImageFilter.cxx, Examples/Filtering/MathematicalMorphologyBinaryFilters.cxx, Examples/Filtering/MathematicalMorphologyGrayscaleFilters.cxx, Examples/Filtering/MeanImageFilter.cxx, Examples/Filtering/MedianImageFilter.cxx, Examples/Filtering/MinMaxCurvatureFlowImageFilter.cxx, Examples/Filtering/MorphologicalImageEnhancement.cxx, Examples/Filtering/OrientImageFilter.cxx, Examples/Filtering/OtsuMultipleThresholdImageFilter.cxx, Examples/Filtering/OtsuThresholdImageFilter.cxx, Examples/Filtering/ResampleImageFilter.cxx, Examples/Filtering/ResampleImageFilter2.cxx, Examples/Filtering/ResampleImageFilter3.cxx, Examples/Filtering/ResampleImageFilter4.cxx, Examples/Filtering/ResampleImageFilter5.cxx, Examples/Filtering/ResampleImageFilter6.cxx, Examples/Filtering/ResampleImageFilter7.cxx, Examples/Filtering/ResampleImageFilter8.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/RGBCurvatureAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/RGBGradientAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/RGBToGrayscale.cxx, Examples/Filtering/ScaleSpaceGenerator2D.cxx, Examples/Filtering/SecondDerivativeRecursiveGaussianImageFilter.cxx, Examples/Filtering/SigmoidImageFilter.cxx, Examples/Filtering/SignedDanielssonDistanceMapImageFilter.cxx, Examples/Filtering/SmoothingRecursiveGaussianImageFilter.cxx, Examples/Filtering/SmoothingRecursiveGaussianImageFilter2.cxx, Examples/Filtering/SpatialObjectToImage1.cxx, Examples/Filtering/SpatialObjectToImage2.cxx, Examples/Filtering/SpatialObjectToImage3.cxx, Examples/Filtering/SubsampleVolume.cxx, Examples/Filtering/ThresholdImageFilter.cxx, Examples/Filtering/VectorCurvatureAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/VectorGradientAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/VectorIndexSelection.cxx, Examples/Filtering/VesselnessMeasureImageFilter.cxx, Examples/Filtering/VotingBinaryHoleFillingImageFilter.cxx, Examples/Filtering/VotingBinaryIterativeHoleFillingImageFilter.cxx, Examples/Filtering/WarpImageFilter1.cxx, Examples/Filtering/ZeroCrossingBasedEdgeDetectionImageFilter.cxx, Examples/IO/ComplexImageReadWrite.cxx, Examples/IO/CovariantVectorImageExtractComponent.cxx, Examples/IO/CovariantVectorImageRead.cxx, Examples/IO/CovariantVectorImageWrite.cxx, Examples/IO/DicomImageReadChangeHeaderWrite.cxx, Examples/IO/DicomImageReadWrite.cxx, Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite2.cxx, Examples/IO/ImageReadCastWrite.cxx, Examples/IO/ImageReadExportVTK.cxx, Examples/IO/ImageReadExtractFilterInsertWrite.cxx, Examples/IO/ImageReadExtractWrite.cxx, Examples/IO/ImageReadRegionOfInterestWrite.cxx, Examples/IO/ImageReadWrite.cxx, Examples/IO/ImageSeriesReadWrite.cxx, Examples/IO/ImageSeriesReadWrite2.cxx, Examples/IO/IOPlugin.cxx, Examples/IO/RGBImageReadWrite.cxx, Examples/IO/RGBImageSeriesReadWrite.cxx, Examples/IO/VectorImageReadWrite.cxx, Examples/IO/VisibleHumanPasteWrite.cxx, Examples/IO/VisibleHumanStreamReadWrite.cxx, Examples/Iterators/ImageLinearIteratorWithIndex.cxx, Examples/Iterators/ImageLinearIteratorWithIndex2.cxx, Examples/Iterators/NeighborhoodIterators1.cxx, Examples/Iterators/NeighborhoodIterators2.cxx, Examples/Iterators/NeighborhoodIterators3.cxx, Examples/Iterators/NeighborhoodIterators4.cxx, Examples/Iterators/NeighborhoodIterators5.cxx, Examples/Iterators/NeighborhoodIterators6.cxx, Examples/Iterators/ShapedNeighborhoodIterators1.cxx, Examples/Iterators/ShapedNeighborhoodIterators2.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/ChangeInformationImageFilter.cxx, Examples/RegistrationITKv4/DeformableRegistration1.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration11.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/DisplacementFieldInitialization.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration11.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration13.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistration5.cxx, Examples/RegistrationITKv4/ImageRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx, Examples/Segmentation/CannySegmentationLevelSetImageFilter.cxx, Examples/Segmentation/ConfidenceConnected.cxx, Examples/Segmentation/ConfidenceConnected3D.cxx, Examples/Segmentation/ConnectedThresholdImageFilter.cxx, Examples/Segmentation/CurvesLevelSetImageFilter.cxx, Examples/Segmentation/FastMarchingImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, Examples/Segmentation/GibbsPriorImageFilter1.cxx, Examples/Segmentation/HoughTransform2DCirclesImageFilter.cxx, Examples/Segmentation/HoughTransform2DLinesImageFilter.cxx, Examples/Segmentation/IsolatedConnectedImageFilter.cxx, Examples/Segmentation/LaplacianSegmentationLevelSetImageFilter.cxx, Examples/Segmentation/NeighborhoodConnectedImageFilter.cxx, Examples/Segmentation/RelabelComponentImageFilter.cxx, Examples/Segmentation/ShapeDetectionLevelSetFilter.cxx, Examples/Segmentation/ThresholdSegmentationLevelSetImageFilter.cxx, Examples/Segmentation/VectorConfidenceConnected.cxx, Examples/Segmentation/WatershedSegmentation1.cxx, Examples/Segmentation/WatershedSegmentation2.cxx, Examples/Statistics/BayesianClassifier.cxx, Examples/Statistics/BayesianClassifierInitializer.cxx, Examples/Statistics/ScalarImageKmeansClassifier.cxx, Examples/Statistics/ScalarImageMarkovRandomField1.cxx, SphinxExamples/src/Core/Common/ImportPixelBufferIntoAnImage/Code.cxx, SphinxExamples/src/Core/Common/MakePartOfImageTransparent/Code.cxx, SphinxExamples/src/Core/Common/MiniPipeline/Code.cxx, SphinxExamples/src/Core/Common/StoreNonPixelDataInImage/Code.cxx, SphinxExamples/src/Filtering/ImageFeature/DerivativeImage/Code.cxx, SphinxExamples/src/Filtering/LabelMap/KeepRegionsThatMeetSpecific/Code.cxx, SphinxExamples/src/ImageCompareCommand.cxx, SphinxExamples/src/IO/ImageBase/ProcessImageChunks/Code.cxx, SphinxExamples/src/IO/ImageBase/WriteAnImage/Code.cxx, and SphinxExamples/src/IO/TIFF/WriteATIFFImage/Code.cxx.

Definition at line 90 of file itkImageFileWriter.h.

+ Inheritance diagram for itk::ImageFileWriter< TInputImage >:
+ Collaboration diagram for itk::ImageFileWriter< TInputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageFileWriter
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const InputImageType * GetInput ()
 
const InputImageType * GetInput (unsigned int idx)
 
const ImageIORegion & GetIORegion () const
 
const char * GetNameOfClass () const override
 
void SetInput (const InputImageType *input)
 
void SetIORegion (const ImageIORegion &region)
 
void Update () override
 
void UpdateLargestPossibleRegion () override
 
virtual void Write ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetImageIO (ImageIOBase *io)
 
virtual ImageIOBase * GetModifiableImageIO ()
 
virtual void SetNumberOfStreamDivisions (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfStreamDivisions () const
 
virtual void SetUseCompression (bool _arg)
 
virtual const bool & GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void SetCompressionLevel (int _arg)
 
virtual const int & GetCompressionLevel () const
 
virtual void SetUseInputMetaDataDictionary (bool _arg)
 
virtual const bool & GetUseInputMetaDataDictionary () const
 
virtual void UseInputMetaDataDictionaryOn ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
 ImageFileWriter ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFileWriter () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

int m_CompressionLevel { -1 }
 
bool m_FactorySpecifiedImageIO { false }
 
std::string m_FileName {}
 
ImageIOBase::Pointer m_ImageIO {}
 
unsigned int m_NumberOfStreamDivisions { 1 }
 
ImageIORegion m_PasteIORegion { TInputImage::ImageDimension }
 
bool m_UseCompression { false }
 
bool m_UseInputMetaDataDictionary { true }
 
bool m_UserSpecifiedImageIO { false }
 
bool m_UserSpecifiedIORegion { false }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 99 of file itkImageFileWriter.h.

◆ InputImagePixelType

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 111 of file itkImageFileWriter.h.

◆ InputImagePointer

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 109 of file itkImageFileWriter.h.

◆ InputImageRegionType

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 110 of file itkImageFileWriter.h.

◆ InputImageType

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 108 of file itkImageFileWriter.h.

◆ Pointer

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 98 of file itkImageFileWriter.h.

◆ Self

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::Self = ImageFileWriter

Standard class type aliases.

Definition at line 96 of file itkImageFileWriter.h.

◆ Superclass

template<typename TInputImage >
using itk::ImageFileWriter< TInputImage >::Superclass = ProcessObject

Definition at line 97 of file itkImageFileWriter.h.

Constructor & Destructor Documentation

◆ ImageFileWriter()

template<typename TInputImage >
itk::ImageFileWriter< TInputImage >::ImageFileWriter ( )
protecteddefault

◆ ~ImageFileWriter()

template<typename TInputImage >
itk::ImageFileWriter< TInputImage >::~ImageFileWriter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::GenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

◆ GetCompressionLevel()

template<typename TInputImage >
virtual const int& itk::ImageFileWriter< TInputImage >::GetCompressionLevel ( ) const
virtual

Set the compression level.

See also
ImageIOBase for details. Set to a negative number to use ImageIO's default compression level.

◆ GetFileName()

template<typename TInputImage >
virtual const char* itk::ImageFileWriter< TInputImage >::GetFileName ( ) const
virtual

Specify the name of the output file to write.

◆ GetInput() [1/2]

template<typename TInputImage >
const InputImageType* itk::ImageFileWriter< TInputImage >::GetInput ( )

◆ GetInput() [2/2]

template<typename TInputImage >
const InputImageType* itk::ImageFileWriter< TInputImage >::GetInput ( unsigned int  idx)

◆ GetIORegion()

template<typename TInputImage >
const ImageIORegion& itk::ImageFileWriter< TInputImage >::GetIORegion ( ) const
inline

Definition at line 168 of file itkImageFileWriter.h.

◆ GetModifiableImageIO()

template<typename TInputImage >
virtual ImageIOBase* itk::ImageFileWriter< TInputImage >::GetModifiableImageIO ( )
virtual

Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or one can be manually set where the IO factory mechanism may not work (for example, raw image files or image files with non-standard filename suffix's. If the user specifies the ImageIO, we assume she makes the correct choice and will allow a file to be created regardless of the file extension. If the factory has set the ImageIO, the extension must be supported by the specified ImageIO.

◆ GetNameOfClass()

template<typename TInputImage >
const char* itk::ImageFileWriter< TInputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetNumberOfStreamDivisions()

template<typename TInputImage >
virtual const unsigned int& itk::ImageFileWriter< TInputImage >::GetNumberOfStreamDivisions ( ) const
virtual

Set/Get the number of pieces to divide the input. The upstream pipeline will try to be executed this many times.

◆ GetUseCompression()

template<typename TInputImage >
virtual const bool& itk::ImageFileWriter< TInputImage >::GetUseCompression ( ) const
virtual

Set the compression On or Off

◆ GetUseInputMetaDataDictionary()

template<typename TInputImage >
virtual const bool& itk::ImageFileWriter< TInputImage >::GetUseInputMetaDataDictionary ( ) const
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

◆ New()

template<typename TInputImage >
static Pointer itk::ImageFileWriter< TInputImage >::New ( )
static

Method for creation through the object factory.

Examples
Examples/RegistrationITKv4/DeformableRegistration1.cxx, Examples/RegistrationITKv4/DeformableRegistration11.cxx, and Examples/Segmentation/LaplacianSegmentationLevelSetImageFilter.cxx.

Referenced by itk::WriteImage().

◆ PrintSelf()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetCompressionLevel()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::SetCompressionLevel ( int  _arg)
virtual

Set the compression level.

See also
ImageIOBase for details. Set to a negative number to use ImageIO's default compression level.

◆ SetFileName()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::SetFileName ( const char *  _arg)
virtual

Specify the name of the output file to write.

◆ SetImageIO()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::SetImageIO ( ImageIOBase *  io)
inline

Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or one can be manually set where the IO factory mechanism may not work (for example, raw image files or image files with non-standard filename suffix's. If the user specifies the ImageIO, we assume she makes the correct choice and will allow a file to be created regardless of the file extension. If the factory has set the ImageIO, the extension must be supported by the specified ImageIO.

Definition at line 140 of file itkImageFileWriter.h.

◆ SetInput()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::SetInput ( const InputImageType *  input)

◆ SetIORegion()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::SetIORegion ( const ImageIORegion &  region)

Specify the region to write. If left nullptr, then the whole image is written.

◆ SetNumberOfStreamDivisions()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::SetNumberOfStreamDivisions ( unsigned int  _arg)
virtual

Set/Get the number of pieces to divide the input. The upstream pipeline will try to be executed this many times.

◆ SetUseCompression()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::SetUseCompression ( bool  _arg)
virtual

Set the compression On or Off

◆ SetUseInputMetaDataDictionary()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::SetUseInputMetaDataDictionary ( bool  _arg)
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

◆ Update()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::Update ( )
inlineoverridevirtual

Aliased to the Write() method to be consistent with the rest of the pipeline.

Reimplemented from itk::ProcessObject.

Definition at line 182 of file itkImageFileWriter.h.

◆ UpdateLargestPossibleRegion()

template<typename TInputImage >
void itk::ImageFileWriter< TInputImage >::UpdateLargestPossibleRegion ( )
inlineoverridevirtual

Writes the entire image to file.

Updates the pipeline, streaming it the NumberOfStreamDivisions times. Existing PasteIORegion is reset.

Reimplemented from itk::ProcessObject.

Definition at line 193 of file itkImageFileWriter.h.

◆ UseCompressionOn()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::UseCompressionOn ( )
virtual

Set the compression On or Off

◆ UseInputMetaDataDictionaryOn()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::UseInputMetaDataDictionaryOn ( )
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

◆ Write()

template<typename TInputImage >
virtual void itk::ImageFileWriter< TInputImage >::Write ( )
virtual

A special version of the Update() method for writers. It invokes start and end events and handles releasing data. It eventually calls GenerateData() which does the actual writing. Note: the write method will write data specified by the IORegion. If not set, then then the whole image is written. Note that the region will be cropped to fit the input image's LargestPossibleRegion.

Member Data Documentation

◆ m_CompressionLevel

template<typename TInputImage >
int itk::ImageFileWriter< TInputImage >::m_CompressionLevel { -1 }
private

Definition at line 245 of file itkImageFileWriter.h.

◆ m_FactorySpecifiedImageIO

template<typename TInputImage >
bool itk::ImageFileWriter< TInputImage >::m_FactorySpecifiedImageIO { false }
private

Definition at line 243 of file itkImageFileWriter.h.

◆ m_FileName

template<typename TInputImage >
std::string itk::ImageFileWriter< TInputImage >::m_FileName {}
private

Definition at line 234 of file itkImageFileWriter.h.

◆ m_ImageIO

template<typename TInputImage >
ImageIOBase::Pointer itk::ImageFileWriter< TInputImage >::m_ImageIO {}
private

Definition at line 236 of file itkImageFileWriter.h.

◆ m_NumberOfStreamDivisions

template<typename TInputImage >
unsigned int itk::ImageFileWriter< TInputImage >::m_NumberOfStreamDivisions { 1 }
private

Definition at line 240 of file itkImageFileWriter.h.

◆ m_PasteIORegion

template<typename TInputImage >
ImageIORegion itk::ImageFileWriter< TInputImage >::m_PasteIORegion { TInputImage::ImageDimension }
private

Definition at line 239 of file itkImageFileWriter.h.

◆ m_UseCompression

template<typename TInputImage >
bool itk::ImageFileWriter< TInputImage >::m_UseCompression { false }
private

Definition at line 244 of file itkImageFileWriter.h.

◆ m_UseInputMetaDataDictionary

template<typename TInputImage >
bool itk::ImageFileWriter< TInputImage >::m_UseInputMetaDataDictionary { true }
private

Definition at line 246 of file itkImageFileWriter.h.

◆ m_UserSpecifiedImageIO

template<typename TInputImage >
bool itk::ImageFileWriter< TInputImage >::m_UserSpecifiedImageIO { false }
private

Definition at line 237 of file itkImageFileWriter.h.

◆ m_UserSpecifiedIORegion

template<typename TInputImage >
bool itk::ImageFileWriter< TInputImage >::m_UserSpecifiedIORegion { false }
private

Definition at line 241 of file itkImageFileWriter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16