volcart::WriteImageSequenceNode Class Reference

Write a sequence of images to disk. More...

#include <vc/graph/core.hpp>

Inheritance diagram for volcart::WriteImageSequenceNode:

Collaboration diagram for volcart::WriteImageSequenceNode:

Public Member Functions
	WriteImageSequenceNode ()
void	eagerWrite (std::size_t idx, std::size_t count, const cv::Mat &image) const
	Write a single image from the sequence when in eager mode. More...

Public Attributes
smgl::InputPort< filesystem::path >	path
	Output file. More...
smgl::InputPort< ImageSequence >	images
	Output image sequence. More...
smgl::InputPort< WriteImageOpts >	options
	Image writer options. More...
smgl::InputPort< bool >	eagerMode
	Enable or disable eager write mode. More...
smgl::InputPort< bool >	cacheArgs
	Include the saved file in the graph cache. More...

Private Types
using	ImageSequence = std::vector< cv::Mat >

Private Member Functions
auto	serialize_ (bool useCache, const filesystem::path &cacheDir) -> smgl::Metadata override
void	deserialize_ (const smgl::Metadata &meta, const filesystem::path &) override

Private Attributes
filesystem::path	path_ {}
ImageSequence	images_
WriteImageOpts	opts_
bool	eagerMode_ {false}
bool	cacheArgs_ {false}

Detailed Description

Write a sequence of images to disk.

See also

WriteImageSequence()

Definition at line 580 of file core.hpp.

Member Typedef Documentation

ImageSequence

using volcart::WriteImageSequenceNode::ImageSequence = std::vector<cv::Mat>

private

Image sequence type

Definition at line 584 of file core.hpp.

Constructor & Destructor Documentation

WriteImageSequenceNode()

volcart::WriteImageSequenceNode::WriteImageSequenceNode

(

)

Constructor

Member Function Documentation

deserialize_()

void volcart::WriteImageSequenceNode::deserialize_ ( const smgl::Metadata &  meta, const filesystem::path &    )

overrideprivate

smgl custom deserialization

eagerWrite()

void volcart::WriteImageSequenceNode::eagerWrite	(	std::size_t	idx,
		std::size_t	count,
		const cv::Mat &	image
	)		const

Write a single image from the sequence when in eager mode.

This method is intended to be called from a signal handler (e.g., LayerTextureNode::imageComplete) to write one layer image at a time as it is produced. Has no effect when eager mode is disabled.

Parameters

idx	Zero-based index of this image within the sequence
count	Total number of images in the sequence (used for padding)
image	The image to write

serialize_()

auto volcart::WriteImageSequenceNode::serialize_ ( bool  useCache, const filesystem::path &  cacheDir  ) -> smgl::Metadata

overrideprivate

smgl custom serialization

Member Data Documentation

cacheArgs

smgl::InputPort<bool> volcart::WriteImageSequenceNode::cacheArgs

Include the saved file in the graph cache.

Definition at line 613 of file core.hpp.

cacheArgs_

bool volcart::WriteImageSequenceNode::cacheArgs_ {false}

private

Include the saved file in the graph cache

Definition at line 594 of file core.hpp.

eagerMode

smgl::InputPort<bool> volcart::WriteImageSequenceNode::eagerMode

Enable or disable eager write mode.

When enabled, the node skips writing the full sequence during its normal compute step. Instead, individual images are written incrementally via eagerWrite() as they become available (e.g., when connected to LayerTextureNode's imageComplete signal).

Definition at line 611 of file core.hpp.

eagerMode_

bool volcart::WriteImageSequenceNode::eagerMode_ {false}

private

Eager mode

Definition at line 592 of file core.hpp.

images

smgl::InputPort<ImageSequence> volcart::WriteImageSequenceNode::images

Output image sequence.

Definition at line 600 of file core.hpp.

images_

ImageSequence volcart::WriteImageSequenceNode::images_

private

Image sequence

Definition at line 588 of file core.hpp.

options

smgl::InputPort<WriteImageOpts> volcart::WriteImageSequenceNode::options

Image writer options.

Definition at line 602 of file core.hpp.

opts_

WriteImageOpts volcart::WriteImageSequenceNode::opts_

private

Image writer options

Definition at line 590 of file core.hpp.

path

smgl::InputPort<filesystem::path> volcart::WriteImageSequenceNode::path

Output file.

Definition at line 598 of file core.hpp.

path_

filesystem::path volcart::WriteImageSequenceNode::path_ {}

private

File path

Definition at line 586 of file core.hpp.

---

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

• vc/graph/core.hpp