itk::Writer Class Reference
[Input and Output Filters, Deprecated classes that are scheduled to be removed from the Toolkit]

The base class for all data writers. More...

#include <itkWriter.h>

Inheritance diagram for itk::Writer:

[legend]Collaboration diagram for itk::Writer:

[legend]List of all members.

Public Types
typedef Writer	Self
typedef ProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
enum	FileType { ASCII, Binary }
Public Methods
virtual const char *	GetClassName () const
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetFileType (FileType _arg)
virtual FileType	GetFileType ()
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
virtual void	Write ()
virtual void	Update ()
Protected Methods
	Writer ()
	~Writer ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	WriteData ()=0
void	GenerateData ()

---

Detailed Description

The base class for all data writers.

Writer is the base class for all Insight data writers. You can specify binary or ASCII output types, as well as the output file name.

Definition at line 36 of file itkWriter.h.

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Writer::ConstPointer

Reimplemented from itk::ProcessObject. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >. Definition at line 43 of file itkWriter.h.

typedef SmartPointer<Self> itk::Writer::Pointer

Reimplemented from itk::ProcessObject. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >. Definition at line 42 of file itkWriter.h.

typedef Writer itk::Writer::Self

Standard class typedefs. Reimplemented from itk::ProcessObject. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >. Definition at line 40 of file itkWriter.h.

typedef ProcessObject itk::Writer::Superclass

Reimplemented from itk::ProcessObject. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >. Definition at line 41 of file itkWriter.h.

---

Member Enumeration Documentation

enum itk::Writer::FileType

Enums used to specify VTK type: binary or ASCII. Enumeration values: ASCII  Binary  Definition at line 55 of file itkWriter.h.

---

Constructor & Destructor Documentation

itk::Writer::Writer (    )  [protected]

itk::Writer::~Writer (    )  [protected]

---

Member Function Documentation

void itk::Writer::GenerateData (  void    )  [inline, protected, virtual]

This method causes the filter to generate its output. Reimplemented from itk::ProcessObject. Definition at line 90 of file itkWriter.h. References HardConnectedComponentImageFilter::GenerateData().

virtual const char* itk::Writer::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ProcessObject. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >.

virtual const char* itk::Writer::GetFileName (    )  const [virtual]

Get the name of the output file.

virtual FileType itk::Writer::GetFileType (    )  [virtual]

Get the file type.

void itk::Writer::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

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. Reimplemented in itk::ImageWriter< TInputImage >, and itk::RawImageWriter< TInputImage >.

virtual void itk::Writer::SetFileName (  const char *    _arg )  [virtual]

Specify the name of the output file.

virtual void itk::Writer::SetFileType (  FileType    _arg )  [virtual]

Set the file type. The default is ASCII.

void itk::Writer::SetFileTypeToASCII (    )  [inline]

Specify the output file type as ASCII (the default). Definition at line 64 of file itkWriter.h.

void itk::Writer::SetFileTypeToBinary (    )  [inline]

Specify the output file type to binary. Definition at line 68 of file itkWriter.h.

virtual void itk::Writer::Update (    )  [inline, virtual]

Aliased to Write() method. Reimplemented from itk::ProcessObject. Definition at line 76 of file itkWriter.h.

virtual void itk::Writer::Write (    )  [virtual]

A special version of the Update() method for writers. It invokes start and end methods and handles releasing data.

virtual void itk::Writer::WriteData (    )  [protected, pure virtual]

All writers must respond to WriteData(). The WriteData() method is responsible for updating the pipeline, and may request pieces of the data (e.g., stream) if necessary to write out the entire input dataset. Implemented in itk::RawImageWriter< TInputImage >.

---

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

• itkWriter.h

---