Struct Gaussian3dScene

pub struct Gaussian3dScene<B>
where
    B: Backend,
{
    pub colors_sh: Param<Tensor<B, 2>>,
    pub opacities: Param<Tensor<B, 2>>,
    pub positions: Param<Tensor<B, 2>>,
    pub rotations: Param<Tensor<B, 2>>,
    pub scalings: Param<Tensor<B, 2>>,
}

3DGS representation.

Fields

colors_sh: Param<Tensor<B, 2>>

Colors in SH space. (Inner value)

The shape is [P, M * 3], which derives from [P, M, 3].

• P is Self::point_count.
• M is SH_COUNT_MAX.

It is represented as orthonormalized spherical harmonic with RGB channels.

opacities: Param<Tensor<B, 2>>

Opacities. (Inner value)

The shape is [P, 1].

positions: Param<Tensor<B, 2>>

3D Positions. (Inner value)

The shape is [P, 3].

rotations: Param<Tensor<B, 2>>

Rotations. (Inner value)

The shape is [P, 4].

They are represented as Hamilton quaternions in scalar-last order, i.e., [x, y, z, w].

scalings: Param<Tensor<B, 2>>

3D scalings. (Inner value)

The shape is [P, 3].

Implementations

impl<B> Gaussian3dScene<B>

where B: Backend,

Scene exporters

pub fn encode_polygon(&self, writer: &mut impl Write) -> Result<(), Error>

Export the scene in the 3DGS PLY format.

pub fn to_points(&self) -> Vec<Point>

Export the scene as a point cloud.

impl<B> Gaussian3dScene<B>

where B: Backend,

Scene importers

pub fn decode_polygon( reader: &mut impl Read, device: &<B as Backend>::Device, ) -> Result<Gaussian3dScene<B>, Error>

Import the scene in the 3DGS PLY format.

pub fn from_points( points: Vec<Point>, device: &<B as Backend>::Device, ) -> Gaussian3dScene<B>

Import the scene from the point cloud.

impl<B> Gaussian3dScene<B>

where B: Backend,

Outer property value getters

pub fn get_colors_sh(&self) -> Tensor<B, 2>

Colors in SH space. (Outer value)

The shape is [P, M * 3], which derives from [P, M, 3].

• P is Self::point_count.
• M is SH_COUNT_MAX.

It is represented as orthonormalized spherical harmonic with RGB channels.

pub fn get_opacities(&self) -> Tensor<B, 2>

Opacities. (Outer value)

The shape is [P, 1].

They range from 0.0 to 1.0.

pub fn get_positions(&self) -> Tensor<B, 2>

3D Positions. (Outer value)

The shape is [P, 3].

pub fn get_rotations(&self) -> Tensor<B, 2>

Rotations. (Outer value)

The shape is [P, 4].

They are represented as normalized Hamilton quaternions in scalar-last order, i.e., [x, y, z, w].

pub fn get_scalings(&self) -> Tensor<B, 2>

3D scalings. (Outer value)

The shape is [P, 3].

impl<B> Gaussian3dScene<B>

where B: Backend,

Outer property value makers

pub fn make_colors_sh(colors_sh: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::get_colors_sh

pub fn make_opacities(opacities: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::get_opacities

pub fn make_positions(positions: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::get_positions

pub fn make_rotations(rotations: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::get_rotations

pub fn make_scalings(scalings: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::get_scalings

impl<B> Gaussian3dScene<B>

where B: Backend,

Outer property value setters

pub fn set_colors_sh( &mut self, colors_sh: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting values for Gaussian3dScene::get_colors_sh

pub fn set_opacities( &mut self, opacities: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting values for Gaussian3dScene::get_opacities

pub fn set_positions( &mut self, positions: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting values for Gaussian3dScene::get_positions

pub fn set_rotations( &mut self, rotations: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting values for Gaussian3dScene::get_rotations

pub fn set_scalings( &mut self, scalings: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting values for Gaussian3dScene::get_scalings

impl<B> Gaussian3dScene<B>

where B: Backend,

Inner property value makers

pub fn make_inner_colors_sh(colors_sh: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::colors_sh

pub fn make_inner_opacities(opacities: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::opacities

pub fn make_inner_positions(positions: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::positions

pub fn make_inner_rotations(rotations: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::rotations

pub fn make_inner_scalings(scalings: Tensor<B, 2>) -> Tensor<B, 2>

Making values for Gaussian3dScene::scalings

impl<B> Gaussian3dScene<B>

where B: Backend,

Inner property value setters

pub fn set_inner_colors_sh( &mut self, colors_sh: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting inner values for Gaussian3dScene::colors_sh

pub fn set_inner_opacities( &mut self, opacities: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting inner values for Gaussian3dScene::opacities

pub fn set_inner_positions( &mut self, positions: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting inner values for Gaussian3dScene::positions

pub fn set_inner_rotations( &mut self, rotations: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting inner values for Gaussian3dScene::rotations

pub fn set_inner_scalings( &mut self, scalings: Tensor<B, 2>, ) -> &mut Gaussian3dScene<B>

Setting inner values for Gaussian3dScene::scalings

impl<B> Gaussian3dScene<B>

where B: Backend,

Attribute getters

pub fn device(&self) -> <B as Backend>::Device

The device.

pub fn point_count(&self) -> usize

Number of points.

pub fn size(&self) -> usize

Size of the parameters in bytes.

pub fn size_readable(&self) -> String

Readable size of the parameters.

impl<B> Gaussian3dScene<B>

where B: Backend, Gaussian3dScene<B>: Gaussian3dRenderer<B>,

pub fn render( &self, view: &View, options: &Gaussian3dRenderOptions, ) -> Result<Gaussian3dRenderOutput<B>, Error>

Render the 3DGS scene.

It renders an image with the given view.

impl<B> Gaussian3dScene<Autodiff<B>>

where B: Backend, Gaussian3dScene<Autodiff<B>>: Gaussian3dRenderer<B>,

pub fn render( &self, view: &View, options: &Gaussian3dRenderOptions, ) -> Result<Gaussian3dRenderOutputAutodiff<Autodiff<B>>, Error>

Render the 3DGS scene with autodiff enabled.

It renders a learnable image with the given view.

Trait Implementations

impl<B> AutodiffModule<B> for Gaussian3dScene<B>

where B: Backend + AutodiffBackend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = Gaussian3dScene<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

fn valid(&self) -> <Gaussian3dScene<B> as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<B> Clone for Gaussian3dScene<B>

where B: Backend,

fn clone(&self) -> Gaussian3dScene<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Debug for Gaussian3dScene<B>

where B: Backend,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<B> Default for Gaussian3dScene<B>

where B: Backend,

fn default() -> Gaussian3dScene<B>

Returns the “default value” for a type.

impl<B> Display for Gaussian3dScene<B>

where B: Backend,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<R, F, I, B> Gaussian3dRenderer<JitBackend<R, F, I, B>> for Gaussian3dScene<Autodiff<JitBackend<R, F, I, B>>>

where R: JitRuntime, F: FloatElement, I: IntElement, B: BoolElement,

fn render_forward( input: RenderInput<JitBackend<R, F, I, B>>, view: &View, options: &Gaussian3dRenderOptions, ) -> Result<RenderOutput<JitBackend<R, F, I, B>>, Error>

Render the 3DGS scene (forward).

fn render_backward( state: RenderInput<JitBackend<R, F, I, B>>, colors_rgb_2d_grad: <JitBackend<R, F, I, B> as Backend>::FloatTensorPrimitive, ) -> RenderOutput<JitBackend<R, F, I, B>>

Render the 3DGS scene (backward).

impl<R, F, I, B> Gaussian3dRenderer<JitBackend<R, F, I, B>> for Gaussian3dScene<JitBackend<R, F, I, B>>

where R: JitRuntime, F: FloatElement, I: IntElement, B: BoolElement,

fn render_forward( input: RenderInput<JitBackend<R, F, I, B>>, view: &View, options: &Gaussian3dRenderOptions, ) -> Result<RenderOutput<JitBackend<R, F, I, B>>, Error>

Render the 3DGS scene (forward).

fn render_backward( state: RenderInput<JitBackend<R, F, I, B>>, colors_rgb_2d_grad: <JitBackend<R, F, I, B> as Backend>::FloatTensorPrimitive, ) -> RenderOutput<JitBackend<R, F, I, B>>

Render the 3DGS scene (backward).

impl<B> Module<B> for Gaussian3dScene<B>

where B: Backend,

type Record = Gaussian3dSceneRecord<B>

Type to save and load the module.

fn load_record( self, record: <Gaussian3dScene<B> as Module<B>>::Record, ) -> Gaussian3dScene<B>

Load the module state from a record.

fn into_record(self) -> <Gaussian3dScene<B> as Module<B>>::Record

Convert the module into a record containing the state.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn visit<Visitor>(&self, visitor: &mut Visitor)

where Visitor: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<Mapper>(self, mapper: &mut Mapper) -> Gaussian3dScene<B>

where Mapper: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn to_device(self, device: &<B as Backend>::Device) -> Gaussian3dScene<B>

Move the module and all of its sub-modules to the given device.

fn fork(self, device: &<B as Backend>::Device) -> Gaussian3dScene<B>

Fork the module and all of its sub-modules to the given device.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self

where C: Calibration,

Quantize the weights of the module.

impl<B> ModuleDisplay for Gaussian3dScene<B>

where B: Backend,

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module.

impl<B> ModuleDisplayDefault for Gaussian3dScene<B>

where B: Backend,

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.