Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::signal::ModalSpec Struct Reference

A modal instrument, complete. More...

#include <modal_spec.hpp>

Public Member Functions

int contact_samples (double sample_rate) const
 Contact duration in samples at sample_rate, for fill_strike_pulse.

Public Attributes

int schema_version = kModalSpecSchemaVersion
std::string name
std::string description
std::vector< ModalMode > modes
ModalSpecExcitation excitation
ModalShapeMap strike_map
 Optional. When present, must hold grid_points weights per mode.
ModalShapeMap pickup_map
ModalSpecTolerances tolerances

Detailed Description

A modal instrument, complete.

Member Function Documentation

◆ contact_samples()

int pulp::signal::ModalSpec::contact_samples ( double sample_rate) const
inline

Contact duration in samples at sample_rate, for fill_strike_pulse.

Returns 0 for an impulse excitation, which callers render as a single unit sample rather than a pulse.

Member Data Documentation

◆ description

std::string pulp::signal::ModalSpec::description

◆ excitation

ModalSpecExcitation pulp::signal::ModalSpec::excitation

◆ modes

std::vector<ModalMode> pulp::signal::ModalSpec::modes

◆ name

std::string pulp::signal::ModalSpec::name

◆ pickup_map

ModalShapeMap pulp::signal::ModalSpec::pickup_map

◆ schema_version

int pulp::signal::ModalSpec::schema_version = kModalSpecSchemaVersion

◆ strike_map

ModalShapeMap pulp::signal::ModalSpec::strike_map

Optional. When present, must hold grid_points weights per mode.

◆ tolerances

ModalSpecTolerances pulp::signal::ModalSpec::tolerances

The documentation for this struct was generated from the following file:
  • /home/runner/work/pulp/pulp/core/signal/include/pulp/signal/modal_spec.hpp