ITK: itk::GDCMImageIO Class Reference

typedef SmartPointer<const Self> itk::LightProcessObject::ConstPointer [inherited]

Reimplemented from itk::Object.

Definition at line 78 of file itkLightProcessObject.h.

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

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::DicomImageIO.

Definition at line 63 of file itkGDCMImageIO.h.

typedef GDCMImageIO itk::GDCMImageIO::Self

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::DicomImageIO.

Definition at line 61 of file itkGDCMImageIO.h.

typedef ImageIOBase itk::GDCMImageIO::Superclass

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::DicomImageIO.

Definition at line 62 of file itkGDCMImageIO.h.

enum itk::ImageIOBase::ByteOrder [inherited]

Enums used to specify byte order; whether Big Endian or Little Endian. Some subclasses use this, some ignore it.

Enumerator:

BigEndian
LittleEndian
OrderNotApplicable

Definition at line 189 of file itkImageIOBase.h.

enum itk::ImageIOBase::FileType [inherited]

Enums used to specify write style: whether binary or ASCII. Some subclasses use this, some ignore it.

Enumerator:

ASCII
Binary
TypeNotApplicable

Definition at line 185 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOComponentType [inherited]

Enums used to manipulate the component type. The component type refers to the actual storage class associated with either a SCALAR pixel type or elements of a compound pixel.

Enumerator:

UNKNOWNCOMPONENTTYPE
UCHAR
CHAR
USHORT
SHORT
UINT
INT
ULONG
LONG
FLOAT
DOUBLE

Definition at line 88 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOPixelType [inherited]

Enums used to manipulate the pixel type. The pixel type provides context for automatic data conversions (for instance, RGB to SCALAR, VECTOR to SCALAR).

Enumerator:

UNKNOWNPIXELTYPE
SCALAR
RGB
RGBA
OFFSET
VECTOR
POINT
COVARIANTVECTOR
SYMMETRICSECONDRANKTENSOR
DIFFUSIONTENSOR3D
COMPLEX
FIXEDARRAY

Definition at line 80 of file itkImageIOBase.h.

enum itk::GDCMImageIO::TCompressionType

Set/Get a boolean to use the JPEG2000 compression or not.

Enumerator:

JPEG
JPEG2000

Definition at line 219 of file itkGDCMImageIO.h.

itk::GDCMImageIO::GDCMImageIO ( ) [protected]

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

virtual void itk::LightProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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

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

virtual bool itk::GDCMImageIO::CanReadFile ( const char * ) [virtual]

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::ImageIOBase::CanStreamRead ( ) [inline, virtual, inherited]

Determine if the ImageIO can stream reading from this file. Default is false.

Definition at line 250 of file itkImageIOBase.h.

virtual bool itk::ImageIOBase::CanStreamWrite ( ) [inline, virtual, inherited]

Determine if the ImageIO can stream writing to this file. Default is false.

Definition at line 268 of file itkImageIOBase.h.

virtual bool itk::GDCMImageIO::CanWriteFile ( const char * ) [virtual]

Determine the file type. Returns true if this ImageIO can write the file specified. GDCM triggers on ".dcm" and ".dicom".

Implements itk::ImageIOBase.

void itk::ImageIOBase::ComputeStrides ( ) [protected, inherited]

Calculates the different strides (distance from one thing to the next). Upon return, strides[0] = bytes to get to the next component of a pixel, strides[1] = bytes to get to the next pixel in x direction, strides[2] = bytes to get to the next row in y direction, strides[3] = bytes to get to the next slice in z direction, etc.

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.

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

This method causes the filter to generate its output.

Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TInputImage >, and itk::ClassifierBase< TSample >.

Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::GDCMImageIO::GetBodyPart ( char * part )

virtual const ByteOrder& itk::ImageIOBase::GetByteOrder ( ) [virtual, inherited]

std::string itk::ImageIOBase::GetByteOrderAsString ( ByteOrder ) const [inherited]

Convenience method returns the ByteOrder as a string. This can be used for writing output files.

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.

virtual unsigned int itk::ImageIOBase::GetComponentSize ( ) const [protected, virtual, inherited]

Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte. This method can be invoked only after the component type is set.

Reimplemented in itk::IPLCommonImageIO.

unsigned int itk::ImageIOBase::GetComponentStride ( ) const [protected, inherited]

Convenient method for accessing number of bytes to get to the next pixel component. Returns m_Strides[0].

virtual const IOComponentType& itk::ImageIOBase::GetComponentType ( ) [virtual, inherited]

std::string itk::ImageIOBase::GetComponentTypeAsString ( IOComponentType ) const [inherited]

Convenience method returns the IOComponentType as a string. This can be used for writing output files.

virtual const std::type_info& itk::ImageIOBase::GetComponentTypeInfo ( ) const [virtual, inherited]

Reimplemented in itk::IPLCommonImageIO.

virtual const TCompressionType& itk::GDCMImageIO::GetCompressionType ( ) [virtual]

Set/Get a boolean to use the JPEG2000 compression or not.

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

Get the value of the debug flag.

virtual unsigned int itk::ImageIOBase::GetDimensions ( unsigned int i ) const [inline, virtual, inherited]

Definition at line 102 of file itkImageIOBase.h.

virtual std::vector<double> itk::ImageIOBase::GetDirection ( unsigned int i ) const [inline, virtual, inherited]

Definition at line 124 of file itkImageIOBase.h.

virtual const char* itk::ImageIOBase::GetFileName ( ) const [virtual, inherited]

virtual const FileType& itk::ImageIOBase::GetFileType ( ) [virtual, inherited]

std::string itk::ImageIOBase::GetFileTypeAsString ( FileType ) const [inherited]

Convenience method returns the FileType as a string. This can be used for writing output files.

virtual const char* itk::GDCMImageIO::GetFrameOfReferenceInstanceUID ( ) const [virtual]

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

unsigned int itk::ImageIOBase::GetImageSizeInBytes ( ) const [inherited]

Return the number of bytes in the image.

unsigned int itk::ImageIOBase::GetImageSizeInComponents ( ) const [inherited]

Return the number of pixels times the number of components in the image.

unsigned int itk::ImageIOBase::GetImageSizeInPixels ( ) const [inherited]

Return the number of pixels in the image.

void itk::GDCMImageIO::GetInstitution ( char * ins )

virtual ImageIORegion itk::ImageIOBase::GetIORegion ( ) [virtual, inherited]

virtual bool itk::GDCMImageIO::GetKeepOriginalUID ( ) [virtual]

static bool itk::GDCMImageIO::GetLabelFromTag	(	const std::string &	tag,
		std::string &	labelId
	)			`[static]`

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

virtual bool itk::GDCMImageIO::GetLoadPrivateTags ( ) [virtual]

static bool itk::GDCMImageIO::GetLoadPrivateTagsDefault ( ) [inline, static]

Definition at line 214 of file itkGDCMImageIO.h.

virtual bool itk::GDCMImageIO::GetLoadSequences ( ) [virtual]

static bool itk::GDCMImageIO::GetLoadSequencesDefault ( ) [inline, static]

Definition at line 198 of file itkGDCMImageIO.h.

void itk::GDCMImageIO::GetManufacturer ( char * manu )

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.

void itk::GDCMImageIO::GetModality ( char * modality )

void itk::GDCMImageIO::GetModel ( char * model )

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

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

virtual const char* itk::GDCMImageIO::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::DicomImageIO.

virtual const unsigned int& itk::ImageIOBase::GetNumberOfComponents ( ) [virtual, inherited]

virtual unsigned int itk::ImageIOBase::GetNumberOfDimensions ( ) [virtual, inherited]

void itk::GDCMImageIO::GetNumberOfSeriesInStudy ( char * series )

void itk::GDCMImageIO::GetNumberOfStudyRelatedSeries ( char * series )

virtual double itk::ImageIOBase::GetOrigin ( unsigned int i ) const [inline, virtual, inherited]

Definition at line 109 of file itkImageIOBase.h.

void itk::GDCMImageIO::GetPatientAge ( char * age )

void itk::GDCMImageIO::GetPatientDOB ( char * dob )

void itk::GDCMImageIO::GetPatientID ( char * id )

void itk::GDCMImageIO::GetPatientName ( char * name )

Convenience methods to query patient information and scanner information. These methods are here for compatibility with the DICOMImageIO2 class.

void itk::GDCMImageIO::GetPatientSex ( char * sex )

virtual unsigned int itk::ImageIOBase::GetPixelSize ( ) const [protected, virtual, inherited]

Compute the size (in bytes) of the pixel. For example, and RGB pixel of unsigned char would have size 3 bytes.

virtual unsigned int itk::ImageIOBase::GetPixelStride ( ) const [virtual, inherited]

Convenient method for accessing the number of bytes to get to the next pixel. Returns m_Strides[1];

virtual const IOPixelType& itk::ImageIOBase::GetPixelType ( ) [virtual, inherited]

std::string itk::ImageIOBase::GetPixelTypeAsString ( IOPixelType ) const [inherited]

Convenience method returns the IOPixelType as a string. This can be used for writing output files.

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

virtual double itk::GDCMImageIO::GetRescaleIntercept ( ) [virtual]

virtual double itk::GDCMImageIO::GetRescaleSlope ( ) [virtual]

Macro to access Rescale Slope and Rescale Intercept. Which are needed to rescale properly image when needed. User then need to Always check those value when access value from the DICOM header

unsigned int itk::ImageIOBase::GetRowStride ( ) const [protected, inherited]

Convenient method for accessing the number of bytes to get to the next row. Returns m_Strides[2].

void itk::GDCMImageIO::GetScanOptions ( char * options )

virtual const char* itk::GDCMImageIO::GetSeriesInstanceUID ( ) const [virtual]

unsigned int itk::ImageIOBase::GetSliceStride ( ) const [protected, inherited]

Convenient method for accessing the number of bytes to get to the next slice. Returns m_Strides[3].

virtual double itk::ImageIOBase::GetSpacing ( unsigned int i ) const [inline, virtual, inherited]

Definition at line 116 of file itkImageIOBase.h.

void itk::GDCMImageIO::GetStudyDate ( char * date )

void itk::GDCMImageIO::GetStudyDescription ( char * desc )

void itk::GDCMImageIO::GetStudyID ( char * id )

virtual const char* itk::GDCMImageIO::GetStudyInstanceUID ( ) const [virtual]

Access the generated DICOM UID's.

virtual const char* itk::GDCMImageIO::GetUIDPrefix ( ) const [virtual]

Macro to access the DICOM UID prefix. By default this is the ITK root id. This default can be overriden if the exam is for example part of an existing study.

virtual const bool& itk::ImageIOBase::GetUseCompression ( ) [virtual, inherited]

bool itk::GDCMImageIO::GetValueFromTag	(	const std::string &	tag,
		std::string &	value
	)

More general method to retrieve an arbitrary DICOM value based on a DICOM Tag (eg "0123|4567").

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::GDCMImageIO::InternalReadImageInformation ( std::ifstream & file ) [protected]

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::GDCMImageIO::KeepOriginalUIDOff ( ) [virtual]

virtual void itk::GDCMImageIO::KeepOriginalUIDOn ( ) [virtual]

static void itk::GDCMImageIO::LoadPrivateTagsDefaultOff ( ) [inline, static]

Definition at line 212 of file itkGDCMImageIO.h.

static void itk::GDCMImageIO::LoadPrivateTagsDefaultOn ( ) [inline, static]

Definition at line 210 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::LoadPrivateTagsOff ( ) [virtual]

virtual void itk::GDCMImageIO::LoadPrivateTagsOn ( ) [virtual]

static void itk::GDCMImageIO::LoadSequencesDefaultOff ( ) [inline, static]

Definition at line 196 of file itkGDCMImageIO.h.

static void itk::GDCMImageIO::LoadSequencesDefaultOn ( ) [inline, static]

Definition at line 194 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::LoadSequencesOff ( ) [virtual]

virtual void itk::GDCMImageIO::LoadSequencesOn ( ) [virtual]

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::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), 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< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::GDCMImageIO::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::DicomImageIO.

bool itk::GDCMImageIO::OpenGDCMFileForReading	(	std::ifstream &	os,
		const char *	filename
	)			`[protected]`

bool itk::GDCMImageIO::OpenGDCMFileForWriting	(	std::ofstream &	os,
		const char *	filename
	)			`[protected]`

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

void itk::GDCMImageIO::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::ImageIOBase.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

virtual void itk::GDCMImageIO::Read ( void * buffer ) [virtual]

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

void itk::ImageIOBase::ReadBufferAsASCII	(	std::istream &	os,
		void *	buffer,
		IOComponentType	ctype,
		unsigned int	numComp
	)			`[protected, inherited]`

Convenient method to read a buffer as ASCII text.

bool itk::ImageIOBase::ReadBufferAsBinary	(	std::istream &	os,
		void *	buffer,
		unsigned int	numComp
	)			`[protected, inherited]`

Convenient method to read a buffer as binary. Return true on success.

virtual void itk::GDCMImageIO::ReadImageInformation ( ) [virtual]

Set the spacing and dimesion information for the current filename.

Implements itk::ImageIOBase.

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.

virtual void itk::ImageIOBase::Reset ( const bool freeDynamic = true ) [protected, virtual, inherited]

Return the object to an initialized state, ready to be used

void itk::ImageIOBase::Resize	(	const unsigned int	numDimensions,
		const unsigned int *	dimensions
	)			`[protected, inherited]`

Resize the ImageIOBase object to new dimensions.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

virtual void itk::ImageIOBase::SetByteOrder ( ByteOrder _arg ) [virtual, inherited]

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods.

void itk::ImageIOBase::SetByteOrderToBigEndian ( ) [inline, inherited]

Definition at line 214 of file itkImageIOBase.h.

void itk::ImageIOBase::SetByteOrderToLittleEndian ( ) [inline, inherited]

Definition at line 216 of file itkImageIOBase.h.

virtual void itk::ImageIOBase::SetComponentType ( IOComponentType _arg ) [virtual, inherited]

Set/Get the component type of the image. This is always a native type.

virtual void itk::GDCMImageIO::SetCompressionType ( TCompressionType _arg ) [virtual]

Set/Get a boolean to use the JPEG2000 compression or not.

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

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

virtual void itk::ImageIOBase::SetDimensions	(	unsigned int	i,
		unsigned int	dim
	)			`[virtual, inherited]`

Set/Get the image dimensions in the x, y, z, etc. directions. GetDimensions() is typically used after reading the data; the SetDimensions() is used prior to writing the data.

virtual void itk::ImageIOBase::SetDirection	(	unsigned int	i,
		vnl_vector< double > &	direction
	)			`[virtual, inherited]`

virtual void itk::ImageIOBase::SetDirection	(	unsigned int	i,
		std::vector< double > &	direction
	)			`[virtual, inherited]`

Set/Get the image direction on an axis-by-axis basis. The SetDirection() method is required when writing the image.

virtual void itk::ImageIOBase::SetFileName ( const char * _arg ) [virtual, inherited]

Set/Get the name of the file to be read.

virtual void itk::ImageIOBase::SetFileType ( FileType _arg ) [virtual, inherited]

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

void itk::ImageIOBase::SetFileTypeToASCII ( ) [inline, inherited]

Definition at line 195 of file itkImageIOBase.h.

void itk::ImageIOBase::SetFileTypeToBinary ( ) [inline, inherited]

Definition at line 197 of file itkImageIOBase.h.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

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

virtual void itk::ImageIOBase::SetIORegion ( ImageIORegion _arg ) [virtual, inherited]

Specify the region of the image data to either read or write. The IORegion specifies the part of the image to read or write. Regions are defined with an index and a size vector. These vectors define the start (lower-left corner) and length of the region within the image. Make sure that the IORegion lies within the image.

virtual void itk::GDCMImageIO::SetKeepOriginalUID ( bool _arg ) [virtual]

Preserve the original DICOM UID of the input files

virtual void itk::GDCMImageIO::SetLoadPrivateTags ( bool _arg ) [virtual]

Parse any private tags in the DICOM file. Defaults to the value of LoadPrivateTagsDefault. Loading DICOM files is faster when private tags are not needed.

static void itk::GDCMImageIO::SetLoadPrivateTagsDefault ( bool b ) [inline, static]

Global method to define the default value for LoadPrivateTags. When instances of GDCMImageIO are created, the ivar LoadPrivateTags is initialized to the value of LoadPrivateTagsDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Definition at line 208 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::SetLoadSequences ( bool _arg ) [virtual]

Parse any sequences in the DICOM file. Defaults to the value of LoadSequencesDefault. Loading DICOM files is faster when sequences are not needed.

static void itk::GDCMImageIO::SetLoadSequencesDefault ( bool b ) [inline, static]

Global method to define the default value for LoadSequences. When instances of GDCMImageIO are created, the ivar LoadSequences is initialized to the value of LoadSequencesDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Definition at line 192 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::SetMaxSizeLoadEntry ( long _arg ) [virtual]

A DICOM file can contains multiple binary stream that can be very long For example an Overlay on the image. Most of the time user do not want to load this binary structure in memory since it can consume lot of memory. Therefore any field that is bigger than the default value 0xfff is discarded and just seek'd This method allow advanced user to force the reading of such field

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

Returns:: Set the MetaDataDictionary

virtual void itk::ImageIOBase::SetNumberOfComponents ( unsigned int _arg ) [virtual, inherited]

Set/Get the number of components per pixel in the image. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

void itk::ImageIOBase::SetNumberOfDimensions ( unsigned int ) [inherited]

Set/Get the number of independent variables (dimensions) in the image being read or written. Note this is not necessarily what is written, rather the IORegion controls that.

virtual void itk::ImageIOBase::SetOrigin	(	unsigned int	i,
		double	origin
	)			`[virtual, inherited]`

Set/Get the image origin on a axis-by-axis basis. The SetOrigin() method is required when writing the image.

virtual void itk::ImageIOBase::SetPixelType ( IOPixelType _arg ) [virtual, inherited]

Set/Get the type of the pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Anyother of PIXELTYPE will have more than one component.

virtual bool itk::ImageIOBase::SetPixelTypeInfo ( const std::type_info & ptype ) [virtual, inherited]

SetPixelTypeInfo is used by writers to convert from an ITK strongly typed pixel to a ImageIO (weaker) typed pixel. This function sets these PixelType, ComponentType, and NumberOfComponents based on RTTI type_info structure passed in. The function returns false if the pixel type is not supported.

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ImageIOBase::SetSpacing	(	unsigned int	i,
		double	spacing
	)			`[virtual, inherited]`

Set/Get the image spacing on an axis-by-axis basis. The SetSpacing() method is required when writing the image.

virtual void itk::GDCMImageIO::SetUIDPrefix ( const char * _arg ) [virtual]

Macro to access the DICOM UID prefix. By default this is the ITK root id. This default can be overriden if the exam is for example part of an existing study.

virtual void itk::ImageIOBase::SetUseCompression ( bool _arg ) [virtual, inherited]

Set/Get a boolean to use the compression or not.

virtual bool itk::ImageIOBase::SupportsDimension ( unsigned long dim ) [inline, virtual, inherited]

The different types of ImageIO's can support data of varying dimensionality. For example, some file formats are strictly 2D while others can support 2D, 3D, or even n-D. This method returns true/false as to whether the ImageIO can support the dimension indicated.

Reimplemented in itk::MetaImageIO, itk::NrrdImageIO, and itk::RawImageIO< TPixel, VImageDimension >.

Definition at line 286 of file itkImageIOBase.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::LightProcessObject::UpdateOutputData ( ) [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

virtual void itk::GDCMImageIO::Write ( const void * buffer ) [virtual]

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

void itk::ImageIOBase::WriteBufferAsASCII	(	std::ostream &	os,
		const void *	buffer,
		IOComponentType	ctype,
		unsigned int	numComp
	)			`[protected, inherited]`

Convenient method to write a buffer as ASCII text.

virtual void itk::GDCMImageIO::WriteImageInformation ( ) [virtual]

Writes the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

ByteOrder itk::ImageIOBase::m_ByteOrder [protected, inherited]

Big or Little Endian, and the type of the file. (May be ignored.)

Definition at line 302 of file itkImageIOBase.h.

IOComponentType itk::ImageIOBase::m_ComponentType [protected, inherited]

Used internally to keep track of the type of the component. It is set when ComputeStrides() is invoked.

Definition at line 299 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Dimensions [protected, inherited]

The array which stores the number of pixels in the x, y, z directions.

Definition at line 326 of file itkImageIOBase.h.

std::vector<std::vector<double> > itk::ImageIOBase::m_Direction [protected, inherited]

The arrays which store the direction cosines of the image.

Definition at line 336 of file itkImageIOBase.h.

std::string itk::ImageIOBase::m_FileName [protected, inherited]

Filename to read

Definition at line 309 of file itkImageIOBase.h.

FileType itk::ImageIOBase::m_FileType [protected, inherited]

Definition at line 303 of file itkImageIOBase.h.

std::string itk::GDCMImageIO::m_FrameOfReferenceInstanceUID [protected]

Definition at line 239 of file itkGDCMImageIO.h.

bool itk::ImageIOBase::m_Initialized [protected, inherited]

Does the ImageIOBase object have enough info to be of use?

Definition at line 306 of file itkImageIOBase.h.

ImageIORegion itk::ImageIOBase::m_IORegion [protected, inherited]

The region to read or write. The region contains information about the data within the region to read or write.

Definition at line 323 of file itkImageIOBase.h.

bool itk::GDCMImageIO::m_KeepOriginalUID [protected]

Definition at line 240 of file itkGDCMImageIO.h.

long itk::GDCMImageIO::m_MaxSizeLoadEntry [protected]

Definition at line 241 of file itkGDCMImageIO.h.

unsigned int itk::ImageIOBase::m_NumberOfComponents [protected, inherited]

Stores the number of components per pixel. This will be 1 for grayscale images, 3 for RGBPixel images, and 4 for RGBPixelA images.

Definition at line 313 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfDimensions [protected, inherited]

The number of independent dimensions in the image.

Definition at line 316 of file itkImageIOBase.h.

std::vector<double> itk::ImageIOBase::m_Origin [protected, inherited]

The array which stores the origin of the image.

Definition at line 333 of file itkImageIOBase.h.

IOPixelType itk::ImageIOBase::m_PixelType [protected, inherited]

Used internally to keep track of the type of the pixel.

Definition at line 295 of file itkImageIOBase.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.

double itk::GDCMImageIO::m_RescaleIntercept [protected]

Definition at line 234 of file itkGDCMImageIO.h.

double itk::GDCMImageIO::m_RescaleSlope [protected]

Definition at line 233 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_SeriesInstanceUID [protected]

Definition at line 238 of file itkGDCMImageIO.h.

std::vector<double> itk::ImageIOBase::m_Spacing [protected, inherited]

The array which stores the spacing of pixels in the x, y, z directions.

Definition at line 330 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Strides [protected, inherited]

Stores the number of bytes it takes to get to the next 'thing' e.g. component, pixel, row, slice, etc.

Definition at line 340 of file itkImageIOBase.h.

std::string itk::GDCMImageIO::m_StudyInstanceUID [protected]

Definition at line 237 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_UIDPrefix [protected]

Definition at line 236 of file itkGDCMImageIO.h.

bool itk::ImageIOBase::m_UseCompression [protected, inherited]

Should we compress the data?

Definition at line 319 of file itkImageIOBase.h.

itk::GDCMImageIO Class Reference
[Input and Output Filters]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


enum	TCompressionType { JPEG = 0, JPEG2000 }
virtual const TCompressionType &	GetCompressionType ()
virtual void	SetCompressionType (TCompressionType _arg)
Public Types
enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }
typedef SmartPointer< const Self >	ConstPointer
enum	FileType { ASCII, Binary, TypeNotApplicable }
enum	IOComponentType { UNKNOWNCOMPONENTTYPE, UCHAR, CHAR, USHORT, SHORT, UINT, INT, ULONG, LONG, FLOAT, DOUBLE }
enum	IOPixelType { UNKNOWNPIXELTYPE, SCALAR, RGB, RGBA, OFFSET, VECTOR, POINT, COVARIANTVECTOR, SYMMETRICSECONDRANKTENSOR, DIFFUSIONTENSOR3D, COMPLEX, FIXEDARRAY }
typedef SmartPointer< Self >	Pointer
typedef GDCMImageIO	Self
typedef ImageIOBase	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual bool	CanReadFile (const char *)
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual bool	CanWriteFile (const char *)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
std::string	GetByteOrderAsString (ByteOrder) const
Command *	GetCommand (unsigned long tag)
std::string	GetComponentTypeAsString (IOComponentType) const
bool	GetDebug () const
std::string	GetFileTypeAsString (FileType) const
unsigned int	GetImageSizeInBytes () const
unsigned int	GetImageSizeInComponents () const
unsigned int	GetImageSizeInPixels () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetPixelStride () const
std::string	GetPixelTypeAsString (IOPixelType) const
virtual int	GetReferenceCount () const
bool	GetValueFromTag (const std::string &tag, std::string &value)
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	Read (void *buffer)
virtual void	ReadImageInformation ()
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetMaxSizeLoadEntry (long _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual bool	SetPixelTypeInfo (const std::type_info &ptype)
virtual void	SetReferenceCount (int)
virtual bool	SupportsDimension (unsigned long dim)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	Write (const void *buffer)
virtual void	WriteImageInformation ()

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

void	GetBodyPart (char *part)
void	GetInstitution (char *ins)
void	GetManufacturer (char *manu)
void	GetModality (char *modality)
void	GetModel (char *model)
void	GetNumberOfSeriesInStudy (char *series)
void	GetNumberOfStudyRelatedSeries (char *series)
void	GetPatientAge (char *age)
void	GetPatientDOB (char *dob)
void	GetPatientID (char *id)
void	GetPatientName (char *name)
void	GetPatientSex (char *sex)
void	GetScanOptions (char *options)
void	GetStudyDate (char *date)
void	GetStudyDescription (char *desc)
void	GetStudyID (char *id)

virtual const ByteOrder &	GetByteOrder ()
virtual void	SetByteOrder (ByteOrder _arg)
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()

virtual const IOComponentType &	GetComponentType ()
virtual const std::type_info &	GetComponentTypeInfo () const
virtual void	SetComponentType (IOComponentType _arg)

virtual unsigned int	GetDimensions (unsigned int i) const
virtual void	SetDimensions (unsigned int i, unsigned int dim)

virtual std::vector< double >	GetDirection (unsigned int i) const
virtual void	SetDirection (unsigned int i, vnl_vector< double > &direction)
virtual void	SetDirection (unsigned int i, std::vector< double > &direction)

virtual const char *	GetFileName () const
virtual void	SetFileName (const char *_arg)

virtual const FileType &	GetFileType ()
virtual void	SetFileType (FileType _arg)
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()

virtual const char *	GetFrameOfReferenceInstanceUID () const
virtual const char *	GetSeriesInstanceUID () const
virtual const char *	GetStudyInstanceUID () const

virtual ImageIORegion	GetIORegion ()
virtual void	SetIORegion (ImageIORegion _arg)

virtual bool	GetKeepOriginalUID ()
virtual void	KeepOriginalUIDOff ()
virtual void	KeepOriginalUIDOn ()
virtual void	SetKeepOriginalUID (bool _arg)

virtual bool	GetLoadPrivateTags ()
virtual void	LoadPrivateTagsOff ()
virtual void	LoadPrivateTagsOn ()
virtual void	SetLoadPrivateTags (bool _arg)

virtual bool	GetLoadSequences ()
virtual void	LoadSequencesOff ()
virtual void	LoadSequencesOn ()
virtual void	SetLoadSequences (bool _arg)

virtual const unsigned int &	GetNumberOfComponents ()
virtual void	SetNumberOfComponents (unsigned int _arg)

virtual unsigned int	GetNumberOfDimensions ()
void	SetNumberOfDimensions (unsigned int)

virtual double	GetOrigin (unsigned int i) const
virtual void	SetOrigin (unsigned int i, double origin)

virtual const IOPixelType &	GetPixelType ()
virtual void	SetPixelType (IOPixelType _arg)

virtual const float &	GetProgress ()

virtual double	GetRescaleIntercept ()
virtual double	GetRescaleSlope ()

virtual double	GetSpacing (unsigned int i) const
virtual void	SetSpacing (unsigned int i, double spacing)

virtual const char *	GetUIDPrefix () const
virtual void	SetUIDPrefix (const char *_arg)

virtual const bool &	GetUseCompression ()
virtual void	SetUseCompression (bool _arg)

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetLabelFromTag (const std::string &tag, std::string &labelId)
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)

static bool	GetLoadPrivateTagsDefault ()
static void	LoadPrivateTagsDefaultOff ()
static void	LoadPrivateTagsDefaultOn ()
static void	SetLoadPrivateTagsDefault (bool b)

static bool	GetLoadSequencesDefault ()
static void	LoadSequencesDefaultOff ()
static void	LoadSequencesDefaultOn ()
static void	SetLoadSequencesDefault (bool b)
Protected Member Functions
void	ComputeStrides ()
	GDCMImageIO ()
virtual void	GenerateData ()
virtual unsigned int	GetComponentSize () const
unsigned int	GetComponentStride () const
virtual unsigned int	GetPixelSize () const
unsigned int	GetRowStride () const
unsigned int	GetSliceStride () const
void	InternalReadImageInformation (std::ifstream &file)
bool	OpenGDCMFileForReading (std::ifstream &os, const char *filename)
bool	OpenGDCMFileForWriting (std::ofstream &os, const char *filename)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, unsigned int numComp)
bool	ReadBufferAsBinary (std::istream &os, void *buffer, unsigned int numComp)
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, unsigned int numComp)
	~GDCMImageIO ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
ByteOrder	m_ByteOrder
IOComponentType	m_ComponentType
std::vector< unsigned int >	m_Dimensions
std::vector< std::vector< double > >	m_Direction
std::string	m_FileName
FileType	m_FileType
std::string	m_FrameOfReferenceInstanceUID
bool	m_Initialized
ImageIORegion	m_IORegion
bool	m_KeepOriginalUID
long	m_MaxSizeLoadEntry
unsigned int	m_NumberOfComponents
unsigned int	m_NumberOfDimensions
std::vector< double >	m_Origin
IOPixelType	m_PixelType
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
double	m_RescaleIntercept
double	m_RescaleSlope
std::string	m_SeriesInstanceUID
std::vector< double >	m_Spacing
std::vector< unsigned int >	m_Strides
std::string	m_StudyInstanceUID
std::string	m_UIDPrefix
bool	m_UseCompression

itk::GDCMImageIO Class Reference [Input and Output Filters]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::GDCMImageIO Class Reference
[Input and Output Filters]