reg23::Texture3DCPU Class Reference

A 3D texture stored for access by the CPU. More...

#include <Texture3DCPU.h>

Inheritance diagram for reg23::Texture3DCPU:

Public Types
using	Base = Texture< 3, int64_t, double >
Public Types inherited from reg23::Texture< 3, int64_t, double >
using	IntType = int64_t
using	FloatType = double
using	SizeType = Vec< int64_t, dimensionality >
using	VectorType = Vec< double, dimensionality >
using	AddressModeType = Vec< TextureAddressMode, dimensionality >

Public Member Functions
	Texture3DCPU ()=default
	Texture3DCPU (const float *_ptr, SizeType _size, VectorType _spacing=VectorType::Full(1.), VectorType _centrePosition=VectorType::Full(0), AddressModeType _addressModes=AddressModeType::Full(TextureAddressMode::ZERO))
	Texture3DCPU (const Texture3DCPU &)=default
Texture3DCPU &	operator= (const Texture3DCPU &)=default
	Texture3DCPU (Texture3DCPU &&)=default
Texture3DCPU &	operator= (Texture3DCPU &&)=default
__host__ __device__ float	At (const SizeType &index) const
__host__ __device__ float	Sample (VectorType texCoord) const
__host__ __device__ float	DSampleDX (VectorType texCoord) const
__host__ __device__ float	DSampleDY (VectorType texCoord) const
__host__ __device__ float	DSampleDZ (VectorType texCoord) const
__host__ __device__ VectorType	DSampleDTexCoord (VectorType texCoord) const
Public Member Functions inherited from reg23::Texture< 3, int64_t, double >
__host__ __device__ const SizeType &	Size () const
__host__ __device__ const VectorType &	Spacing () const
	Get the spacing of the texture's values in world coordinates as (X, Y, Z)
__host__ __device__ const VectorType &	CentrePosition () const
	Get the position of the centre of the texture in world coordinates as (X, Y, Z)
__host__ __device__ VectorType	SizeWorld () const
__host__ __device__ bool	In (const SizeType &index) const
__host__ __device__ Linear< VectorType >	MappingWorldToTexCoord () const

Static Public Member Functions
static Texture3DCPU	FromTensor (const at::Tensor &volume, VectorType spacing, VectorType centrePosition=VectorType::Full(0), AddressModeType addressModes=AddressModeType::Full(TextureAddressMode::ZERO))

Additional Inherited Members
Static Public Attributes inherited from reg23::Texture< 3, int64_t, double >
static constexpr std::size_t	DIMENSIONALITY
Protected Member Functions inherited from reg23::Texture< 3, int64_t, double >
	Texture ()=default
	Texture (SizeType _size, VectorType _spacing, VectorType _centrePosition={})
	Texture (const Texture &)=default
	Texture (Texture &&) noexcept=default
Texture &	operator= (const Texture &)=default
Texture &	operator= (Texture &&) noexcept=default

Detailed Description

A 3D texture stored for access by the CPU.

This object does not own the data it provides access to, it just holds a pointer to it

Both copy and move-constructable.

Member Typedef Documentation

Base

using reg23::Texture3DCPU::Base = Texture<3, int64_t, double>

Constructor & Destructor Documentation

Texture3DCPU() [1/4]

reg23::Texture3DCPU::Texture3DCPU ( )

default

Texture3DCPU() [2/4]

reg23::Texture3DCPU::Texture3DCPU ( const float *  _ptr, SizeType  _size, VectorType  _spacing = VectorType::Full(1.), VectorType  _centrePosition = VectorType::Full(0), AddressModeType  _addressModes = AddressModeType::Full(TextureAddressMode::ZERO)  )

inline

Texture3DCPU() [3/4]

reg23::Texture3DCPU::Texture3DCPU ( const Texture3DCPU &  )

default

Texture3DCPU() [4/4]

reg23::Texture3DCPU::Texture3DCPU ( Texture3DCPU &&  )

default

Member Function Documentation

At()

__host__ __device__ float reg23::Texture3DCPU::At ( const SizeType &  index ) const

inline

Parameters

index

The location in the texture at which to fetch the value

Returns

The value in this texture at the given location, according to the texture's address mode

DSampleDTexCoord()

__host__ __device__ VectorType reg23::Texture3DCPU::DSampleDTexCoord ( VectorType  texCoord ) const

inline

Parameters

texCoord

The texture coordinates at which to sample the texture

Returns

The derivative of the sample from this texture at the given texture coordinates using trilinear interpolation, with respect to the texture coordinate.

DSampleDX()

__host__ __device__ float reg23::Texture3DCPU::DSampleDX ( VectorType  texCoord ) const

inline

Parameters

texCoord

The texture coordinates at which to sample the texture

Returns

The derivative of the sample from this texture at the given texture coordinates using trilinear interpolation, with respect to the X-component of the texture coordinate.

DSampleDY()

__host__ __device__ float reg23::Texture3DCPU::DSampleDY ( VectorType  texCoord ) const

inline

Parameters

texCoord

The texture coordinates at which to sample the texture

Returns

The derivative of the sample from this texture at the given texture coordinates using trilinear interpolation, with respect to the Y-component of the texture coordinate.

DSampleDZ()

__host__ __device__ float reg23::Texture3DCPU::DSampleDZ ( VectorType  texCoord ) const

inline

Parameters

texCoord

The texture coordinates at which to sample the texture

Returns

The derivative of the sample from this texture at the given texture coordinates using trilinear interpolation, with respect to the Z-component of the texture coordinate.

FromTensor()

static Texture3DCPU reg23::Texture3DCPU::FromTensor ( const at::Tensor &  volume, VectorType  spacing, VectorType  centrePosition = VectorType::Full(0), AddressModeType  addressModes = AddressModeType::Full(TextureAddressMode::ZERO)  )

inlinestatic

Parameters

volume	A 3D tensor of torch.float32s
spacing	A tensor of torch.float64s of size (3,)
centrePosition
addressModes

Returns

An instance of this texture object that points to the data in the given image

operator=() [1/2]

Texture3DCPU & reg23::Texture3DCPU::operator= ( const Texture3DCPU &  )

default

operator=() [2/2]

Texture3DCPU & reg23::Texture3DCPU::operator= ( Texture3DCPU &&  )

default

Sample()

__host__ __device__ float reg23::Texture3DCPU::Sample ( VectorType  texCoord ) const

inline

Parameters

texCoord

The texture coordinates at which to sample the texture

Returns

The sample from this texture at the given texture coordinates using trilinear interpolation

---

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

• /home/runner/work/grangeat-2d-3d-register-pytorch/grangeat-2d-3d-register-pytorch/reg23/src/backend/include/reg23/Texture3DCPU.h