camcom 1.0.0-pre2
 
Loading...
Searching...
No Matches
camcom::common::FrameGenerator Class Reference

Generates synthetic image frames for simulated cameras. More...

#include <frameGenerator.hpp>

Classes

struct  Impl
 

Public Member Functions

 FrameGenerator ()
 
 ~FrameGenerator ()
 
 FrameGenerator (const FrameGenerator &)=delete
 
FrameGeneratoroperator= (const FrameGenerator &)=delete
 
 FrameGenerator (FrameGenerator &&) noexcept
 
FrameGeneratoroperator= (FrameGenerator &&) noexcept
 
void configure (const PatternConfig &config)
 Configure the generator with pattern parameters.
 
void generate (int32_t n_frames, std::vector< uint8_t > &output)
 Generate a batch of frames into the output buffer.
 
int32_t outputWidth () const
 Output width after binning.
 
int32_t outputHeight () const
 Output height after binning.
 
size_t bytesPerFrame () const
 Bytes per single frame.
 
size_t bytesPerPixel () const
 Bytes per pixel for the configured output type.
 

Detailed Description

Generates synthetic image frames for simulated cameras.

Supports multiple pattern types (Gaussian stars, grids, gradients, etc.), multi-data-type output, binning, exposure/gain scaling, and per-frame drift.

Usage: FrameGenerator gen; gen.configure(config); std::vector<uint8_t> buffer; gen.generate(10, buffer); // generate 10 frames

Constructor & Destructor Documentation

◆ FrameGenerator() [1/3]

camcom::common::FrameGenerator::FrameGenerator ( )

◆ ~FrameGenerator()

camcom::common::FrameGenerator::~FrameGenerator ( )
default

◆ FrameGenerator() [2/3]

camcom::common::FrameGenerator::FrameGenerator ( const FrameGenerator & )
delete

◆ FrameGenerator() [3/3]

camcom::common::FrameGenerator::FrameGenerator ( FrameGenerator && )
defaultnoexcept

Member Function Documentation

◆ bytesPerFrame()

size_t camcom::common::FrameGenerator::bytesPerFrame ( ) const

Bytes per single frame.

◆ bytesPerPixel()

size_t camcom::common::FrameGenerator::bytesPerPixel ( ) const

Bytes per pixel for the configured output type.

◆ configure()

void camcom::common::FrameGenerator::configure ( const PatternConfig & config)

Configure the generator with pattern parameters.

Parameters
configPattern configuration

◆ generate()

void camcom::common::FrameGenerator::generate ( int32_t n_frames,
std::vector< uint8_t > & output )

Generate a batch of frames into the output buffer.

The buffer is resized to hold exactly n_frames frames. Frames are laid out contiguously: frame0 | frame1 | ... | frameN-1 Each frame is outputWidth() * outputHeight() * bytesPerPixel() bytes.

Parameters
n_framesNumber of frames to generate
outputOutput buffer (resized internally)

◆ operator=() [1/2]

FrameGenerator & camcom::common::FrameGenerator::operator= ( const FrameGenerator & )
delete

◆ operator=() [2/2]

FrameGenerator & camcom::common::FrameGenerator::operator= ( FrameGenerator && )
defaultnoexcept

◆ outputHeight()

int32_t camcom::common::FrameGenerator::outputHeight ( ) const

Output height after binning.

◆ outputWidth()

int32_t camcom::common::FrameGenerator::outputWidth ( ) const

Output width after binning.


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