ITK
4.10.0
Insight Segmentation and Registration Toolkit
|
#include <itkRawImageIO.h>
Read and write raw binary images.
This class reads and writes 2D or 3D images. Because raw data has little useful information built into the format, the user is responsible for specifying pixel type, dimensions, spacing, origin, header type, and so on. (Note: the pixel type and image dimension is defined via the template parameter.)
Definition at line 48 of file itkRawImageIO.h.
Public Member Functions | |
virtual bool | CanReadFile (const char *) override |
virtual bool | CanWriteFile (const char *) override |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
SizeValueType | GetHeaderSize () |
virtual const char * | GetNameOfClass () const |
virtual void | Read (void *buffer) override |
virtual void | ReadHeader (const std::string=std::string()) |
virtual void | ReadImageInformation () override |
void | SetHeaderSize (SizeValueType size) |
virtual bool | SupportsDimension (unsigned long dim) override |
virtual void | Write (const void *buffer) override |
virtual void | WriteImageInformation (void) override |
virtual void | SetFileDimensionality (unsigned long _arg) |
virtual unsigned long | GetFileDimensionality () const |
virtual const unsigned short & | GetImageMask () const |
void | SetImageMask (unsigned long val) |
Public Member Functions inherited from itk::ImageIOBase | |
virtual bool | CanStreamRead () |
virtual bool | CanStreamWrite () |
virtual ImageIORegion | GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const |
virtual unsigned int | GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) |
std::string | GetByteOrderAsString (ByteOrder) const |
virtual unsigned int | GetComponentSize () const |
virtual IOComponentType | GetComponentType () const |
virtual const std::type_info & | GetComponentTypeInfo () const |
virtual std::vector< double > | GetDefaultDirection (unsigned int i) const |
virtual SizeValueType | GetDimensions (unsigned int i) const |
virtual std::vector< double > | GetDirection (unsigned int i) const |
std::string | GetFileTypeAsString (FileType) const |
SizeType | GetImageSizeInBytes () const |
SizeType | GetImageSizeInComponents () const |
SizeType | GetImageSizeInPixels () const |
virtual unsigned int | GetNumberOfDimensions () const |
virtual double | GetOrigin (unsigned int i) const |
virtual SizeType | GetPixelStride () const |
virtual double | GetSpacing (unsigned int i) const |
virtual ImageIORegion | GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) |
const ArrayOfExtensionsType & | GetSupportedReadExtensions () const |
const ArrayOfExtensionsType & | GetSupportedWriteExtensions () const |
void | SetByteOrderToLittleEndian () |
virtual void | SetComponentType (const IOComponentType _arg) |
virtual void | SetDirection (unsigned int i, const std::vector< double > &direction) |
virtual void | SetDirection (unsigned int i, const vnl_vector< double > &direction) |
void | SetFileTypeToBinary () |
void | SetNumberOfDimensions (unsigned int) |
virtual void | SetOrigin (unsigned int i, double origin) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const std::complex< TPixel > *) |
template<unsigned VLength> | |
void | SetPixelTypeInfo (const Offset< VLength > *) |
virtual void | SetSpacing (unsigned int i, double spacing) |
template<typename TPixel > | |
void | SetTypeInfo (const TPixel *) |
virtual void | SetFileName (const char *_arg) |
virtual const char * | GetFileName () const |
virtual void | SetDimensions (unsigned int i, SizeValueType dim) |
virtual void | SetIORegion (ImageIORegion _arg) |
virtual const ImageIORegion & | GetIORegion () const |
virtual void | SetPixelType (const IOPixelType _arg) |
virtual IOPixelType | GetPixelType () const |
virtual void | SetNumberOfComponents (unsigned int _arg) |
virtual const unsigned int & | GetNumberOfComponents () const |
virtual void | SetUseCompression (bool _arg) |
virtual bool | GetUseCompression () const |
virtual void | UseCompressionOn () |
virtual void | UseCompressionOff () |
virtual void | SetUseStreamedReading (bool _arg) |
virtual bool | GetUseStreamedReading () const |
virtual void | UseStreamedReadingOn () |
virtual void | UseStreamedReadingOff () |
virtual void | SetUseStreamedWriting (bool _arg) |
virtual bool | GetUseStreamedWriting () const |
virtual void | UseStreamedWritingOn () |
virtual void | UseStreamedWritingOff () |
virtual void | SetFileType (const FileType _arg) |
virtual FileType | GetFileType () const |
void | SetFileTypeToASCII () |
virtual void | SetByteOrder (const ByteOrder _arg) |
virtual ByteOrder | GetByteOrder () const |
void | SetByteOrderToBigEndian () |
template<typename TPixel > | |
void | SetPixelTypeInfo (const TPixel *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const RGBPixel< TPixel > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const RGBAPixel< TPixel > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const Vector< TPixel, VLength > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const VariableLengthVector< TPixel > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const FixedArray< TPixel, VLength > *) |
Public Member Functions inherited from itk::LightProcessObject | |
virtual void | AbortGenerateDataOff () |
virtual void | AbortGenerateDataOn () |
virtual const bool & | GetAbortGenerateData () const |
virtual void | SetAbortGenerateData (bool _arg) |
virtual void | UpdateOutputData () |
void | UpdateProgress (float amount) |
virtual void | SetProgress (float _arg) |
virtual const float & | GetProgress () const |
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 noexcept override |
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::ImageIOBase | |
static std::string | GetComponentTypeAsString (IOComponentType) |
static IOComponentType | GetComponentTypeFromString (const std::string &typeString) |
static std::string | GetPixelTypeAsString (IOPixelType) |
static IOPixelType | GetPixelTypeFromString (const std::string &pixelString) |
Static Public Member Functions inherited from itk::LightProcessObject | |
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 | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
RawImageIO () | |
~RawImageIO () | |
Protected Member Functions inherited from itk::ImageIOBase | |
void | AddSupportedReadExtension (const char *extension) |
void | AddSupportedWriteExtension (const char *extension) |
void | ComputeStrides () |
virtual unsigned int | GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const |
SizeType | GetComponentStride () const |
virtual const ImageRegionSplitterBase * | GetImageRegionSplitter () const |
virtual unsigned int | GetPixelSize () const |
SizeType | GetRowStride () const |
SizeType | GetSliceStride () const |
virtual ImageIORegion | GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const |
ImageIOBase () | |
virtual void | OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false) |
virtual void | OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false) |
virtual void | ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead) |
bool | ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead) |
virtual void | Reset (const bool freeDynamic=true) |
void | Resize (const unsigned int numDimensions, const unsigned int *dimensions) |
virtual void | WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite) |
~ImageIOBase () | |
Protected Member Functions inherited from itk::LightProcessObject | |
virtual void | GenerateData () |
LightProcessObject () | |
~LightProcessObject () | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
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 Member Functions | |
void | operator= (const Self &) ITK_DELETE_FUNCTION |
RawImageIO (const Self &) ITK_DELETE_FUNCTION | |
Private Attributes | |
unsigned long | m_FileDimensionality |
SizeValueType | m_HeaderSize |
unsigned short | m_ImageMask |
std::string | m_InternalFileName |
bool | m_ManualHeaderSize |
Additional Inherited Members | |
Protected Attributes inherited from itk::ImageIOBase | |
ByteOrder | m_ByteOrder |
IOComponentType | m_ComponentType |
std::vector< SizeValueType > | m_Dimensions |
std::vector< std::vector< double > > | m_Direction |
std::string | m_FileName |
FileType | m_FileType |
bool | m_Initialized |
ImageIORegion | m_IORegion |
unsigned int | m_NumberOfComponents |
unsigned int | m_NumberOfDimensions |
std::vector< double > | m_Origin |
IOPixelType | m_PixelType |
std::vector< double > | m_Spacing |
std::vector< SizeType > | m_Strides |
bool | m_UseCompression |
bool | m_UseStreamedReading |
bool | m_UseStreamedWriting |
Protected Attributes inherited from itk::LightObject | |
AtomicInt< int > | m_ReferenceCount |
typedef ByteSwapper< ComponentType > itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType |
Helper class to swap bytes when necessary
Definition at line 73 of file itkRawImageIO.h.
typedef PixelTraits< PixelType >::ValueType itk::RawImageIO< TPixel, VImageDimension >::ComponentType |
this type is used in case the pixel has several components
Definition at line 70 of file itkRawImageIO.h.
typedef TPixel itk::RawImageIO< TPixel, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations.
Definition at line 60 of file itkRawImageIO.h.
typedef SmartPointer< Self > itk::RawImageIO< TPixel, VImageDimension >::Pointer |
Definition at line 54 of file itkRawImageIO.h.
typedef RawImageIO itk::RawImageIO< TPixel, VImageDimension >::Self |
Standard class typedefs.
Definition at line 52 of file itkRawImageIO.h.
typedef Superclass::SizeValueType itk::RawImageIO< TPixel, VImageDimension >::SizeValueType |
Type used for counting elements.
Definition at line 67 of file itkRawImageIO.h.
typedef ImageIOBase itk::RawImageIO< TPixel, VImageDimension >::Superclass |
Definition at line 53 of file itkRawImageIO.h.
|
protected |
|
protected |
|
private |
|
inlineoverridevirtual |
Determine the file type. Returns true if this ImageIOBase can read the file specified. Always returns false because we don't want to use this reader unless absolutely sure (i.e., manual ImageIO creation).
Implements itk::ImageIOBase.
Definition at line 101 of file itkRawImageIO.h.
|
overridevirtual |
Returns true if this ImageIO can write the specified file. False is only returned when the file name is not specified. Otherwise true is always returned.
Implements itk::ImageIOBase.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::ReadHeader().
|
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::LightProcessObject.
|
virtual |
The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".
SizeValueType itk::RawImageIO< TPixel, VImageDimension >::GetHeaderSize | ( | ) |
|
virtual |
Set/Get the Data mask.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageIOBase.
|
static |
Method for creation through the object factory.
Referenced by itk::RawImageIOFactory< TPixel, VImageDimension >::RegisterOneFactory().
|
private |
|
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::ImageIOBase.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation().
|
overridevirtual |
Reads the data from disk into the memory buffer provided.
Implements itk::ImageIOBase.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::ReadImageInformation().
|
inlinevirtual |
Read a file's header to determine image dimensions, etc.
Definition at line 121 of file itkRawImageIO.h.
References itk::RawImageIO< TPixel, VImageDimension >::CanWriteFile().
|
inlineoverridevirtual |
Binary files have no image information to read. This must be set by the user of the class.
Implements itk::ImageIOBase.
Definition at line 105 of file itkRawImageIO.h.
References itk::RawImageIO< TPixel, VImageDimension >::Read().
|
virtual |
The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".
void itk::RawImageIO< TPixel, VImageDimension >::SetHeaderSize | ( | SizeValueType | size | ) |
If the data is in the tail end of the file, you want to explicitly set the header size.
|
inline |
Set/Get the Data mask.
Definition at line 112 of file itkRawImageIO.h.
References itk::RawImageIO< TPixel, VImageDimension >::m_ImageMask, and itk::Object::Modified().
|
inlineoverridevirtual |
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 from itk::ImageIOBase.
Definition at line 93 of file itkRawImageIO.h.
References itk::RawImageIO< TPixel, VImageDimension >::m_FileDimensionality.
|
overridevirtual |
Writes the data to disk from the memory buffer provided.
Implements itk::ImageIOBase.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation().
|
inlineoverridevirtual |
Binary files have no image information to read.
Implements itk::ImageIOBase.
Definition at line 131 of file itkRawImageIO.h.
References itk::RawImageIO< TPixel, VImageDimension >::operator=(), itk::RawImageIO< TPixel, VImageDimension >::PrintSelf(), itk::RawImageIO< TPixel, VImageDimension >::RawImageIO(), itk::RawImageIO< TPixel, VImageDimension >::Write(), and itk::RawImageIO< TPixel, VImageDimension >::~RawImageIO().
|
private |
Definition at line 149 of file itkRawImageIO.h.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::SupportsDimension().
|
private |
Definition at line 151 of file itkRawImageIO.h.
|
private |
Definition at line 152 of file itkRawImageIO.h.
Referenced by itk::RawImageIO< TPixel, VImageDimension >::SetImageMask().
|
private |
Definition at line 147 of file itkRawImageIO.h.
|
private |
Definition at line 150 of file itkRawImageIO.h.