Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::ByteSwapper< T > Class Template Reference
[Input and Output Filters, OS System Objects]

#include <itkByteSwapper.h>

Inheritance diagram for itk::ByteSwapper< T >:

[legend]Collaboration diagram for itk::ByteSwapper< T >:

[legend]List of all members.

Detailed Description

template<class T>
class itk::ByteSwapper< T >

Perform machine dependent byte swapping.

ByteSwapper is used by I/O classes to perform machine dependent byte swapping. Byte swapping is often used when reading or writing binary files. Files can either be Big Endian (BE) or Little Endian (LE).

Definition at line 41 of file itkByteSwapper.h.

Public Types

typedef SmartPointer< const
Self > ConstPointer

typedef std::ostream OStreamType

typedef SmartPointer< Self > Pointer

typedef ByteSwapper Self

typedef Object Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

Command * GetCommand (unsigned long tag)

bool GetDebug () const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

virtual const char * GetNameOfClass () const

virtual int GetReferenceCount () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual void Modified () const

void Print (std::ostream &os, Indent indent=0) const

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

void SetDebug (bool debugFlag) const

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

Generic swap method handles
type T The data is *swapped
and written (in binary) to the ostream *given.A total of num values of type T are written *and swapped.Either 2-byte or 4-byte swapping *can be handled.Single byte types are not swapped

Generic swap method handles
type T The data is *swapped
and written (in binary) to the ostream *given.A total of num values of type T are written *and swapped.Either 2-byte or 4-byte swapping *can be handled.Single byte types are not swapped

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

This is a global flag that
controls whether any warning
*or error messages are displayed
*static void SetGlobalWarningDisplay (bool flag)

static void SwapFromSystemToBigEndian (T *p)

static void SwapFromSystemToLittleEndian (T *p)

static void SwapRangeFromSystemToBigEndian (T *p, unsigned long num)

static void SwapRangeFromSystemToLittleEndian (T *p, unsigned long num)

*others raise an exception
The method is used to *swap
to and from Big Endian *static
void SwapWriteRangeFromSystemToBigEndian (T *p, int num, OStreamType *fp)

*others raise an exception
The method is used to *swap
to and from Little Endian
*static void SwapWriteRangeFromSystemToLittleEndian (T *p, int num, OStreamType *fp)

static bool SystemIsBE ()

Query the machine Endian ness
*static bool SystemIsBigEndian ()

static bool SystemIsLE ()

static bool SystemIsLittleEndian ()

Public Attributes

Allow people to add remove
invoke observers(callbacks)
to any ITK *object.This is
an implementation of the subject/observer design *pattern.An
observer is added by specifying
an event to respond to *and
an itk unsigned lon AddObserver )(const EventObject &event, Command *) const

This is a global flag that
controls whether any debug

Protected Member Functions

ByteSwapper ()

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

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

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

~ByteSwapper ()

Static Protected Member Functions

static void Swap2 (void *p)

static void Swap2Range (void *p, unsigned long num)

static void Swap4 (void *p)

static void Swap4Range (void *p, unsigned long num)

static void Swap8 (void *p)

static void Swap8Range (void *p, unsigned long num)

static void SwapWrite2Range (void *p, unsigned long num, OStreamType *fp)

static void SwapWrite4Range (void *p, unsigned long num, OStreamType *fp)

static void SwapWrite8Range (void *p, unsigned long num, OStreamType *fp)

Protected Attributes

int m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Methods invoked by virtual
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.*/virtual
void PrintSelf(std voi PrintHeader )(std::ostream &os, Indent indent) const

Member Typedef Documentation

template<class T>

typedef SmartPointer<const Self> itk::ByteSwapper< T >::ConstPointer

Reimplemented from itk::Object.
Definition at line 48 of file itkByteSwapper.h.

template<class T>

typedef std::ostream itk::ByteSwapper< T >::OStreamType

Work around MSVC bug (including ByteSwapper.h in a templated class).
Definition at line 51 of file itkByteSwapper.h.

template<class T>

typedef SmartPointer<Self> itk::ByteSwapper< T >::Pointer

Reimplemented from itk::Object.
Definition at line 47 of file itkByteSwapper.h.

template<class T>

typedef ByteSwapper itk::ByteSwapper< T >::Self

Standard class typedefs.
Reimplemented from itk::Object.
Definition at line 45 of file itkByteSwapper.h.

template<class T>

typedef Object itk::ByteSwapper< T >::Superclass

Reimplemented from itk::Object.
Definition at line 46 of file itkByteSwapper.h.

Constructor & Destructor Documentation

template<class T>

itk::ByteSwapper< T >::ByteSwapper ( ) [inline, protected]

Definition at line 114 of file itkByteSwapper.h.

template<class T>

itk::ByteSwapper< T >::~ByteSwapper ( ) [inline, protected]

Definition at line 115 of file itkByteSwapper.h.

Member Function Documentation

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class T>

virtual const char* itk::ByteSwapper< T >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).
Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).
Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)
Reimplemented from itk::LightObject.

template<class T>

static void itk::ByteSwapper< T >::Swap2 ( void * p ) [static, protected]

Swap 2 bytes.

template<class T>

static void itk::ByteSwapper< T >::Swap2Range ( void * p,

unsigned long num

) [static, protected]

Swap a range of two-byte words. Num is the number of two-byte words to swap.

template<class T>

static void itk::ByteSwapper< T >::Swap4 ( void * p ) [static, protected]

Swap four bytes.

template<class T>

static void itk::ByteSwapper< T >::Swap4Range ( void * p,

unsigned long num

) [static, protected]

Swap a range of four-byte words. Num is the number of four-byte words to swap.

template<class T>

static void itk::ByteSwapper< T >::Swap8 ( void * p ) [static, protected]

Swap 8 bytes.

template<class T>

static void itk::ByteSwapper< T >::Swap8Range ( void * p,

unsigned long num

) [static, protected]

Swap a range of four-byte words. Num is the number of four-byte words to swap.

template<class T>

static void itk::ByteSwapper< T >::SwapFromSystemToBigEndian ( T * p ) [static]

Generic swap method handles type T. The swapping is done in-place. Either 2-byte or 4-byte swapping can be handled. Single byte types are not swapped; others raise an exception. The method is used to swap to and from Big Endian.

template<class T>

static void itk::ByteSwapper< T >::SwapFromSystemToLittleEndian ( T * p ) [static]

Generic swap method handles type T. The swapping is done in-place. Either 2-byte or 4-byte swapping can be handled. Single byte types are not swapped; others raise an exception. The method is used to swap to and from Little Endian.

template<class T>

static void itk::ByteSwapper< T >::SwapRangeFromSystemToBigEndian ( T * p,

unsigned long num

) [static]

Generic swap method handles type T. The swapping is done in-place. Either 2-byte or 4-byte swapping can be handled. Single byte types are not swapped; others raise an exception. The method is used to swap to and from Big Endian.

template<class T>

static void itk::ByteSwapper< T >::SwapRangeFromSystemToLittleEndian ( T * p,

unsigned long num

) [static]

Generic swap method handles type T. The swapping is done in-place. Either 2-byte or 4-byte swapping can be handled. Single byte types are not swapped; others raise an exception. The method is used to swap to and from Little Endian.

template<class T>

static void itk::ByteSwapper< T >::SwapWrite2Range ( void * p,

unsigned long num,

OStreamType * fp

) [static, protected]

Swap and write a range of two-byte words. Num is the number of two-byte words to swap and write.

template<class T>

static void itk::ByteSwapper< T >::SwapWrite4Range ( void * p,

unsigned long num,

OStreamType * fp

) [static, protected]

Swap and write a range of four-byte words. Num is the number of four-byte words to swap and write.

template<class T>

static void itk::ByteSwapper< T >::SwapWrite8Range ( void * p,

unsigned long num,

OStreamType * fp

) [static, protected]

Swap and write a range of 8-byte words. Num is the number of four-byte words to swap and write.

template<class T>

* others raise an exception The method is used to* swap to and from Big Endian* static void itk::ByteSwapper< T >::SwapWriteRangeFromSystemToBigEndian ( T * p,

int num,

OStreamType * fp

) [static]

template<class T>

* others raise an exception The method is used to* swap to and from Little Endian* static void itk::ByteSwapper< T >::SwapWriteRangeFromSystemToLittleEndian ( T * p,

int num,

OStreamType * fp

) [static]

template<class T>

static bool itk::ByteSwapper< T >::SystemIsBE ( ) [inline, static]

Definition at line 58 of file itkByteSwapper.h.

template<class T>

Query the machine Endian ness* static bool itk::ByteSwapper< T >::SystemIsBigEndian ( ) [static]

template<class T>

static bool itk::ByteSwapper< T >::SystemIsLE ( ) [inline, static]

Definition at line 60 of file itkByteSwapper.h.

template<class T>

static bool itk::ByteSwapper< T >::SystemIsLittleEndian ( ) [static]

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

template<class T>

Generic swap method handles type T The data is* swapped and itk::ByteSwapper< T >::written ( in binary )

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

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

itkByteSwapper.h

Generated at Sun Jul 9 19:09:27 2006 for ITK by


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef std::ostream	OStreamType
typedef SmartPointer< Self >	Pointer
typedef ByteSwapper	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Generic swap method handles type T The data is *swapped and	written (in binary) to the ostream given.A total of num values of type T are written and swapped.Either 2-byte or 4-byte swapping *can be handled.Single byte types are not swapped
Generic swap method handles type T The data is *swapped and	written (in binary) to the ostream given.A total of num values of type T are written and swapped.Either 2-byte or 4-byte swapping *can be handled.Single byte types are not swapped
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
static void	SwapFromSystemToBigEndian (T *p)
static void	SwapFromSystemToLittleEndian (T *p)
static void	SwapRangeFromSystemToBigEndian (T *p, unsigned long num)
static void	SwapRangeFromSystemToLittleEndian (T *p, unsigned long num)
others raise an exception The method is used to swap to and from Big Endian *static void	SwapWriteRangeFromSystemToBigEndian (T p, int num, OStreamType fp)
others raise an exception The method is used to swap to and from Little Endian *static void	SwapWriteRangeFromSystemToLittleEndian (T p, int num, OStreamType fp)
static bool	SystemIsBE ()
Query the machine Endian ness *static bool	SystemIsBigEndian ()
static bool	SystemIsLE ()
static bool	SystemIsLittleEndian ()
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK object.This is an implementation of the subject/observer design pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	ByteSwapper ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	~ByteSwapper ()
Static Protected Member Functions
static void	Swap2 (void *p)
static void	Swap2Range (void *p, unsigned long num)
static void	Swap4 (void *p)
static void	Swap4Range (void *p, unsigned long num)
static void	Swap8 (void *p)
static void	Swap8Range (void *p, unsigned long num)
static void	SwapWrite2Range (void p, unsigned long num, OStreamType fp)
static void	SwapWrite4Range (void p, unsigned long num, OStreamType fp)
static void	SwapWrite8Range (void p, unsigned long num, OStreamType fp)
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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./virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

itk::ByteSwapper< T > Class Template Reference [Input and Output Filters, OS System Objects]

Detailed Description

template<class T> class itk::ByteSwapper< T >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions