Aleph::CA::Frame_Stream_Options Struct Reference

Options for directory-backed frame streams. More...

#include <ca-frame-stream.H>

Collaboration diagram for Aleph::CA::Frame_Stream_Options:

Public Attributes
std::filesystem::path	directory = "ca_frames"
	destination directory
std::string	prefix = "frame"
	filename prefix
Frame_Output_Format	format = Frame_Output_Format::PPM
	exporter format
std::size_t	stride = 1
	write every Nth step
std::size_t	zero_pad = 6
	step field width in filenames
bool	write_manifest = true
	write manifest.csv
RLE_Write_Options	rle_options {}
	RLE options when format is RLE.
CSV_Options	csv_options {}
	CSV options when format is CSV.
JSON_Write_Options	json_options {}
	JSON options when format is JSON.
Rect_Tikz_Options	tikz_options {}
	TikZ options when format is TikZ.
NetPBM_Write_Options	netpbm_options {}
	PGM/PPM options.

Detailed Description

Options for directory-backed frame streams.

stride controls sampling: stride == 1 writes every accepted frame, stride == 10 writes steps 0, 10, 20, ...

Definition at line 106 of file ca-frame-stream.H.

Member Data Documentation

csv_options

CSV_Options Aleph::CA::Frame_Stream_Options::csv_options {}

CSV options when format is CSV.

Definition at line 115 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::write_one().

directory

std::filesystem::path Aleph::CA::Frame_Stream_Options::directory = "ca_frames"

destination directory

Definition at line 108 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::Directory_Frame_Sink(), Aleph::CA::Directory_Frame_Sink::flush(), Aleph::CA::Directory_Frame_Sink::frame_path(), main(), Aleph::CA::Directory_Frame_Sink::montage_command_hint(), TEST(), TEST(), and TEST().

format

Frame_Output_Format Aleph::CA::Frame_Stream_Options::format = Frame_Output_Format::PPM

exporter format

Definition at line 110 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::flush(), Aleph::CA::Directory_Frame_Sink::frame_path(), Aleph::CA::Directory_Frame_Sink::montage_command_hint(), and Aleph::CA::Directory_Frame_Sink::write_one().

json_options

JSON_Write_Options Aleph::CA::Frame_Stream_Options::json_options {}

JSON options when format is JSON.

Definition at line 116 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::write_one().

netpbm_options

NetPBM_Write_Options Aleph::CA::Frame_Stream_Options::netpbm_options {}

PGM/PPM options.

Definition at line 118 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::write_one().

prefix

std::string Aleph::CA::Frame_Stream_Options::prefix = "frame"

filename prefix

Definition at line 109 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::frame_path(), and Aleph::CA::Directory_Frame_Sink::montage_command_hint().

rle_options

RLE_Write_Options Aleph::CA::Frame_Stream_Options::rle_options {}

RLE options when format is RLE.

Definition at line 114 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::write_one().

stride

std::size_t Aleph::CA::Frame_Stream_Options::stride = 1

write every Nth step

Definition at line 111 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::Directory_Frame_Sink(), and Aleph::CA::Directory_Frame_Sink::accept().

tikz_options

Rect_Tikz_Options Aleph::CA::Frame_Stream_Options::tikz_options {}

TikZ options when format is TikZ.

Definition at line 117 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::write_one().

write_manifest

bool Aleph::CA::Frame_Stream_Options::write_manifest = true

write manifest.csv

Definition at line 113 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::flush().

zero_pad

std::size_t Aleph::CA::Frame_Stream_Options::zero_pad = 6

step field width in filenames

Definition at line 112 of file ca-frame-stream.H.

Referenced by Aleph::CA::Directory_Frame_Sink::frame_path(), and Aleph::CA::Directory_Frame_Sink::montage_command_hint().

---

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

• ca-frame-stream.H