itk::ParticlePositionReader

More...

#include <itkParticlePositionReader.h>

Inherits from DataObject

Public Types

	Name
typedef ParticlePositionReader	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Point< double, VDimension >	PointType

Public Functions

	Name
	itkNewMacro(Self )
	itkTypeMacro(ParticlePositionReader , DataObject )
const std::vector< PointType > &	GetOutput() const
	itkSetStringMacro(FileName )
	itkGetStringMacro(FileName )
void	Read()
void	Update()

Protected Functions

	Name
	ParticlePositionReader()
void	PrintSelf(std::ostream & os, Indent indent) const
virtual	~ParticlePositionReader()

Detailed Description

template <unsigned int VDimension>
class itk::ParticlePositionReader;

This class reads a set of Points from disk and stores them in a vector. The file format is simple an ascii list of VDimension-tuples stored one per line (delimited by std::endl). There is no header required for the file, but the file should not contain leading or trailing empty lines.

In 3D, for example, a fragment of a points file looks like this:

1.0 2.0 5.4 2.3 8.7 33.0 4.0 8.21 4.44

etc..

Public Types Documentation

typedef Self

typedef ParticlePositionReader itk::ParticlePositionReader< VDimension >::Self;

Standard class typedefs

typedef Superclass

typedef DataObject itk::ParticlePositionReader< VDimension >::Superclass;

typedef Pointer

typedef SmartPointer<Self> itk::ParticlePositionReader< VDimension >::Pointer;

typedef ConstPointer

typedef SmartPointer<const Self> itk::ParticlePositionReader< VDimension >::ConstPointer;

typedef ConstWeakPointer

typedef WeakPointer<const Self> itk::ParticlePositionReader< VDimension >::ConstWeakPointer;

typedef PointType

typedef Point<double, VDimension> itk::ParticlePositionReader< VDimension >::PointType;

The point type that this class reads.

Public Functions Documentation

function itkNewMacro

itkNewMacro(
    Self 
)

Method for creation through the object factory.

function itkTypeMacro

itkTypeMacro(
    ParticlePositionReader ,
    DataObject 
)

Run-time type information (and related methods).

function GetOutput

inline const std::vector< PointType > & GetOutput() const

Get the output of the reader. The output is a std::vector of PointType.

function itkSetStringMacro

itkSetStringMacro(
    FileName 
)

Set/Get the filename.

function itkGetStringMacro

itkGetStringMacro(
    FileName 
)

function Read

inline void Read()

Read the file.

function Update

void Update()

Protected Functions Documentation

function ParticlePositionReader

inline ParticlePositionReader()

function PrintSelf

inline void PrintSelf(
    std::ostream & os,
    Indent indent
) const

function ~ParticlePositionReader

inline virtual ~ParticlePositionReader()

---

Updated on 2022-03-31 at 09:51:18 -0600