ITK
5.2.0
Insight Toolkit
|
#include <itkMetaImageIO.h>
Public Member Functions | |
bool | CanReadFile (const char *) override |
bool | CanWriteFile (const char *) override |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
ImageIORegion | GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requestedRegion) const override |
unsigned int | GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) override |
MetaImage * | GetMetaImagePointer () |
virtual const char * | GetNameOfClass () const |
ImageIORegion | GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) override |
void | Read (void *buffer) override |
void | ReadImageInformation () override |
virtual void | SetDataFileName (const char *filename) |
virtual void | SetDoublePrecision (unsigned int precision) |
bool | SupportsDimension (unsigned long) override |
void | Write (const void *buffer) override |
void | WriteImageInformation () override |
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 |
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 () |
MetaImage | m_MetaImage |
unsigned int | m_SubSamplingFactor |
static unsigned int * | m_DefaultDoublePrecision |
static void | SetDefaultDoublePrecision (unsigned int precision) |
static unsigned int | GetDefaultDoublePrecision () |
bool | CanStreamRead () override |
bool | CanStreamWrite () override |
virtual void | SetSubSamplingFactor (unsigned int _arg) |
virtual unsigned int | GetSubSamplingFactor () const |
MetaImageIO () | |
~MetaImageIO () override | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
template<unsigned int VNRows, unsigned int VNColumns = VNRows> | |
bool | WriteMatrixInMetaData (std::ostringstream &strs, const MetaDataDictionary &metaDict, const std::string &metaString) |
itkGetGlobalDeclarationMacro (unsigned int, DefaultDoublePrecision) | |
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 MetaImage file format.
For a detailed description of using this format, please see https://www.itk.org/Wiki/ITK/MetaIO/Documentation
Definition at line 43 of file itkMetaImageIO.h.
using itk::MetaImageIO::Pointer = SmartPointer<Self> |
Definition at line 51 of file itkMetaImageIO.h.
using itk::MetaImageIO::Self = MetaImageIO |
Standard class type aliases.
Definition at line 49 of file itkMetaImageIO.h.
Definition at line 50 of file itkMetaImageIO.h.
|
protected |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
|
overrideprotected |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
|
overridevirtual |
Determine the file type. Returns true if this ImageIO can read the file specified.
Implements itk::ImageIOBase.
|
inlineoverridevirtual |
Determine if the ImageIO can stream reading from this file. Only time cannot stream read/write is if compression is used. CanRead must be called prior to this function.
Reimplemented from itk::ImageIOBase.
Definition at line 140 of file itkMetaImageIO.h.
|
inlineoverridevirtual |
Determine if the ImageIO can stream writing to this file. Only time cannot stream read/write is if compression is used. Assumes file passes a CanRead call and its pixels are of the same type as the template of the writer. Can verify by first calling CanRead and then CanStreamRead prior to calling CanStreamWrite.
Reimplemented from itk::ImageIOBase.
Definition at line 156 of file itkMetaImageIO.h.
|
overridevirtual |
Determine the file type. Returns true if this ImageIO can write the file specified.
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.
|
overridevirtual |
Method for supporting streaming. Given a requested region, calculate what could be the region that we can read from the file. This is called the streamable region, which will be smaller than the LargestPossibleRegion and greater or equal to the RequestedRegion
Reimplemented from itk::ImageIOBase.
|
overridevirtual |
Before this method is called all the configuration will be done, that is Streaming/PasteRegion/Compression/Filename etc If pasting is being used the number of requested splits is for that region not the largest. The derived ImageIO class should verify that the file is capable of being written with this configuration. If pasted is enabled and is not support or does not work with the file, then an exception should be thrown.
The default implementation depends on CanStreamWrite. If false then 1 is returned (unless pasting is indicated), so that the whole file will be updated in one region. If true then its assumed that any arbitrary region can be written to any file. So the users request will be respected. If a derived class has more restrictive conditions then they should be checked
Reimplemented from itk::ImageIOBase.
|
static |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
MetaImage* itk::MetaImageIO::GetMetaImagePointer | ( | ) |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageIOBase.
|
overridevirtual |
returns the ith IORegion
numberOfActualSplits should be the value returned from GetActualNumberOfSplitsForWriting with the same parameters
Derieved classes should overload this method to return a compatible region
Reimplemented from itk::ImageIOBase.
|
virtual |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
|
private |
Only used to synchronize the global variable across static libraries.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
Reimplemented from itk::ImageIOBase.
|
overridevirtual |
Reads the data from disk into the memory buffer provided.
Implements itk::ImageIOBase.
|
overridevirtual |
Set the spacing and dimension information for the set filename.
Implements itk::ImageIOBase.
|
virtual |
Set the filename for the Data file. Setting this will make the Writer to use the non-Local mode and save header and data in independent files
|
static |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
|
inlinevirtual |
set the precision in the MetaImage member
Definition at line 113 of file itkMetaImageIO.h.
|
virtual |
Determing the subsampling factor in case we want a coarse version of the image/
|
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 65 of file itkMetaImageIO.h.
|
overridevirtual |
Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly.
Implements itk::ImageIOBase.
|
overridevirtual |
Set the spacing and dimension information for the set filename.
Implements itk::ImageIOBase.
|
protected |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
Definition at line 211 of file itkMetaImageIO.h.
References itk::ExposeMetaData().
|
staticprivate |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
Definition at line 206 of file itkMetaImageIO.h.
|
private |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
Definition at line 202 of file itkMetaImageIO.h.
|
private |
Set the default precision when writing out the MetaImage header. MetaImage header contains values stored in memory as double, use this precision when writing out the value. The precision should only be defined in the range [0, 17] since a value of 17 will make the conversion of a double floating-point to text and back exact. This function is not thread safe. Default value after static initialization is 17.
Definition at line 204 of file itkMetaImageIO.h.