MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Yantra::WindowedKernelAnalyzer< InputType, OutputType > Class Template Reference

Runs a caller's compute kernel once per window of every channel. More...

#include <WindowedKernelAnalyzer.hpp>

Inheritance diagram for MayaFlux::Yantra::WindowedKernelAnalyzer< InputType, OutputType >:
Collaboration diagram for MayaFlux::Yantra::WindowedKernelAnalyzer< InputType, OutputType >:

Public Types

using base_type = Analyzer<InputType, OutputType>
using input_type = Datum<InputType>
using output_type = Datum<OutputType>
using supports = Supports<WindowedKernelConfig>
Public Types inherited from MayaFlux::Yantra::Analyzer< InputType, OutputType >
using base_type = ComputeOperation<InputType, OutputType>
using input_type = Datum<InputType>
using output_type = Datum<OutputType>
Public Types inherited from MayaFlux::Yantra::ComputeOperation< InputType, OutputType >
using input_type = Datum<InputType>
using output_type = Datum<OutputType>

Public Member Functions

WindowedKernelAnalysis analyze_windows (const input_type &data)
 Type-safe windowed kernel analysis.
WindowedKernelAnalysis analyze_windows (const InputType &data)
ConfigRefs configs () const override
 The base view of the config structs this operation holds.
AnalysisType get_analysis_type () const override
 Gets the analysis type category for this analyzer.
std::string get_name () const override
 Get operation name for debugging/introspection.
WindowedKernelAnalysis get_windowed_kernel_analysis () const
 WindowedKernelAnalyzer (WindowedKernelConfig config)
 Construct from a kernel and its window settings.
Public Member Functions inherited from MayaFlux::Yantra::Analyzer< InputType, OutputType >
std::vector< std::any > analyze_batch (const std::vector< input_type > &inputs)
 Batch analysis for multiple inputs.
std::vector< std::any > analyze_batch (const std::vector< InputType > &inputs)
std::any analyze_data (const input_type &data)
 User-facing analysis method - returns analysis results directly.
std::any analyze_data (const InputType &data)
std::any get_current_analysis () const
 Access cached analysis from last operation.
OperationType get_operation_type () const override
 Returns the category of this operation for grammar and registry discovery.
bool has_current_analysis () const
 Check if analysis has been performed.
bool validate_input (const input_type &input) const override
 Validates input data meets analyzer requirements.
virtual ~Analyzer ()=default
Public Member Functions inherited from MayaFlux::Yantra::ComputeOperation< InputType, OutputType >
void add_dependency (std::shared_ptr< ComputeOperation > dep)
output_type apply_operation (const input_type &input)
 Public synchronous execution interface.
output_type apply_operation_with_dependencies (const input_type &input)
 Applies the operation with dependencies resolved.
OutputType apply_to_data (const InputType &data)
 Convenience overload that extracts just the data from result.
 ComputeOperation ()
 Constructor with data type validation warnings.
template<typename Config>
requires std::derived_from<Config, OperationConfig>
const Config & config () const
 The stored config struct of type Config, or its defaults when none was set.
output_type execute (const input_type &input)
 OpUnit interface - operations can act as units in dependency graphs.
const auto & get_dependencies () const
const ExecutionContext & get_last_execution_context () const
void merge_config (const Facets &incoming)
 Adds the config structs of incoming, replacing stored ones of the same type.
output_type operator() (const InputType &data)
 Convenience overload for direct data processing (backward compatibility).
template<typename Config>
requires std::derived_from<Config, OperationConfig>
const Config * resolved_config () const
 The stored config struct of type Config, or nullptr when absent.
template<typename Config>
requires std::derived_from<Config, OperationConfig>
void set_config (Config config)
 Stores a config struct, whole, under its own type.
void set_last_execution_context (const ExecutionContext &ctx)
void set_post_execution_hook (const OperationHookCallback &hook)
void set_pre_execution_hook (const OperationHookCallback &hook)
void set_reconstruction_callback (const ReconstructionCallback &callback)
template<typename... Configs>
ConfigRefs stored_configs (Supports< Configs... >) const
 The stored configs among those listed, in listed order.
virtual ~ComputeOperation ()=default
 Virtual destructor for proper cleanup of derived classes.

Static Public Member Functions

static float fitness (const input_type &)
 One while a device is up, zero otherwise.

Static Public Attributes

static constexpr Target target = targets::vulkan

Protected Member Functions

output_type analyze_implementation (const input_type &input) override
 Pure virtual analysis implementation - derived classes implement this.
Protected Member Functions inherited from MayaFlux::Yantra::Analyzer< InputType, OutputType >
virtual output_type apply_granularity_formatting (const output_type &raw_output)
 Output formatting by granularity (override for custom formatting).
output_type operation_function (const input_type &input) override
 Core analysis implementation - must be overridden by derived classes.
template<typename AnalysisResultType>
void store_current_analysis (AnalysisResultType &&result) const
virtual bool validate_analysis_input (const input_type &) const
 Input validation (override for custom validation logic).
Protected Member Functions inherited from MayaFlux::Yantra::ComputeOperation< InputType, OutputType >
output_type apply_hooks (const input_type &input, const ExecutionContext &context)
virtual std::future< output_type > apply_operation_async (const input_type &input)
 Optional async implementation - default delegates to operation_function.
virtual output_type apply_operation_chained (const input_type &input, const ExecutionContext &ctx)
 Optional chain-aware implementation - default delegates to operation_function.
virtual output_type apply_operation_internal (const input_type &input, const ExecutionContext &context)
 Internal execution method - ComputeMatrix can access this.
virtual output_type apply_operation_parallel (const input_type &input, const ExecutionContext &ctx)
 Optional parallel-aware implementation - default delegates to operation_function.
output_type convert_result (std::vector< std::vector< double > > &result_data, DataStructureInfo &metadata)
 Convert processed double data back to OutputType using metadata and optional callback.

Private Member Functions

void analyse (ShaderExecutionContext<> &context, ChannelWindowedKernel &result, std::span< const std::span< const double > > inputs, const WindowedKernelConfig &cfg) const
ShaderExecutionContext & context (const WindowedKernelConfig &cfg) const
void run_chunk (ShaderExecutionContext<> &context, ChannelWindowedKernel &out, std::span< const std::span< const double > > inputs, size_t first, size_t count, const WindowedKernelConfig &cfg) const

Static Private Member Functions

static void validate_config (const WindowedKernelConfig &cfg)

Private Attributes

std::unique_ptr< ShaderExecutionContext<> > m_context
GpuComputeConfig m_gpu
std::string m_key

Static Private Attributes

static constexpr size_t k_chunk_windows = 16384

Additional Inherited Members

Protected Attributes inherited from MayaFlux::Yantra::Analyzer< InputType, OutputType >
std::any m_current_analysis
std::optional< output_type > m_current_output
Protected Attributes inherited from MayaFlux::Yantra::ComputeOperation< InputType, OutputType >
ExecutionContext m_last_execution_context

Detailed Description

template<ComputeData InputType = std::vector<Kakshya::DataVariant>, ComputeData OutputType = Eigen::MatrixXd>
class MayaFlux::Yantra::WindowedKernelAnalyzer< InputType, OutputType >

Runs a caller's compute kernel once per window of every channel.

Where WaveformAnalyzer and SpectralAnalyzer are fixed measurements computed in double, this is the place for a measurement the library does not have. The kernel reads the window through sample_at and writes its results to the result array; see the layout described above windowed_kernel_workgroup for the names it sees. Samples are converted to float, the kernel runs in float32 as a fallback from double, and results are float, so they agree with a double reference only to float precision.

Nothing about the windows is specific to audio: a window is a run of consecutive values of any one-dimensional sequence. It is on the vulkan target, has no CPU twin, and is not registered with the default registry because it has no fixed selection to resolve by. A kernel that does not compile makes the analysis fail with the shader log's message.

Definition at line 401 of file WindowedKernelAnalyzer.hpp.


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