#include <itkNeuralNetworkFileReader.h>

Inheritance diagram for itk::NeuralNetworkFileReader< TNetwork >:

Collaboration diagram for itk::NeuralNetworkFileReader< TNetwork >:

Detailed Description

template<typename TNetwork>
class itk::NeuralNetworkFileReader< TNetwork >

Reader for Neural Network.

This class will enable the user to load neural network and define weights and other network parameters from a text file.

This class was contributed to the Insight Journal by Raghu Venkatram. The original paper can be found at https://hdl.handle.net/1926/203

Author: Raghu Venkatram

See Also: NeuralNetworkFileWriter; MultilayerNeuralNetworkBase

Definition at line 57 of file itkNeuralNetworkFileReader.h.

Classes
struct	LineType

Public Types
typedef BackPropagationLayerType::Pointer	BackPropagationLayerPointer

typedef Statistics::BackPropagationLayer < MeasurementVectorType, TargetVectorType >	BackPropagationLayerType

typedef SmartPointer< const Self >	ConstPointer

typedef TNetwork::LayerInterfaceType	LayerInterfaceType

typedef TNetwork::MeasurementVectorType	MeasurementVectorType

typedef MeasurementVectorType::ValueType	MeasurementVectorValueType

enum	NetworkWriteWeightsType { IGNORE = 0, ASCII = 1, BINARY = 2 }

typedef SmartPointer< Self >	Pointer

typedef NeuralNetworkFileReader	Self

typedef Object	Superclass

typedef TNetwork::TargetVectorType	TargetVectorType

typedef WeightSetType::Pointer	WeightSetPointer

typedef LayerInterfaceType::WeightSetType	WeightSetType

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetFileName () const

virtual const char *	GetNameOfClass () const

TNetwork *	GetOutput () const

virtual NetworkWriteWeightsType	GetReadWeightValuesType () const

virtual void	SetFileName (const char *_arg)

virtual void	SetReadWeightValuesType (const NetworkWriteWeightsType _arg)

void	Update ()

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

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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
	NeuralNetworkFileReader ()

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

	~NeuralNetworkFileReader ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~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 Types
typedef std::vector < MET_FieldRecordType * >	FieldsContainerType

typedef std::vector< typename TNetwork::LayerInterfaceType::Pointer >	LayersContainer

typedef std::list< LineType >	LinesContainer

typedef std::vector< typename TNetwork::LayerInterfaceType::WeightSetInterfaceType::Pointer >	WeightsContainer

Private Member Functions
void	ClearFields ()

Private Attributes
bool	m_BinaryDataByteOrderMSB

FieldsContainerType	m_Fields

std::string	m_FileName

std::ifstream	m_InputFile

LayersContainer	m_Layers

LinesContainer	m_NameValue

TNetwork::Pointer	m_Network

NetworkWriteWeightsType	m_ReadWeightValuesType

WeightsContainer	m_Weights

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TNetwork >

typedef BackPropagationLayerType::Pointer itk::NeuralNetworkFileReader< TNetwork >::BackPropagationLayerPointer

Definition at line 77 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef Statistics::BackPropagationLayer< MeasurementVectorType, TargetVectorType > itk::NeuralNetworkFileReader< TNetwork >::BackPropagationLayerType

Definition at line 76 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef SmartPointer< const Self > itk::NeuralNetworkFileReader< TNetwork >::ConstPointer

Definition at line 65 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef std::vector< MET_FieldRecordType * > itk::NeuralNetworkFileReader< TNetwork >::FieldsContainerType

private

Definition at line 126 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef TNetwork::LayerInterfaceType itk::NeuralNetworkFileReader< TNetwork >::LayerInterfaceType

Definition at line 80 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef std::vector< typename TNetwork::LayerInterfaceType::Pointer > itk::NeuralNetworkFileReader< TNetwork >::LayersContainer

private

Definition at line 127 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef std::list< LineType > itk::NeuralNetworkFileReader< TNetwork >::LinesContainer

private

Definition at line 135 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef TNetwork::MeasurementVectorType itk::NeuralNetworkFileReader< TNetwork >::MeasurementVectorType

Definition at line 71 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef MeasurementVectorType::ValueType itk::NeuralNetworkFileReader< TNetwork >::MeasurementVectorValueType

Definition at line 78 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef SmartPointer< Self > itk::NeuralNetworkFileReader< TNetwork >::Pointer

Definition at line 64 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef NeuralNetworkFileReader itk::NeuralNetworkFileReader< TNetwork >::Self

SmartPointer typedef support

Definition at line 62 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef Object itk::NeuralNetworkFileReader< TNetwork >::Superclass

Definition at line 63 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef TNetwork::TargetVectorType itk::NeuralNetworkFileReader< TNetwork >::TargetVectorType

Definition at line 74 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef std::vector< typename TNetwork::LayerInterfaceType::WeightSetInterfaceType::Pointer > itk::NeuralNetworkFileReader< TNetwork >::WeightsContainer

private

Definition at line 128 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef WeightSetType::Pointer itk::NeuralNetworkFileReader< TNetwork >::WeightSetPointer

Definition at line 82 of file itkNeuralNetworkFileReader.h.

template<typename TNetwork >

typedef LayerInterfaceType::WeightSetType itk::NeuralNetworkFileReader< TNetwork >::WeightSetType

Definition at line 81 of file itkNeuralNetworkFileReader.h.

Member Enumeration Documentation

template<typename TNetwork >

enum itk::NeuralNetworkFileReader::NetworkWriteWeightsType

Enumerator
IGNORE
ASCII
BINARY

Definition at line 113 of file itkNeuralNetworkFileReader.h.

Constructor & Destructor Documentation

template<typename TNetwork >

itk::NeuralNetworkFileReader< TNetwork >::NeuralNetworkFileReader ( )

protected

template<typename TNetwork >

itk::NeuralNetworkFileReader< TNetwork >::~NeuralNetworkFileReader ( )

protected

Member Function Documentation

template<typename TNetwork >

void itk::NeuralNetworkFileReader< TNetwork >::ClearFields ( )

private

template<typename TNetwork >

virtual::itk::LightObject::Pointer itk::NeuralNetworkFileReader< TNetwork >::CreateAnother ( ) 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 TNetwork >

virtual const char* itk::NeuralNetworkFileReader< TNetwork >::GetFileName ( ) const

virtual

Get the filename

template<typename TNetwork >

virtual const char* itk::NeuralNetworkFileReader< TNetwork >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TNetwork >

TNetwork* itk::NeuralNetworkFileReader< TNetwork >::GetOutput ( ) const

template<typename TNetwork >

virtual NetworkWriteWeightsType itk::NeuralNetworkFileReader< TNetwork >::GetReadWeightValuesType ( ) const

virtual

template<typename TNetwork >

static Pointer itk::NeuralNetworkFileReader< TNetwork >::New ( )

static

Method for creation through the object factory

template<typename TNetwork >

virtual void itk::NeuralNetworkFileReader< TNetwork >::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::Object.

template<typename TNetwork >

virtual void itk::NeuralNetworkFileReader< TNetwork >::SetFileName ( const char * _arg )

virtual

Set the filename

template<typename TNetwork >

virtual void itk::NeuralNetworkFileReader< TNetwork >::SetReadWeightValuesType ( const NetworkWriteWeightsType _arg )

virtual

template<typename TNetwork >

void itk::NeuralNetworkFileReader< TNetwork >::Update ( )

Read NeuralNetwork