ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::ImageFileWriter< TInputImage > Class Template Reference

#include <itkImageFileWriter.h>

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

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

Definition at line 86 of file itkImageFileWriter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageFileWriter Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetInput (void)
 
const InputImageTypeGetInput (unsigned int idx)
 
const ImageIORegionGetIORegion (void) const
 
virtual const char * GetNameOfClass () const
 
void SetInput (const InputImageType *input)
 
void SetIORegion (const ImageIORegion &region)
 
virtual void Update () ITK_OVERRIDE
 
virtual void UpdateLargestPossibleRegion () ITK_OVERRIDE
 
virtual void Write (void)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetImageIO (ImageIOBase *io)
 
virtual ImageIOBaseGetModifiableImageIO ()
 
virtual const ImageIOBaseGetImageIO () const
 
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 UseCompressionOff ()
 
virtual void SetUseInputMetaDataDictionary (bool _arg)
 
virtual const bool & GetUseInputMetaDataDictionary () const
 
virtual void UseInputMetaDataDictionaryOn ()
 
virtual void UseInputMetaDataDictionaryOff ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void GenerateData (void) ITK_OVERRIDE
 
 ImageFileWriter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 ~ImageFileWriter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 Member Functions

 ImageFileWriter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

bool m_FactorySpecifiedImageIO
 
std::string m_FileName
 
ImageIOBase::Pointer m_ImageIO
 
unsigned int m_NumberOfStreamDivisions
 
ImageIORegion m_PasteIORegion
 
bool m_UseCompression
 
bool m_UseInputMetaDataDictionary
 
bool m_UserSpecifiedImageIO
 
bool m_UserSpecifiedIORegion
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

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

Definition at line 93 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef InputImageType::PixelType itk::ImageFileWriter< TInputImage >::InputImagePixelType

Definition at line 105 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef InputImageType::Pointer itk::ImageFileWriter< TInputImage >::InputImagePointer

Definition at line 103 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef InputImageType::RegionType itk::ImageFileWriter< TInputImage >::InputImageRegionType

Definition at line 104 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef TInputImage itk::ImageFileWriter< TInputImage >::InputImageType

Some convenient typedefs.

Definition at line 99 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef SmartPointer< Self > itk::ImageFileWriter< TInputImage >::Pointer

Definition at line 92 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef ImageFileWriter itk::ImageFileWriter< TInputImage >::Self

Standard class typedefs.

Definition at line 90 of file itkImageFileWriter.h.

template<typename TInputImage>
typedef ProcessObject itk::ImageFileWriter< TInputImage >::Superclass

Definition at line 91 of file itkImageFileWriter.h.

Constructor & Destructor Documentation

template<typename TInputImage>
itk::ImageFileWriter< TInputImage >::ImageFileWriter ( )
protected
template<typename TInputImage>
itk::ImageFileWriter< TInputImage >::~ImageFileWriter ( )
protected
template<typename TInputImage>
itk::ImageFileWriter< TInputImage >::ImageFileWriter ( const Self )
private

Member Function Documentation

template<typename TInputImage>
virtual::itk::LightObject::Pointer itk::ImageFileWriter< TInputImage >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

Does the real work.

Reimplemented from itk::ProcessObject.

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

Specify the name of the output file to write.

template<typename TInputImage>
virtual const ImageIOBase* itk::ImageFileWriter< TInputImage >::GetImageIO ( ) const
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.

template<typename TInputImage>
const InputImageType* itk::ImageFileWriter< TInputImage >::GetInput ( void  )
template<typename TInputImage>
const InputImageType* itk::ImageFileWriter< TInputImage >::GetInput ( unsigned int  idx)
template<typename TInputImage>
const ImageIORegion& itk::ImageFileWriter< TInputImage >::GetIORegion ( void  ) const
inline

Definition at line 155 of file itkImageFileWriter.h.

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.

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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.

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

Set the compression On or Off

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.

template<typename TInputImage>
static Pointer itk::ImageFileWriter< TInputImage >::New ( )
static
template<typename TInputImage>
void itk::ImageFileWriter< TInputImage >::operator= ( const Self )
private
template<typename TInputImage>
virtual void itk::ImageFileWriter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

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

Specify the name of the output file to write.

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 130 of file itkImageFileWriter.h.

template<typename TInputImage>
void itk::ImageFileWriter< TInputImage >::SetInput ( const InputImageType input)
template<typename TInputImage>
void itk::ImageFileWriter< TInputImage >::SetIORegion ( const ImageIORegion region)

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

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.

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

Set the compression On or Off

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.

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

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

Reimplemented from itk::ProcessObject.

Definition at line 168 of file itkImageFileWriter.h.

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

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 178 of file itkImageFileWriter.h.

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

Set the compression On or Off

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

Set the compression On or Off

template<typename TInputImage>
virtual void itk::ImageFileWriter< TInputImage >::UseInputMetaDataDictionaryOff ( )
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.

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.

template<typename TInputImage>
virtual void itk::ImageFileWriter< TInputImage >::Write ( void  )
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

template<typename TInputImage>
bool itk::ImageFileWriter< TInputImage >::m_FactorySpecifiedImageIO
private

Definition at line 224 of file itkImageFileWriter.h.

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

Definition at line 214 of file itkImageFileWriter.h.

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

Definition at line 216 of file itkImageFileWriter.h.

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

Definition at line 221 of file itkImageFileWriter.h.

template<typename TInputImage>
ImageIORegion itk::ImageFileWriter< TInputImage >::m_PasteIORegion
private

Definition at line 220 of file itkImageFileWriter.h.

template<typename TInputImage>
bool itk::ImageFileWriter< TInputImage >::m_UseCompression
private

Definition at line 226 of file itkImageFileWriter.h.

template<typename TInputImage>
bool itk::ImageFileWriter< TInputImage >::m_UseInputMetaDataDictionary
private

Definition at line 227 of file itkImageFileWriter.h.

template<typename TInputImage>
bool itk::ImageFileWriter< TInputImage >::m_UserSpecifiedImageIO
private

Definition at line 217 of file itkImageFileWriter.h.

template<typename TInputImage>
bool itk::ImageFileWriter< TInputImage >::m_UserSpecifiedIORegion
private

Definition at line 222 of file itkImageFileWriter.h.


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