Developer documentation
Version 3.0.3-105-gd3941f44
MR::Fixel::Legacy::Image< DataType > Class Template Reference

#include "fixel/legacy/image.h"

Inheritance diagram for MR::Fixel::Legacy::Image< DataType >:
MR::Image< uint64_t >

Protected Member Functions

void check ()
 

Protected Attributes

ImageIO::SparseLegacyio
 
- Protected Attributes inherited from MR::Image< uint64_t >
void * data_pointer
 pointer to data address whether in RAM or MMap More...
 
vector< ssize_t > x
 voxel indices More...
 
Stride::List strides
 voxel indices More...
 
size_t data_offset
 offset to currently pointed-to voxel More...
 

Additional Inherited Members

- Public Types inherited from MR::Image< uint64_t >
using value_type = uint64_t
 
- Public Member Functions inherited from MR::Image< uint64_t >
void * operator new (std::size_t size)
 
void * operator new[] (std::size_t size)
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 
 Image ()
 
 Image (const Image &)=default
 
 Image (Image &&)=default
 
 Image (const std::shared_ptr< Buffer > &, const Stride::List &=Stride::List())
 used internally to instantiate Image objects More...
 
Imageoperator= (const Image &image)=default
 
Imageoperator= (Image &&)=default
 
 ~Image ()
 
bool valid () const
 
bool operator! () const
 
const KeyValueskeyval () const
 get generic key/value text attributes More...
 
const std::string & name () const
 
const transform_typetransform () const
 
size_t ndim () const
 
ssize_t size (size_t axis) const
 
default_type spacing (size_t axis) const
 
ssize_t stride (size_t axis) const
 
size_t offset () const
 offset to current voxel from start of data More...
 
void reset ()
 reset index to zero (origin) More...
 
ssize_t get_index (size_t axis) const
 get position of current voxel location along axis More...
 
void move_index (size_t axis, ssize_t increment)
 move position of current voxel location along axis More...
 
bool is_direct_io () const
 
uint64_t get_value () const
 get voxel value at current location More...
 
void set_value (uint64_t val)
 set voxel value at current location More...
 
std::string dump_to_mrtrix_file (std::string filename, bool use_multi_threading=true) const
 write out the contents of a direct IO image to file More...
 
Image with_direct_io (Stride::List with_strides=Stride::List())
 return a new Image using direct IO More...
 
Image with_direct_io (int axis)
 return a new Image using direct IO More...
 
uint64_t * address () const
 return RAM address of current voxel More...
 
- Static Public Member Functions inherited from MR::Image< uint64_t >
static Image open (const std::string &image_name, bool read_write_if_existing=false)
 
static Image create (const std::string &image_name, const Header &template_header, bool add_to_command_history=true)
 
static Image scratch (const Header &template_header, const std::string &label="scratch image")
 
- Public Attributes inherited from MR::Image< uint64_t >
std::shared_ptr< Buffer > buffer
 shared reference to header/buffer More...
 

Detailed Description

template<typename DataType>
class MR::Fixel::Legacy::Image< DataType >

Definition at line 99 of file image.h.

Member Function Documentation

◆ check()

template<typename DataType >
void MR::Fixel::Legacy::Image< DataType >::check ( )
inlineprotected

Definition at line 122 of file image.h.

Member Data Documentation

◆ io

template<typename DataType >
ImageIO::SparseLegacy* MR::Fixel::Legacy::Image< DataType >::io
protected

Definition at line 120 of file image.h.


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