Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
inviwo::DatVolumeSequenceReader Class Reference
Data Reader & Writers

Reader for *.dat files. More...

#include <datvolumesequencereader.h>

+ Inheritance diagram for inviwo::DatVolumeSequenceReader:

Public Member Functions

 DatVolumeSequenceReader (const DatVolumeSequenceReader &rhs)
 
DatVolumeSequenceReader & operator= (const DatVolumeSequenceReader &that)
 
virtual DatVolumeSequenceReader * clone () const override
 
virtual std::shared_ptr< VolumeSequence > readData (const std::filesystem::path &filePath) override
 
- Public Member Functions inherited from inviwo::DataReaderType< VolumeSequence >
 DataReaderType (const DataReaderType &rhs)=default
 
 DataReaderType (DataReaderType &&rhs) noexcept=default
 
DataReaderType & operator= (const DataReaderType &that)=default
 
DataReaderType & operator= (DataReaderType &&that) noexcept=default
 
virtual std::shared_ptr< VolumeSequence > readData (const std::filesystem::path &filePath, MetaDataOwner *)
 
- Public Member Functions inherited from inviwo::DataReader
 DataReader (const DataReader &rhs)=default
 
 DataReader (DataReader &&rhs) noexcept=default
 
DataReader & operator= (const DataReader &that)=default
 
DataReader & operator= (DataReader &&that) noexcept=default
 
const std::vector< FileExtension > & getExtensions () const
 
void addExtension (FileExtension ext)
 
virtual bool setOption (std::string_view key, std::any value)
 Set reader specific options See the documentation of the specific reader for the available options.
 
virtual std::any getOption (std::string_view key)
 Query the value of an reader specific option.
 

Additional Inherited Members

- Protected Member Functions inherited from inviwo::DataReader
void checkExists (const std::filesystem::path &path) const
 
std::ifstream open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::in) const
 
- Protected Attributes inherited from inviwo::DataReader
std::vector< FileExtension > extensions_
 

Detailed Description

Reader for *.dat files.

The following tags are supported:

  • RawFile The name of the raw data file, should be in the same directory (Mandatory).
  • Sequences Number of Volume in the raw file (Optional: default 1)
  • ByteOrder The byte order in the raw data file. (Optional, LittleEndian|BigEndian, default: LittleEndian).
  • ByteOffset Offset in to the raw file (Optional, default: 0)
  • DataOffset Offset in byte to where the data starts
  • Resolution | Dimension the size of the data grid: nx,ny,nz (Mandatory).
  • Format The type of values in the raw file. (Mandatory). The valid formats are: FLOAT16, FLOAT32, FLOAT64, INT8, INT16, INT32, INT64, UINT8, UINT16, UINT32, UINT64, Vec2FLOAT16, Vec2FLOAT32, Vec2FLOAT64, Vec2INT8, Vec2INT16, Vec2INT32, Vec2INT64, Vec2UINT8, Vec2UINT16, Vec2UINT32, Vec2UINT64, Vec3FLOAT16, Vec3FLOAT32, Vec3FLOAT64, Vec3INT8, Vec3INT16, Vec3INT32, Vec3INT64, Vec3UINT8, Vec3UINT16, Vec3UINT32, Vec3UINT64, Vec4FLOAT16, Vec4FLOAT32, Vec4FLOAT64, Vec4INT8, Vec4INT16, Vec4INT32, Vec4INT64, Vec4UINT8, Vec4UINT16, Vec4UINT32, Vec4UINT64
  • Spacing | SliceThickness The size of the voxels in the data. (Optional)
  • BasisVector(1|2|3) Defines a coordinate system for the data. (Optional, overrides spacing, default: 2*IdentityMatrix);
  • Offset Offsets the basis vectors in space. (Optional, defaults to center the data at the origin)
  • WorldVector(1|2|3|4) Defines a world transformation matrix that is applied last to orient the data in world space. (Optional, default: IdentityMatrix)
  • DatFile Relative path to other file to create a VolumeSequence from.
  • DataRange DataRange of volume (Optional, defaults to the min/max of the first volume)
  • ValueRange ValueRange of volume (Optional, defaults to the DataRange)
  • ValueName Name of Value domain (Optional, defaults to "")
  • ValueUnit Value Unit (Optional, defaults to Unit{})
  • SwizzleMask Data Channel swizzle mask
    See also
    SwizzleMask (Optional, defaults to rgba)
  • Interpolation Interpolation mode
    See also
    InterpolationType (Optional, defaults to Linear)
  • Wrapping Wrapping mode
    See also
    Wrapping3D (Optional defaults to clampAll
  • AxisNames Space separated axes names (Optional, defaults to "")
  • Axis(1|2|3)Name Axis name (Optional, defaults to "")
  • AxisUnits Space separated axes units (Optional, defaults to Unit{})
  • Axis(1|2|3)Unit Axis unit (Optional, defaults to Unit{})

The tag names are case insensitive and should always be followed by a ":" Anything after a '#' will be considered a comment.

Supports reading VolumeSequence (for example time-varying volume data) by specifying multiple .dat files.

Example:

  • Datfile: sequence0.dat
  • Datfile: sequence1.dat
  • Datfile: sequence2.dat

Member Function Documentation

◆ clone()

virtual DatVolumeSequenceReader * inviwo::DatVolumeSequenceReader::clone ( ) const
overridevirtual

Implements inviwo::DataReaderType< VolumeSequence >.

◆ readData()

virtual std::shared_ptr< VolumeSequence > inviwo::DatVolumeSequenceReader::readData ( const std::filesystem::path & filePath)
overridevirtual

Implements inviwo::DataReaderType< VolumeSequence >.

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