ITK
5.2.0
Insight Toolkit
|
#include <itkRawImageIO.h>
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
SizeValueType | GetHeaderSize () |
virtual const char * | GetNameOfClass () const |
void | SetHeaderSize (SizeValueType size) |
Public Member Functions inherited from itk::ImageIOBase | |
virtual void | SetFileName (const char *_arg) |
virtual const char * | GetFileName () const |
void | SetNumberOfDimensions (unsigned int) |
virtual unsigned int | GetNumberOfDimensions () const |
virtual void | SetDimensions (unsigned int i, SizeValueType dim) |
virtual SizeValueType | GetDimensions (unsigned int i) const |
virtual void | SetOrigin (unsigned int i, double origin) |
virtual double | GetOrigin (unsigned int i) const |
virtual void | SetSpacing (unsigned int i, double spacing) |
virtual double | GetSpacing (unsigned int i) const |
virtual void | SetDirection (unsigned int i, const std::vector< double > &direction) |
virtual void | SetDirection (unsigned int i, const vnl_vector< double > &direction) |
virtual std::vector< double > | GetDirection (unsigned int i) const |
virtual std::vector< double > | GetDefaultDirection (unsigned int k) const |
virtual void | SetIORegion (ImageIORegion _arg) |
virtual const ImageIORegion & | GetIORegion () const |
virtual void | SetPixelType (const ::itk::CommonEnums::IOPixel _arg) |
virtual ::itk::CommonEnums::IOPixel | GetPixelType () const |
virtual void | SetComponentType (const IOComponentEnum _arg) |
virtual IOComponentEnum | GetComponentType () const |
virtual const std::type_info & | GetComponentTypeInfo () 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 | SetCompressionLevel (int _arg) |
virtual int | GetCompressionLevel () const |
virtual void | SetCompressor (std::string _c) |
virtual const std::string & | GetCompressor () const |
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 | SetExpandRGBPalette (bool _arg) |
virtual bool | GetExpandRGBPalette () const |
virtual void | ExpandRGBPaletteOn () |
virtual void | ExpandRGBPaletteOff () |
virtual void | SetWritePalette (bool _arg) |
virtual bool | GetWritePalette () const |
virtual void | WritePaletteOn () |
virtual void | WritePaletteOff () |
virtual bool | GetIsReadAsScalarPlusPalette () const |
virtual void | SetFileType (const IOFileEnum _arg) |
virtual IOFileEnum | GetFileType () const |
void | SetFileTypeToASCII () |
void | SetFileTypeToBinary () |
virtual void | SetByteOrder (const IOByteOrderEnum _arg) |
virtual IOByteOrderEnum | GetByteOrder () const |
void | SetByteOrderToBigEndian () |
void | SetByteOrderToLittleEndian () |
std::string | GetFileTypeAsString (IOFileEnum) const |
std::string | GetByteOrderAsString (IOByteOrderEnum) const |
virtual SizeType | GetPixelStride () const |
SizeType | GetImageSizeInPixels () const |
SizeType | GetImageSizeInBytes () const |
SizeType | GetImageSizeInComponents () const |
virtual unsigned int | GetComponentSize () const |
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) |
virtual ImageIORegion | GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) |
const ArrayOfExtensionsType & | GetSupportedReadExtensions () const |
const ArrayOfExtensionsType & | GetSupportedWriteExtensions () const |
template<typename TPixel > | |
void | SetTypeInfo (const TPixel *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const TPixel *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const RGBPixel< TPixel > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const RGBAPixel< TPixel > *) |
template<unsigned VLength> | |
void | SetPixelTypeInfo (const Offset< VLength > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const Vector< TPixel, VLength > *) |
template<typename TCoordRep , unsigned NPointDimension> | |
void | SetPixelTypeInfo (const Point< TCoordRep, NPointDimension > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const std::complex< TPixel > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const FixedArray< TPixel, VLength > *) |
template<typename TPixel > | |
void | SetPixelTypeInfo (const VariableLengthVector< TPixel > *) |
template<typename TValue > | |
void | SetPixelTypeInfo (const Array< TValue > *) |
template<typename TPixel , unsigned VLength> | |
void | SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *) |
template<typename TValue > | |
void | SetPixelTypeInfo (const VariableSizeMatrix< TValue > *) |
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 | SetProgress (float _arg) |
virtual const float & | GetProgress () const |
void | UpdateProgress (float amount) |
virtual void | UpdateOutputData () |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
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 (IOComponentEnum) |
static IOComponentEnum | GetComponentTypeFromString (const std::string &typeString) |
static std::string | GetPixelTypeAsString (IOPixelEnum) |
static IOPixelEnum | 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 val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
std::string | m_InternalFileName |
unsigned long | m_FileDimensionality |
bool | m_ManualHeaderSize |
SizeValueType | m_HeaderSize |
unsigned short | m_ImageMask |
virtual void | SetFileDimensionality (unsigned long _arg) |
virtual unsigned long | GetFileDimensionality () const |
bool | SupportsDimension (unsigned long dim) override |
bool | CanReadFile (const char *) override |
void | ReadImageInformation () override |
void | Read (void *buffer) override |
virtual const unsigned short & | GetImageMask () const |
void | SetImageMask (unsigned long val) |
virtual void | ReadHeader (const std::string=std::string()) |
bool | CanWriteFile (const char *) override |
void | WriteImageInformation () override |
void | Write (const void *buffer) override |
RawImageIO () | |
~RawImageIO () override=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
Additional Inherited Members | |
Protected Member Functions inherited from itk::ImageIOBase | |
ImageIOBase () | |
~ImageIOBase () override | |
virtual const ImageRegionSplitterBase * | GetImageRegionSplitter () const |
virtual bool | HasSupportedReadExtension (const char *fileName, bool ignoreCase=true) |
virtual bool | HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true) |
virtual void | SetMaximumCompressionLevel (int) |
virtual int | GetMaximumCompressionLevel () const |
virtual void | InternalSetCompressor (const std::string &_compressor) |
virtual void | Reset (const bool freeDynamic=true) |
void | Resize (const unsigned int numDimensions, const unsigned int *dimensions) |
virtual unsigned int | GetPixelSize () const |
void | ComputeStrides () |
SizeType | GetComponentStride () const |
SizeType | GetRowStride () const |
SizeType | GetSliceStride () const |
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 | WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp) |
virtual void | ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp) |
bool | ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num) |
void | AddSupportedReadExtension (const char *extension) |
void | AddSupportedWriteExtension (const char *extension) |
void | SetSupportedReadExtensions (const ArrayOfExtensionsType &) |
void | SetSupportedWriteExtensions (const ArrayOfExtensionsType &) |
virtual unsigned int | GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const |
virtual ImageIORegion | GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const |
Protected Member Functions inherited from itk::LightProcessObject | |
LightProcessObject () | |
~LightProcessObject () override | |
virtual void | GenerateData () |
Protected Member Functions inherited from itk::Object | |
Object () | |
~Object () override | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
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 () |
Protected Attributes inherited from itk::ImageIOBase | |
IOPixelEnum | m_PixelType { IOPixelEnum::SCALAR } |
IOComponentEnum | m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE } |
IOByteOrderEnum | m_ByteOrder { IOByteOrderEnum::OrderNotApplicable } |
IOFileEnum | m_FileType { IOFileEnum::TypeNotApplicable } |
bool | m_Initialized |
std::string | m_FileName |
unsigned int | m_NumberOfComponents |
unsigned int | m_NumberOfDimensions { 0 } |
bool | m_UseCompression { false } |
int | m_CompressionLevel { 30 } |
int | m_MaximumCompressionLevel { 100 } |
std::string | m_Compressor { "uninitialized" } |
bool | m_UseStreamedReading |
bool | m_UseStreamedWriting |
bool | m_ExpandRGBPalette |
bool | m_IsReadAsScalarPlusPalette |
bool | m_WritePalette |
ImageIORegion | m_IORegion |
std::vector< SizeValueType > | m_Dimensions |
std::vector< double > | m_Spacing |
std::vector< double > | m_Origin |
std::vector< std::vector< double > > | m_Direction |
std::vector< SizeType > | m_Strides |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount |
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 49 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType = ByteSwapper<ComponentType> |
Helper class to swap bytes when necessary
Definition at line 76 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::ComponentType = typename PixelTraits<PixelType>::ValueType |
this type is used in case the pixel has several components
Definition at line 73 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::PixelType = TPixel |
Pixel type alias support Used to declare pixel type in filters or other operations.
Definition at line 67 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::Pointer = SmartPointer<Self> |
Definition at line 57 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::Self = RawImageIO |
Standard class type aliases.
Definition at line 55 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::SizeValueType = Superclass::SizeValueType |
Type used for counting elements.
Definition at line 70 of file itkRawImageIO.h.
using itk::RawImageIO< TPixel, VImageDimension >::Superclass = ImageIOBase |
Definition at line 56 of file itkRawImageIO.h.
|
protected |
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".
|
overrideprotecteddefault |
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".
|
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 110 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.
|
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.
|
overrideprotectedvirtual |
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".
Reimplemented from itk::ImageIOBase.
|
overridevirtual |
Reads the data from disk into the memory buffer provided.
Implements itk::ImageIOBase.
|
inlinevirtual |
Read a file's header to determine image dimensions, etc.
Definition at line 143 of file itkRawImageIO.h.
|
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 118 of file itkRawImageIO.h.
|
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 |
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".
Definition at line 130 of file itkRawImageIO.h.
|
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 99 of file itkRawImageIO.h.
|
overridevirtual |
Writes the data to disk from the memory buffer provided.
Implements itk::ImageIOBase.
|
inlineoverridevirtual |
Binary files have no image information to read.
Implements itk::ImageIOBase.
Definition at line 156 of file itkRawImageIO.h.
|
private |
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".
Definition at line 176 of file itkRawImageIO.h.
|
private |
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".
Definition at line 178 of file itkRawImageIO.h.
|
private |
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".
Definition at line 179 of file itkRawImageIO.h.
|
private |
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".
Definition at line 174 of file itkRawImageIO.h.
|
private |
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".
Definition at line 177 of file itkRawImageIO.h.