neat Namespace
Definition
Namespaces Index
| namespace | debug |
| namespace | dlpack |
|
Minimal DLPack-shaped structs for zero-copy interop with NumPy/PyTorch. More... | |
| namespace | error_codes |
| namespace | genai |
| namespace | graph |
| namespace | graphs |
| namespace | internal |
| namespace | nodes |
| namespace | pipeline_internal |
| namespace | runtime |
| namespace | stages |
| namespace | validators |
Classes Index
| struct | AudioSpec |
|
Audio-tensor metadata: sample rate, channel count, interleaving. More... | |
| struct | BoundaryFlowStats |
|
Per-boundary flow statistics — buffer counts at identity probes between Nodes. More... | |
| struct | Box |
|
One axis-aligned detection produced by BoxDecode. More... | |
| struct | BoxDecodeResult |
|
Parsed BoxDecode output paired with its raw byte buffer. More... | |
| struct | BuildAdaptationAction |
|
One line item from the build-adaptation log. More... | |
| struct | BuildAdaptationSummary |
|
Snapshot of build-time adaptation state — present for build(input) flows. More... | |
| struct | BusMessage |
|
A single GStreamer bus message captured during pipeline build/run. More... | |
| struct | ByteStreamSpec |
|
Opaque byte-stream tensor metadata. More... | |
| class | Cast |
|
CVU kernel Node that casts a tensor between FP32 and BF16 (no scale/zero-point). More... | |
| struct | CastOptions |
| class | CastTess |
|
Fused CVU kernel Node: Cast (FP32→BF16) followed by Tess. More... | |
| struct | CastTessOptions |
| struct | ColorConvertSpec |
|
Color-format conversion parameters. More... | |
| class | Contract |
|
A single validation rule applied to an ordered node list. More... | |
| struct | ContractFieldSpec |
|
Per-field contract: where the field value comes from and the override policy. More... | |
| struct | ContractPortSpec |
|
Per-port contract: the shape/type/segment requirements for one input or output. More... | |
| class | ContractRegistry |
|
Holds a set of Contracts and runs them to produce a ValidationReport. More... | |
| struct | ConversionCost |
|
Cost estimate for a conversion: bytes moved + a coarse compute-class bucket (low/med/high). More... | |
| struct | ConversionTrace |
|
Single audit-log entry for a conversion that occurred. More... | |
| struct | ConversionTraceCollector |
|
Collects ConversionTrace entries for post-mortem auditing of a pipeline run. More... | |
| class | Dequant |
|
CVU kernel Node that dequantizes INT8 tensors to FP32 using scale + zero-point. More... | |
| struct | DequantOptions |
| struct | DetectionSpec |
|
Detection-decoder metadata — tags tensors that carry packed detection output. More... | |
| class | Detess |
|
CVU kernel Node that detessellates MLA-layout tensors back to natural HWC/CHW order. More... | |
| class | DetessCast |
|
Fused CVU kernel Node: Detess followed by Cast (BF16→FP32). More... | |
| struct | DetessCastOptions |
|
Construction options for a DetessCast Node. More... | |
| class | DetessDequant |
|
Fused CVU kernel Node: Detess followed by Dequant (INT8→FP32). More... | |
| struct | DetessDequantOptions |
|
Construction options for a DetessDequant Node. More... | |
| struct | DetessOptions |
| struct | Device |
|
Device descriptor: type + numeric ID (for multi-device boards). More... | |
| struct | EncodedSpec |
|
Encoded-stream tensor metadata: which codec the bytes represent. More... | |
| class | FileInput |
|
Wraps GStreamer's filesrc element — reads encoded media from a path on disk. More... | |
| struct | FormatSpec |
|
Thin wrapper around FormatTag with implicit string conversions. More... | |
| class | Graph |
|
The assembly stage — turns a list of Nodes into a runnable, deterministic pipeline. More... | |
| struct | GraphOptions |
|
Per-Graph construction options. More... | |
| struct | GraphProcessCvuStageRequest |
| struct | GraphProcessMlaStageRequest |
| struct | GraphQuantContract |
| struct | GraphReport |
|
Structured pipeline diagnostics — the framework's primary triage record. More... | |
| struct | GraphTensorContract |
| class | H264CapsFixup |
|
Helper Node that fills in missing H.264 RTP caps fields with fallbacks. More... | |
| class | H264Decode |
|
Hardware-accelerated H.264 decoder Node. More... | |
| class | H264Depacketize |
|
Depayloads RTP-encapsulated H.264 into a raw H.264 byte stream. More... | |
| class | H264EncodeSima |
|
Hardware-accelerated H.264 encoder Node. More... | |
| class | H264Packetize |
|
RTP H.264 payloader Node — wraps encoded H.264 into RTP packets. More... | |
| class | H264Parse |
|
H.264 stream parser Node — parses NAL units, finds keyframes, optionally locks caps. More... | |
| struct | H264ParseOptions |
|
Construction options for an H264Parse Node — config-interval and optional caps lock. More... | |
| struct | I420Mapped |
|
Bundles an I420 view with the Mapping that keeps its underlying buffer alive. More... | |
| struct | I420View |
|
Non-owning view into I420 pixel data: separate Y, U, V planes. More... | |
| class | ImageDecode |
|
Auto-detects and decodes still-image formats (JPEG, PNG, BMP, …) to raw video. More... | |
| struct | ImageSpec |
|
Image-tensor metadata: pixel format and (optional) color space. More... | |
| class | Input |
|
Push-mode source Node. More... | |
| struct | InputDropInfo |
|
Diagnostic record for a dropped input frame. More... | |
| struct | InputOptions |
|
Caps, buffering, and pool options for the Input Node. More... | |
| struct | InputStreamStats |
|
Per-Run input-side telemetry: counts, drops, and timing averages. More... | |
| class | JpegDecode |
|
Decodes JPEG-encoded buffers to raw frames. More... | |
| class | LatencyProfiler |
|
Per-sample latency tracker; attach to a Run to capture timing telemetry. More... | |
| struct | LatencyProfilerOptions |
|
Construction options for LatencyProfiler. More... | |
| struct | LayoutConvertSpec |
|
Axis-permutation parameters for HWC↔CHW-style layout conversions. More... | |
| struct | Mapping |
|
Scoped read/write window into a TensorBuffer. More... | |
| struct | MeasureLatencyStats |
|
Percentile summary for a measured latency series. More... | |
| struct | MeasureOptions |
|
Options for framework-owned runtime measurement. More... | |
| struct | MeasurePluginLatency |
|
Aggregated per-plugin/kernel timing captured during a measurement window. More... | |
| struct | MeasureReport |
|
Framework-owned report returned by MeasureScope::stop(). More... | |
| class | MeasureScope |
|
Observation scope for measuring an application-owned push/pull interval. More... | |
| class | MetadataSender |
| struct | MetadataSenderOptions |
| class | Model |
|
Loaded form of a compiled model archive; the simplified entry point to run inference on Modalix. More... | |
| class | NeatError |
|
Framework exception type carrying a structured GraphReport. More... | |
| struct | NodeContractDefinition |
|
Bundle of port and field specs that fully describes a Node's contract. More... | |
| struct | NodeReport |
|
Per-Node entry in the report, listing what that Node produced in the GStreamer pipeline. More... | |
| struct | NormalizeSpec |
|
Mean/stddev normalization parameters. More... | |
| struct | Nv12Mapped |
|
Bundles an NV12 view with the Mapping that keeps its underlying buffer alive. More... | |
| struct | Nv12View |
|
Non-owning view into NV12 pixel data: Y plane + interleaved UV plane. More... | |
| class | Output |
|
Pull-side terminal sink. More... | |
| struct | OutputOptions |
| struct | OutputTensorOptions |
|
Options for Graph::add_output_tensor() — the tensor-friendly output helper. More... | |
| class | PCIeSink |
|
Terminal sink Node that streams samples to a PCIe-connected host. More... | |
| struct | PCIeSinkOptions |
| class | PCIeSrc |
|
Source-role Node that receives samples from a PCIe-connected host. More... | |
| struct | PCIeSrcOptions |
| struct | PcmAudio |
| struct | Plane |
|
One plane of a composite (multi-plane) tensor. More... | |
| struct | PowerFieldReading |
|
One scalar rail field read from a PMIC. More... | |
| struct | PowerFieldSummary |
|
Summary statistics for one scalar rail field. More... | |
| class | PowerMonitor |
|
Background SOM power sampler. More... | |
| struct | PowerMonitorOptions |
|
Options for a PowerMonitor. More... | |
| struct | PowerRailConfig |
|
Configuration for one PMBus rail exposed by a paged PMIC. More... | |
| struct | PowerRailReading |
|
Snapshot for one rail. More... | |
| struct | PowerRailSummary |
|
Summary statistics for one rail. More... | |
| struct | PowerSnapshot |
|
Point-in-time board power snapshot. More... | |
| struct | PowerSummary |
|
Aggregated power monitor result. More... | |
| struct | PreparedRunnerOptions |
|
Experimental prepared-route runner options. More... | |
| struct | PreparedRuntimeDescriptor |
| class | Preproc |
|
Fused CVU preprocessing Node — resize + color-convert + normalize (+ optional tess). More... | |
| struct | PreprocessContract |
|
Per-input contract describing what the preprocess stage expects to receive. More... | |
| struct | PreprocessExplicitKnobs |
|
Per-stage flags recording which preprocess fields the user set explicitly. More... | |
| struct | PreprocessMetaContract |
|
Metadata-side contract — names and fields the preprocess stage requires. More... | |
| struct | PreprocessMetaTemplate |
|
Preprocess metadata template attached to ingress buffers. More... | |
| struct | PreprocessOptions |
|
User-facing preprocess intent — what the application asks for. More... | |
| struct | PreprocessRuntimeMeta |
|
Per-buffer preprocessing context — the inverse-transform breadcrumb trail. More... | |
| struct | PreprocOptions |
| struct | ProcessCvuOptions |
|
Simple process-CVU backend placement for model pre/post stages. More... | |
| struct | ProcessMlaOptions |
|
process-MLA execution options. More... | |
| struct | ProfilerKernelAggregate |
|
Aggregated timings for one (backend, kernel, stage, slot) tuple. More... | |
| struct | ProfilerKernelInvocation |
|
One kernel-invocation telemetry event. More... | |
| struct | ProfilerMemcpySite |
|
Aggregate counters for one instrumented memcpy site. More... | |
| struct | ProfilerReport |
|
Snapshot bundle returned by LatencyProfiler::finalize(). More... | |
| struct | PullError |
|
Structured error returned by Run::pull() when status is Error. More... | |
| class | Quant |
|
CVU kernel Node that quantizes FP32 tensors to INT8 using scale + zero-point. More... | |
| struct | QuantizeSpec |
|
INT8 (or other low-precision) quantization parameters. More... | |
| struct | QuantOptions |
| struct | QuantSpec |
|
Quantization metadata for INT8/INT16 tensors. More... | |
| class | QuantTess |
|
Fused CVU kernel Node: Quant (FP32→INT8) followed by Tess. More... | |
| struct | QuantTessOptions |
| class | Queue |
|
Wraps GStreamer's queue element — inserts a thread/buffer boundary. More... | |
| struct | ResizeSpec |
|
Resize / letterbox / crop parameters. More... | |
| struct | ResolvedPreprocessPlan |
|
Final resolved plan — what the framework actually compiled and runs. More... | |
| class | RTSPInput |
|
RTSP source Node — pulls a stream from an RTSP URL. More... | |
| class | RtspServerHandle |
|
Live handle for a Graph running in RTSP server mode. More... | |
| struct | RtspServerOptions |
|
Options for Graph::run_rtsp() — controls the RTSP server's mount point and ports. More... | |
| class | Run |
|
Live pipeline handle: push inputs in, pull outputs out. More... | |
| struct | RunAdvancedOptions |
|
Advanced runtime tuning knobs (most users never set these). More... | |
| struct | RunAutoExportOptions |
| struct | RunDiagSnapshot |
|
Aggregate diagnostic snapshot: stages, boundaries, per-element, per-pad. More... | |
| struct | RunElementFlowStats |
|
Per-element data-flow telemetry — buffer and byte counts, plus caps changes. More... | |
| struct | RunElementPadTimingStats |
|
Per-pad timing — finest-grained telemetry, one row per (element, pad). More... | |
| struct | RunElementTimingStats |
|
Per-element timing — finer-grained than per-stage; one row per GStreamer element. More... | |
| struct | RunExportOptions |
| struct | RunMeasurementSummary |
|
One-call runtime measurement summary. More... | |
| struct | RunOptions |
|
Per-Run runtime options. More... | |
| struct | RunReportOptions |
|
Toggles for what Run::report() includes in its formatted text output. More... | |
| struct | RunStageStats |
|
Per-stage timing telemetry — how long each stage takes per sample. More... | |
| struct | RunStats |
|
Per-Run end-to-end statistics: counts and latency. More... | |
| struct | RuntimeCounters |
|
Common input/output/drop counters. More... | |
| struct | RuntimeLatencyMetrics |
|
Basic latency summary in milliseconds. More... | |
| struct | RuntimeMetricGroup |
|
Generic named metric group for adapter-specific diagnostics. More... | |
| struct | RuntimeMetrics |
|
Unified runtime metrics returned by Run, Model::Runner, and tools. More... | |
| struct | RuntimeMetricsOptions |
|
Options controlling collection and rendering of runtime metrics. More... | |
| struct | RuntimeMetricValue |
|
Generic named scalar metric. More... | |
| struct | Sample |
|
Typed payload returned by Run::pull() and consumed by Run::push(). More... | |
| struct | Segment |
|
One named memory segment within a multi-segment tensor buffer (e.g., separate Y / UV planes). More... | |
| struct | Semantic |
|
Discriminated union of "what this tensor represents". More... | |
| class | SimaArgMax |
|
EV74 postprocess Node that emits the top-class index from a classification tensor. More... | |
| struct | SimaArgMaxOptions |
|
Construction options for a SimaArgMax Node. More... | |
| class | SimaBoxDecode |
|
EV74 postprocess Node that decodes detection-head tensors into object boxes (with NMS). More... | |
| class | SimaRender |
|
Node that renders bounding-box overlays onto a video frame. More... | |
| struct | SimaRenderOptions |
|
Construction options for a SimaRender Node. More... | |
| class | StillImageInput |
|
Source Node that emits a single image as a continuous video stream. More... | |
| struct | Tensor |
|
Universal tensor type — a labeled box of numbers that flows between Nodes. More... | |
| struct | TensorBuffer |
|
Storage handle for a tensor — opaque container for one of four backing memory kinds. More... | |
| struct | TensorConstraint |
|
Declarative tensor contract — describes the shape/dtype/device/format a tensor must satisfy. More... | |
| struct | TensorRouteMeta |
|
Routing metadata that travels with a tensor through multi-output pipelines. More... | |
| class | Tess |
|
CVU kernel Node that tessellates a natural-layout tensor into MLA tile geometry. More... | |
| struct | TessellateSpec |
|
MLA tessellation (tile-shuffle) parameters. More... | |
| struct | TessOptions |
| struct | TessSpec |
|
Tessellation metadata — tile geometry for the MLA's tile-block layout. More... | |
| struct | TextSpec |
|
UTF-8 text tensor metadata. More... | |
| struct | TokensSpec |
|
Token-tensor metadata for NLP-style tensors. More... | |
| struct | Transform |
|
Discriminated union of all per-stage transform specs. More... | |
| class | UdpOutput |
|
UDP sink Node — writes packets to a UDP destination. More... | |
| struct | UdpOutputOptions |
| struct | ValidateOptions |
|
Options for Graph::validate(). More... | |
| struct | ValidationContext |
|
Context passed to contracts during validation. More... | |
| struct | ValidationIssue |
| class | ValidationReport |
|
Report produced by running a ContractRegistry. More... | |
| struct | VerboseOptions |
|
Per-topic framework verbosity controls. More... | |
| class | VideoConvert |
|
Wraps GStreamer's videoconvert. More... | |
| class | VideoScale |
|
Wraps GStreamer's videoscale. More... | |
| class | VideoTrackSelect |
|
Creates a qtdemux element and selects a specific video pad (e.g., demux.video_0). More... | |
Typedefs Index
| using | BusMessageFn = void(*)(const char *type, const char *src, const std::string &line, void *user_data) |
|
Callback invoked for every bus message drained. More... | |
| using | BusErrorFn = void(*)(const std::string &line, void *user_data) |
|
Callback invoked when a bus error message is encountered. More... | |
| using | TensorSpec = TensorConstraint |
| using | BoxDecodeResultList = std::vector< BoxDecodeResult > |
|
List form used by public stage APIs; even single-image decode results travel as a list. More... | |
| using | InputType = PayloadType |
|
Compatibility alias for code written during the InputOptions migration. More... | |
| using | GraphRunAutoExportOptions = RunAutoExportOptions |
|
Backward-compatible name for the previous graph-run export option spelling. More... | |
| using | GraphRunExportOptions = RunExportOptions |
|
Backward-compatible name for callers that still use the old graph-run terminology. More... | |
| using | TensorList = std::vector< Tensor > |
|
Convenience alias for an ordered list of Tensors (multi-input/multi-output models). More... | |
| using | Memory = TensorMemory |
|
Short public alias for memory placement in Tensor/Sample constructors. More... | |
| using | ImageType = ImageSpec::PixelFormat |
|
Short public alias for image pixel format in Tensor/Sample constructors. More... | |
| using | Storage = TensorBuffer |
|
Alias for backward-compatibility. New code prefers TensorBuffer directly. More... | |
| using | ByteFormat = ByteStreamSpec::ByteFormat |
|
Convenience top-level alias for ByteStreamSpec::ByteFormat. More... | |
Enumerations Index
| enum class | GraphTensorMaterializationKind : std::uint8_t { ... } |
| enum class | CastDirection { ... } |
|
Direction of the BF16/FP32 conversion performed by a Cast Node. More... | |
| enum class | PayloadType { ... } |
|
Semantic family of a payload flowing through a Graph. More... | |
| enum class | TensorMemory { ... } |
|
Placement for Tensor creators that materialize owned storage. More... | |
| enum class | MapMode { ... } |
|
Access mode for TensorBuffer::map(). More... | |
| enum class | MemoryContract { ... } |
|
How a Node (or Graph) wants buffer memory to be sourced/handed back. More... | |
| enum class | CapsMemory { ... } |
|
Memory class to advertise in GStreamer caps. More... | |
| enum class | ContractFieldSource { ... } |
|
Where the value of a contract field originates. More... | |
| enum class | ContractOverridePolicy { ... } |
|
Whether the Builder may override a contract field at build time. More... | |
| enum class | ValidationSeverity { ... } |
|
Severity level for validation issues. More... | |
| enum class | AutoFlag { ... } |
|
Tri-state knob: let the planner decide, force on, or force off. More... | |
| enum class | InputKind { ... } |
|
What kind of input the user is feeding the preprocess pipeline. More... | |
| enum class | ResizeMode { ... } |
|
How the resize stage maps non-matching input dimensions to the model's input shape. More... | |
| enum class | PreprocessColorFormat { ... } |
|
Color format hint for the color-convert stage. More... | |
| enum class | NormalizePreset { ... } |
|
Common normalize presets — convenient shorthand for famous mean/stddev pairs. More... | |
| enum class | PreprocessGraphFamily { ... } |
|
Which preprocess graph family the planner selected. More... | |
| enum class | TransformType { ... } |
|
Which transformation a Transform represents — used in user-supplied transform lists. More... | |
| enum class | CombinePolicy { ... } |
|
How a public Graph output combines multiple named producers. More... | |
| enum class | InputMemoryPolicy { ... } |
|
Where ingress buffers should be allocated when the application pushes samples. More... | |
| enum class | BoxDecodeType : std::int32_t { ... } |
|
Decode families accepted by the BoxDecode backend. More... | |
| enum class | BoxDecodeTypeOption : std::int32_t { ... } |
|
Tensor packing/layout option within a decode family. More... | |
| enum class | FormatTag { ... } |
|
Identifies a media or tensor payload format. More... | |
| enum class | VerbosityLevel { ... } |
|
Coarse-grained framework verbosity selector. More... | |
| enum class | RunMode { ... } |
| enum class | SampleKind { ... } |
| enum class | PullStatus { ... } |
|
Result status of Run::pull(). More... | |
| enum class | PowerMonitorProfile { ... } |
|
Named board-level power monitor profiles. More... | |
| enum class | OverflowPolicy { ... } |
|
What push() does when the input queue is full. More... | |
| enum class | RunPreset { ... } |
|
Convenience preset bundles for RunOptions. More... | |
| enum class | OutputMemory { ... } |
|
How output Tensors relate to the underlying GStreamer buffers. More... | |
| enum class | RuntimeMetricsFormat { ... } |
| enum class | ConversionKind { ... } |
|
What kind of transformation a tensor conversion represents. More... | |
| enum class | ConversionPolicy { ... } |
|
How strict the framework is about implicit tensor conversions. More... | |
| enum class | DeviceType { ... } |
|
Where a tensor's data lives — which processor can read it directly. More... | |
| enum class | StorageKind { ... } |
|
How a TensorBuffer's memory was acquired and how to access it. More... | |
| enum class | PlaneRole { ... } |
|
Role of a plane within a composite (multi-plane) tensor. More... | |
| enum class | TensorDType { ... } |
|
Element data type of a tensor. More... | |
| enum class | TensorAxisSemantic : uint8_t { ... } |
|
Per-axis semantic tag — the long-term layout vocabulary. More... | |
| enum class | TensorLayout { ... } |
|
Transition-only coarse layout token (HWC / CHW / HW). More... | |
Operators Index
| std::ostream & | operator<< (std::ostream &os, const FormatSpec &spec) |
|
Stream-insert the canonical string form of spec. More... | |
Functions Index
| const char * | to_string (ValidationSeverity s) |
|
Stable string label for a ValidationSeverity (for reports/logs). More... | |
| std::string | gst_message_to_string (GstMessage *msg) |
|
Format a single GStreamer bus message into a stable, one-line string. More... | |
| void | drain_bus (GstElement *pipeline, BusMessageFn on_message, void *user_data) |
|
Drain pending messages from the pipeline's bus, invoking on_message for each. More... | |
| void | throw_if_bus_error (GstElement *pipeline, BusMessageFn on_message, void *user_data, BusErrorFn on_error, void *error_user_data) |
|
Drain the bus and throw a NeatError if any error message is found. More... | |
| bool | element_exists (const char *factory) |
|
Returns true if a GStreamer element factory with factory name is registered. More... | |
| bool | element_property_exists (const char *factory, const char *property_name) |
|
Returns true if factory exists and exposes a property named property_name. More... | |
| std::string | factory_plugin_path (const char *factory) |
|
Returns the filesystem path of the plugin .so providing factory, or empty if unknown. More... | |
| void | require_element (const char *factory, const char *context) |
| void | require_tensordecoder (const char *context) |
|
Throw a NeatError if SiMa's tensordecoder element is not available. More... | |
| void | gst_init_once () |
|
Initialize GStreamer exactly once across the process. More... | |
| bool | prepare_processmla_runtime_config (ProcessMlaRuntimeConfig *runtime_cfg, std::string *error_message=nullptr) |
| bool | build_graph_processmla_prepared_stage (const GraphProcessMlaStageRequest &request, simaai::gst::ProcessMlaPreparedStage *out, std::string *error_message=nullptr) |
| bool | build_graph_processcvu_prepared_stage (const GraphProcessCvuStageRequest &request, simaai::gst::ProcessCvuPreparedStage *out, std::string *error_message=nullptr) |
| bool | build_prepared_stage_from_manifest_context (const GstContext *static_manifest_context, const char *stage_id_or_name, const char *element_name_fallback, simaai::gst::PreparedStageSpec *out, std::string *error_message=nullptr) |
| bool | attach_prepared_runtime_context (GstElement *pipeline, PreparedRuntimeDescriptor prepared_runtime, std::string *error_message=nullptr) |
| void | prewarm_runtime () |
|
Initialize NEAT's runtime substrate early. More... | |
| std::future< void > | prewarm_runtime_async () |
|
Start NEAT runtime prewarm on a background thread. More... | |
| std::string | resolve_input_media_type (const InputOptions &opt) |
|
Resolve the internal caps media type requested by public InputOptions. More... | |
| constexpr const char * | box_decode_type_token (BoxDecodeType type) |
|
Stable lower-case token for a decode family (used in caps, manifests, logs). More... | |
| constexpr const char * | box_decode_type_option_token (BoxDecodeTypeOption option) |
|
Stable lower-case token for a decode-layout option. More... | |
| constexpr bool | box_decode_type_is_yolo_family (BoxDecodeType type) |
|
True iff type is one of the YOLO-family detection or segmentation variants. More... | |
| constexpr bool | box_decode_type_is_segmentation (BoxDecodeType type) |
|
True iff type is a segmentation variant (carries a mask head). More... | |
| constexpr const char * | box_decode_type_contract_summary (BoxDecodeType type) |
|
Human-readable summary of type's tensor contract, used in API/docs/error surfaces. More... | |
| std::vector< Box > | parse_bbox_bytes (const std::vector< uint8_t > &bytes, int img_w, int img_h, int expected_topk, bool strict) |
|
Parse a packed BBOX byte payload into typed Box records. More... | |
| BoxDecodeResult | decode_bbox_tensor (const simaai::neat::Tensor &tensor, int img_w, int img_h, int expected_topk, bool strict) |
|
Decode a BBOX-format Tensor into a BoxDecodeResult. More... | |
| simaai::neat::Tensor | boxes_to_tensor (const std::vector< Box > &boxes) |
|
Build a decoded-boxes Tensor from parsed Box records. More... | |
| simaai::neat::TensorList | decode_bbox (const simaai::neat::TensorList &bbox_tensors, int img_w=0, int img_h=0, int top_k=0, bool strict=false) |
|
Decode a list of BBOX-format tensors into a list of decoded-boxes tensors. More... | |
| void | tag_detection_format (simaai::neat::Tensor &tensor, std::string format) |
|
Tag a tensor as carrying a detection-decoder wire format. More... | |
| std::string | read_detection_format (const simaai::neat::Tensor &tensor) |
|
Read the detection-format token from a tensor, if present. More... | |
| void | tag_detection_format_in_sample (simaai::neat::Sample &sample) |
|
Walk a Sample tree and tag every recognized BBOX-payload Tensor with semantic.detection.format = "BBOX". More... | |
| simaai::neat::EncodedSpec::Codec | caps_to_codec (const std::string &caps_string) |
|
Map a GStreamer-style caps string to an EncodedSpec::Codec value. More... | |
| Sample | make_encoded_sample (std::vector< uint8_t > bytes, std::string caps_string, int64_t pts_ns=-1, int64_t dts_ns=-1, int64_t duration_ns=-1) |
|
Build an encoded Sample from raw bytes and caps metadata. More... | |
| const char * | format_tag_name (FormatTag tag) |
|
Stable, canonical string token for tag (empty string for Auto). More... | |
| std::string | format_tag_to_string (FormatTag tag) |
|
std::string form of the canonical format token. More... | |
| std::string | upper_copy_ascii (std::string value) |
|
ASCII upper-case copy of value (does not touch non-ASCII bytes). More... | |
| bool | tensor_format_is_bf16_alias (std::string value) |
|
True iff value names BF16 (any of BF16, BFLOAT16, EVXX_BF16, EVXX_BFLOAT16). More... | |
| bool | tensor_format_is_fp32_alias (std::string value) |
|
True iff value names FP32 (FP32, FLOAT32, EVXX_FLOAT32). More... | |
| bool | tensor_format_is_int8_alias (std::string value) |
|
True iff value names INT8 (INT8, EVXX_INT8). More... | |
| bool | tensor_format_is_int16_alias (std::string value) |
|
True iff value names INT16 (INT16, EVXX_INT16). More... | |
| bool | tensor_format_is_int32_alias (std::string value) |
|
True iff value names INT32 (INT32, EVXX_INT32). More... | |
| std::string | normalize_tensor_caps_format (std::string value) |
|
Normalize tensor format aliases to the canonical EVXX_* token. More... | |
| std::string | normalize_caps_format_for_media (std::string media_type, std::string format) |
|
Normalize a caps-format string conditionally on its media type. More... | |
| FormatTag | format_tag_from_string (const std::string &value) |
|
Parse a string token to a FormatTag; unknown values map to Auto. More... | |
| bool | is_raw_video_format (FormatTag tag) |
|
True iff tag names a raw (uncompressed) video format. More... | |
| bool | is_tensor_payload_format (FormatTag tag) |
|
True iff tag names a tensor payload (MLA, BBOX, ARGMAX, dtype kinds, EVXX aliases). More... | |
| PayloadType | sample_payload_type (const Sample &sample) |
|
Return a Sample's standardized payload family, falling back from legacy media_type. More... | |
| std::string | sample_media_type (const Sample &sample) |
|
Return the internal media type corresponding to a Sample's payload family. More... | |
| Sample | make_tensor_sample (const std::string &port_name, simaai::neat::Tensor tensor) |
|
Construct a TensorSet-kind Sample wrapping a single Tensor for the named port. More... | |
| Sample | make_bundle_sample (std::initializer_list< Sample > fields) |
|
Construct a Bundle-kind Sample whose payload is the given list of inner Samples. More... | |
| bool | sample_is_multi_output (const Sample &sample) |
|
Returns true if the sample carries multiple outputs (Bundle, or TensorSet with size > 1). More... | |
| bool | sample_has_tensor_list (const Sample &sample) |
|
Returns true if the sample is a TensorSet with at least one tensor. More... | |
| TensorList & | sample_tensor_list (Sample &sample, const char *where=nullptr) |
|
Mutable reference to the sample's tensor list. Throws NeatError if kind != TensorSet. More... | |
| const TensorList & | sample_tensor_list (const Sample &sample, const char *where=nullptr) |
|
Const reference to the sample's tensor list. Throws NeatError if kind != TensorSet. More... | |
| Tensor & | require_single_tensor (Sample &sample, const char *where=nullptr) |
|
Returns the sample's single Tensor; throws if the sample carries 0 or >1 tensors. More... | |
| const Tensor & | require_single_tensor (const Sample &sample, const char *where=nullptr) |
|
Const variant of require_single_tensor. More... | |
| TensorList | tensors_from_sample (const Sample &sample, bool require_nonempty=true) |
|
Extract all tensors from any sample shape (Tensor, TensorSet, Bundle); flattens recursively. More... | |
| Sample | sample_from_tensors (const TensorList &tensors) |
|
Construct a TensorSet sample from a list of tensors. More... | |
| PayloadType | payload_type_from_media_type (std::string_view media_type) |
|
Convert an internal/legacy caps media string to the public payload family. More... | |
| PayloadType | input_type_from_media_type (std::string_view media_type) |
|
Legacy helper name kept as a source-compatible bridge. More... | |
| std::string | media_type_from_payload_type (PayloadType payload_type) |
|
Convert a payload family to the canonical internal media type when one exists. More... | |
| std::string | run_to_json (const Run &run, const RunExportOptions &opt={}, std::string *err=nullptr) |
|
Serialize a built Run to sima.neat.graph_run JSON. Returns empty string on error. More... | |
| bool | save_run_json (const Run &run, const std::string &path, const RunExportOptions &opt={}, std::string *err=nullptr) |
|
Atomically write run_to_json(run, opt) to path using path + ".tmp" then rename. More... | |
| std::string | graph_run_to_json (const Run &run, const GraphRunExportOptions &opt={}, std::string *err=nullptr) |
|
Compatibility wrapper for existing graph-run JSON call sites. More... | |
| bool | save_graph_run_json (const Run &run, const std::string &path, const GraphRunExportOptions &opt={}, std::string *err=nullptr) |
|
Compatibility wrapper for existing graph-run JSON call sites. More... | |
| Tensor | from_gst_sample (GstSample *sample) |
| PcmAudio | tensor_to_pcm_audio (const Tensor &tensor) |
| ConversionCost | estimate_conversion_cost (ConversionKind kind, std::uint64_t bytes_copied) |
|
Estimate the cost (bytes + compute class) of a conversion of the given kind moving bytes_copied bytes. More... | |
| bool | conversion_allowed (ConversionPolicy policy, ConversionKind kind) |
|
Returns true if the policy allows a conversion of this kind (without performing it). More... | |
| std::shared_ptr< TensorBuffer > | make_cpu_owned_storage (std::size_t size_bytes) |
|
Allocate a CPU-owned heap buffer of size_bytes, initialized to zero. More... | |
| std::shared_ptr< TensorBuffer > | make_cpu_external_storage (void *data, std::size_t size_bytes, std::shared_ptr< void > holder={}, bool read_only=true) |
|
Wrap a foreign CPU pointer as a TensorBuffer without copying. More... | |
| bool | is_tessellated_int8_format (const std::string &fmt) |
|
True iff fmt names an INT8 tessellated tensor format string. More... | |
| bool | is_tessellated_bf16_format (const std::string &fmt) |
|
True iff fmt names a BF16 tessellated tensor format string. More... | |
| std::vector< PowerRailConfig > | default_modalix_som_power_rails () |
|
Default Modalix SOM PMIC rail table from the board measurement scripts. More... | |
| std::vector< PowerRailConfig > | default_modalix_dvt_power_rails () |
|
Default Modalix DVT PMIC rail table. More... | |
| PowerMonitorProfile | detect_default_power_monitor_profile () |
|
Detect the most likely built-in board power profile for the current host. More... | |
| std::string | power_monitor_profile_name (PowerMonitorProfile profile) |
|
Human-readable name for a power monitor profile. More... | |
| std::vector< PowerRailConfig > | power_rails_for_profile (PowerMonitorProfile profile) |
|
Resolve a built-in board profile to its rail table. More... | |
| PowerMonitorOptions | board_power_monitor_options (int sample_interval_ms=100, PowerMonitorProfile profile=PowerMonitorProfile::Auto) |
|
Convenience options enabling board power monitoring with optional auto-detect. More... | |
| PowerMonitorOptions | modalix_som_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix SOM power monitoring. More... | |
| PowerMonitorOptions | modalix_dvt_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix DVT power monitoring. More... | |
| PowerSnapshot | read_power_snapshot (const PowerMonitorOptions &options) |
|
Read one immediate power snapshot using native Linux I2C access. More... | |
| std::string | format_power_summary (const PowerSummary &summary) |
|
Format a compact human-readable power summary. More... | |
| std::string | power_summary_to_json (const PowerSummary &summary, int indent=2) |
|
Format power summary as a JSON object. More... | |
| std::string | format_runtime_metrics (const RuntimeMetrics &metrics, RuntimeMetricsFormat format=RuntimeMetricsFormat::Text) |
|
Render runtime metrics in the requested format. More... | |
| std::string | runtime_metrics_to_json (const RuntimeMetrics &metrics, int indent=0) |
|
Render runtime metrics as JSON. More... | |
| std::string | runtime_metrics_to_text (const RuntimeMetrics &metrics) |
|
Render runtime metrics as human-readable text. More... | |
| std::string | runtime_metrics_to_compact_text (const RuntimeMetrics &metrics) |
|
Render runtime metrics as one compact line. More... | |
Variables Index
| constexpr int64_t | kDecodedBoxColumns = 6 |
|
Number of columns in a decoded-boxes tensor: x1, y1, x2, y2, score, class_id. More... | |
Typedefs
BoxDecodeResultList
|
List form used by public stage APIs; even single-image decode results travel as a list.
Definition at line 59 of file DetectionTypes.h.
BusErrorFn
|
Callback invoked when a bus error message is encountered.
Definition at line 36 of file GstBusWatch.h.
BusMessageFn
|
Callback invoked for every bus message drained.
- Parameters
-
type GStreamer message type as a stable string (e.g., "warning", "info").
src Name of the element that posted the message, or empty.
line Pre-formatted single-line summary of the message.
user_data Opaque pointer the caller registered.
Definition at line 32 of file GstBusWatch.h.
GraphRunAutoExportOptions
|
Backward-compatible name for the previous graph-run export option spelling.
GraphRunExportOptions
|
Backward-compatible name for callers that still use the old graph-run terminology.
Definition at line 37 of file RunExport.h.
ImageType
|
Short public alias for image pixel format in Tensor/Sample constructors.
Definition at line 155 of file TensorCore.h.
InputType
|
Compatibility alias for code written during the InputOptions migration.
Definition at line 28 of file PayloadType.h.
Memory
|
Short public alias for memory placement in Tensor/Sample constructors.
Definition at line 106 of file TensorCore.h.
Storage
|
Alias for backward-compatibility. New code prefers TensorBuffer directly.
Definition at line 488 of file TensorCore.h.
TensorList
|
Convenience alias for an ordered list of Tensors (multi-input/multi-output models).
Definition at line 23 of file Tensor.h.
TensorSpec
|
Tensor specification used by the Model API.
Definition at line 48 of file Model.h.
Enumerations
CastDirection
| strong |
Direction of the BF16/FP32 conversion performed by a Cast Node.
GraphTensorMaterializationKind
| strong |
Definition at line 19 of file PreparedRuntimeBridge.h.
MapMode
| strong |
Access mode for TensorBuffer::map().
- Enumeration values
Affects whether the framework treats the mapping as read or write.
Definition at line 125 of file TensorCore.h.
PayloadType
| strong |
Semantic family of a payload flowing through a Graph.
- Enumeration values
-
Auto Infer from tensor/sample metadata when possible (= 0) Image Decoded image pixels (video/x-raw internally) Tensor Tensor payload (application/vnd.simaai.tensor internally) Encoded Encoded video/byte-stream payloads such as H.264
PayloadType is intentionally neutral: the same enum describes an input option, a pushed/pulled Sample, and a boundary contract. GStreamer media strings are an internal transport detail derived from this enum at the adapter boundary.
Definition at line 20 of file PayloadType.h.
TensorMemory
| strong |
Placement for Tensor creators that materialize owned storage.
The default for new owning creators is EV74: DDR allocated from the SiMa allocator in the EV74-addressable window (not EV74 VCCM). Use CPU for ordinary malloc-backed host tensors, or MLA for DMS0-backed tensors when the runtime allocator is available.
Definition at line 97 of file TensorCore.h.
Operators
operator<<()
| inline |
Stream-insert the canonical string form of spec.
Definition at line 332 of file FormatSpec.h.
Functions
attach_prepared_runtime_context()
|
Definition at line 121 of file PreparedRuntimeBridge.h.
box_decode_type_contract_summary()
| constexpr |
Human-readable summary of type's tensor contract, used in API/docs/error surfaces.
Definition at line 205 of file BoxDecodeType.h.
box_decode_type_is_segmentation()
| constexpr |
True iff type is a segmentation variant (carries a mask head).
Definition at line 178 of file BoxDecodeType.h.
box_decode_type_is_yolo_family()
| constexpr |
True iff type is one of the YOLO-family detection or segmentation variants.
Definition at line 151 of file BoxDecodeType.h.
box_decode_type_option_token()
| constexpr |
Stable lower-case token for a decode-layout option.
Definition at line 123 of file BoxDecodeType.h.
box_decode_type_token()
| constexpr |
Stable lower-case token for a decode family (used in caps, manifests, logs).
Definition at line 80 of file BoxDecodeType.h.
boxes_to_tensor()
|
Build a decoded-boxes Tensor from parsed Box records.
Produces a dense CPU float32 tensor of shape [boxes.size(), 6]. Columns are x1, y1, x2, y2, score, class_id (class_id stored as float; exact for the integer range).
Definition at line 99 of file DetectionTypes.h.
build_graph_processcvu_prepared_stage()
|
Definition at line 111 of file PreparedRuntimeBridge.h.
build_graph_processmla_prepared_stage()
|
Definition at line 107 of file PreparedRuntimeBridge.h.
build_prepared_stage_from_manifest_context()
|
Definition at line 115 of file PreparedRuntimeBridge.h.
caps_to_codec()
|
Map a GStreamer-style caps string to an EncodedSpec::Codec value.
- Parameters
-
caps_string GStreamer caps string (e.g., "video/x-h264, ...").
- Returns
Matching codec enum, or the codec-unspecified sentinel if no match.
Definition at line 31 of file EncodedSampleUtil.h.
conversion_allowed()
|
Returns true if the policy allows a conversion of this kind (without performing it).
Definition at line 95 of file TensorConversion.h.
decode_bbox()
|
Decode a list of BBOX-format tensors into a list of decoded-boxes tensors.
Positional, 1:1 — output [i] is the decode of input [i]. Each output is a dense CPU float32 tensor of shape [num_detections, 6] (columns x1, y1, x2, y2, score, class_id).
Every input tensor must be BBOX-format (semantic.detection.format == "BBOX"); a tensor that is not raises (no silent skip).
- Parameters
-
bbox_tensors The BBOX-format tensors (e.g. a model's run output).
img_w Optional source width to clamp coordinates to (0 = no clamp).
img_h Optional source height to clamp coordinates to (0 = no clamp).
top_k Optional cap on detections per tensor (0 = no cap).
strict When true, malformed buffers throw instead of best-effort parsing.
- Returns
A TensorList of the same length as bbox_tensors.
Definition at line 117 of file DetectionTypes.h.
decode_bbox_tensor()
|
Decode a BBOX-format Tensor into a BoxDecodeResult.
Convenience wrapper that maps the tensor, parses bytes via parse_bbox_bytes, and retains the raw byte view alongside the typed boxes.
- Parameters
-
tensor Tensor whose payload is a BBOX byte stream.
img_w Original image width used to clamp/scale coordinates.
img_h Original image height used to clamp/scale coordinates.
expected_topk Number of detections expected (advisory; see strict).
strict If true, mismatches against expected_topk throw.
- Returns
Parsed detections plus retained raw bytes.
Definition at line 87 of file DetectionTypes.h.
drain_bus()
|
Drain pending messages from the pipeline's bus, invoking on_message for each.
Non-blocking: pulls all messages currently posted, then returns. Safe to call from the framework's polling loop while the pipeline is running.
- Parameters
-
pipeline Pipeline whose bus to drain.
on_message Callback invoked for each message (may be null).
user_data Opaque pointer forwarded to on_message.
Definition at line 55 of file GstBusWatch.h.
element_exists()
|
Returns true if a GStreamer element factory with factory name is registered.
Definition at line 20 of file GstHelpers.h.
element_property_exists()
|
Returns true if factory exists and exposes a property named property_name.
Definition at line 23 of file GstHelpers.h.
estimate_conversion_cost()
|
Estimate the cost (bytes + compute class) of a conversion of the given kind moving bytes_copied bytes.
Definition at line 93 of file TensorConversion.h.
factory_plugin_path()
|
Returns the filesystem path of the plugin .so providing factory, or empty if unknown.
Definition at line 26 of file GstHelpers.h.
format_tag_from_string()
| inline |
Parse a string token to a FormatTag; unknown values map to Auto.
Definition at line 199 of file FormatSpec.h.
format_tag_name()
| inline |
Stable, canonical string token for tag (empty string for Auto).
Definition at line 61 of file FormatSpec.h.
format_tag_to_string()
| inline |
std::string form of the canonical format token.
Definition at line 110 of file FormatSpec.h.
from_gst_sample()
|
Definition at line 18 of file TensorAdapters.h.
graph_run_to_json()
| inline |
Compatibility wrapper for existing graph-run JSON call sites.
Definition at line 48 of file RunExport.h.
gst_init_once()
|
gst_message_to_string()
|
Format a single GStreamer bus message into a stable, one-line string.
- Parameters
-
msg The bus message to format. Must be non-null.
- Returns
Human-readable summary suitable for logs and GraphReport.
Definition at line 43 of file GstBusWatch.h.
input_type_from_media_type()
| inline |
Legacy helper name kept as a source-compatible bridge.
Definition at line 45 of file PayloadType.h.
is_raw_video_format()
| inline |
True iff tag names a raw (uncompressed) video format.
Definition at line 251 of file FormatSpec.h.
is_tensor_payload_format()
| inline |
True iff tag names a tensor payload (MLA, BBOX, ARGMAX, dtype kinds, EVXX aliases).
Definition at line 257 of file FormatSpec.h.
is_tessellated_bf16_format()
|
True iff fmt names a BF16 tessellated tensor format string.
Definition at line 20 of file TessellatedTensor.h.
is_tessellated_int8_format()
|
True iff fmt names an INT8 tessellated tensor format string.
Definition at line 18 of file TessellatedTensor.h.
make_bundle_sample()
| inline |
Construct a Bundle-kind Sample whose payload is the given list of inner Samples.
Definition at line 704 of file GraphOptions.h.
make_cpu_external_storage()
|
Wrap a foreign CPU pointer as a TensorBuffer without copying.
Lifetime of the underlying memory is tracked via the holder shared_ptr — pass a custom deleter or a refcounted handle that keeps the original allocation alive. Set read_only to indicate the framework should not write through this storage.
Definition at line 499 of file TensorCore.h.
make_cpu_owned_storage()
|
Allocate a CPU-owned heap buffer of size_bytes, initialized to zero.
Definition at line 491 of file TensorCore.h.
make_encoded_sample()
|
Build an encoded Sample from raw bytes and caps metadata.
The returned Sample owns bytes (moved in) and carries the supplied caps string plus optional PTS/DTS/duration timestamps. Pass -1 to leave a timestamp unset.
- Parameters
-
bytes Encoded payload (e.g., H.264 access unit or NAL).
caps_string Caps string describing the codec/profile.
pts_ns Presentation timestamp in nanoseconds, or -1 if unknown.
dts_ns Decode timestamp in nanoseconds, or -1 if unknown.
duration_ns Frame duration in nanoseconds, or -1 if unknown.
- Returns
A Sample wrapping the encoded payload with the supplied caps.
Definition at line 47 of file EncodedSampleUtil.h.
make_tensor_sample()
| inline |
Construct a TensorSet-kind Sample wrapping a single Tensor for the named port.
Definition at line 679 of file GraphOptions.h.
media_type_from_payload_type()
| inline |
Convert a payload family to the canonical internal media type when one exists.
Definition at line 50 of file PayloadType.h.
normalize_caps_format_for_media()
| inline |
Normalize a caps-format string conditionally on its media type.
Tensor caps (application/vnd.simaai.tensor) are normalized to canonical EVXX_ tokens; other media types (raw video, encoded video) are returned unchanged.
- Parameters
-
media_type GStreamer-style media type (e.g., application/vnd.simaai.tensor).
format Format string to potentially normalize.
- Returns
Normalized format if applicable, otherwise format unchanged.
Definition at line 187 of file FormatSpec.h.
normalize_tensor_caps_format()
| inline |
Normalize tensor format aliases to the canonical EVXX_* token.
Maps user-facing or legacy spellings (FP32/FLOAT32, BF16/BFLOAT16, INT8/16/32) onto the EV-side caps form. Unknown values are passed through unchanged.
Definition at line 157 of file FormatSpec.h.
parse_bbox_bytes()
|
Parse a packed BBOX byte payload into typed Box records.
- Parameters
-
bytes Raw bytes (the BBOX caps payload).
img_w Original image width used to clamp/scale coordinates.
img_h Original image height used to clamp/scale coordinates.
expected_topk Number of detections expected (advisory; see strict).
strict If true, mismatches against expected_topk throw; if false, parse best-effort.
- Returns
Parsed detections (size may be less than expected_topk).
Definition at line 71 of file DetectionTypes.h.
payload_type_from_media_type()
| inline |
Convert an internal/legacy caps media string to the public payload family.
Definition at line 31 of file PayloadType.h.
prepare_processmla_runtime_config()
|
Definition at line 104 of file PreparedRuntimeBridge.h.
prewarm_runtime()
|
Initialize NEAT's runtime substrate early.
This performs the same one-time GStreamer/plugin setup that the first Graph::build() would otherwise perform. Calling it during application startup/model loading can hide cold plugin-registry cost from the first latency-sensitive build.
prewarm_runtime_async()
|
Start NEAT runtime prewarm on a background thread.
The returned future rethrows any initialization error from prewarm_runtime().
read_detection_format()
|
Read the detection-format token from a tensor, if present.
Checks tensor.semantic.detection->format first. Falls back to the legacy tensor.semantic.tess->format location for back-compat with un-migrated producers; the fallback is scheduled for removal once all producers tag via tag_detection_format.
- Returns
The format token, or empty string if neither slot carries one.
Definition at line 141 of file DetectionTypes.h.
require_element()
|
Throw a NeatError if factory is not registered.
- Parameters
-
factory GStreamer element factory name (e.g., "h264parse").
context Caller context interpolated into the error message (typically the Node kind).
Definition at line 33 of file GstHelpers.h.
require_single_tensor()
|
Returns the sample's single Tensor; throws if the sample carries 0 or >1 tensors.
Definition at line 727 of file GraphOptions.h.
require_single_tensor()
|
Const variant of require_single_tensor.
Definition at line 729 of file GraphOptions.h.
require_tensordecoder()
|
Throw a NeatError if SiMa's tensordecoder element is not available.
- Parameters
-
context Caller context for the error message.
Definition at line 39 of file GstHelpers.h.
resolve_input_media_type()
| inline |
Resolve the internal caps media type requested by public InputOptions.
Definition at line 115 of file Input.h.
run_to_json()
|
Serialize a built Run to sima.neat.graph_run JSON. Returns empty string on error.
Definition at line 40 of file RunExport.h.
sample_from_tensors()
|
Construct a TensorSet sample from a list of tensors.
Definition at line 733 of file GraphOptions.h.
sample_has_tensor_list()
| inline |
Returns true if the sample is a TensorSet with at least one tensor.
Definition at line 718 of file GraphOptions.h.
sample_is_multi_output()
| inline |
Returns true if the sample carries multiple outputs (Bundle, or TensorSet with size > 1).
Definition at line 712 of file GraphOptions.h.
sample_media_type()
| inline |
Return the internal media type corresponding to a Sample's payload family.
Definition at line 671 of file GraphOptions.h.
sample_payload_type()
| inline |
Return a Sample's standardized payload family, falling back from legacy media_type.
Definition at line 639 of file GraphOptions.h.
sample_tensor_list()
|
Mutable reference to the sample's tensor list. Throws NeatError if kind != TensorSet.
Definition at line 723 of file GraphOptions.h.
sample_tensor_list()
|
Const reference to the sample's tensor list. Throws NeatError if kind != TensorSet.
Definition at line 725 of file GraphOptions.h.
save_graph_run_json()
| inline |
Compatibility wrapper for existing graph-run JSON call sites.
Definition at line 54 of file RunExport.h.
save_run_json()
|
Atomically write run_to_json(run, opt) to path using path + ".tmp" then rename.
Definition at line 44 of file RunExport.h.
tag_detection_format()
|
Tag a tensor as carrying a detection-decoder wire format.
Sets tensor.semantic.detection = DetectionSpec{.format = format} so downstream consumers (and decode_bbox_tensor, pyneat.decode_bbox) can recognize the payload via the type-honest DetectionSpec slot instead of overloading TessSpec::format.
- Parameters
-
tensor Tensor to mutate.
format Wire-format token (e.g., "BBOX").
Definition at line 130 of file DetectionTypes.h.
tag_detection_format_in_sample()
|
Walk a Sample tree and tag every recognized BBOX-payload Tensor with semantic.detection.format = "BBOX".
Called as a runtime finalizer at every chokepoint where detection-stage outputs exit the framework into user code (e.g., Run::pull_tensors_strict, Postprocess). Normalises the type metadata so consumers can rely on the type-honest DetectionSpec slot instead of inspecting payload_tag, Sample::format, or the legacy TessSpec::format overload.
Definition at line 159 of file DetectionTypes.h.
tensor_format_is_bf16_alias()
| inline |
True iff value names BF16 (any of BF16, BFLOAT16, EVXX_BF16, EVXX_BFLOAT16).
Definition at line 122 of file FormatSpec.h.
tensor_format_is_fp32_alias()
| inline |
True iff value names FP32 (FP32, FLOAT32, EVXX_FLOAT32).
Definition at line 128 of file FormatSpec.h.
tensor_format_is_int16_alias()
| inline |
True iff value names INT16 (INT16, EVXX_INT16).
Definition at line 140 of file FormatSpec.h.
tensor_format_is_int32_alias()
| inline |
True iff value names INT32 (INT32, EVXX_INT32).
Definition at line 146 of file FormatSpec.h.
tensor_format_is_int8_alias()
| inline |
True iff value names INT8 (INT8, EVXX_INT8).
Definition at line 134 of file FormatSpec.h.
tensor_to_pcm_audio()
|
Definition at line 15 of file TensorAudio.h.
tensors_from_sample()
|
Extract all tensors from any sample shape (Tensor, TensorSet, Bundle); flattens recursively.
Definition at line 731 of file GraphOptions.h.
throw_if_bus_error()
|
Drain the bus and throw a NeatError if any error message is found.
Drains exactly like drain_bus but additionally invokes on_error and raises a NeatError if any GST_MESSAGE_ERROR is observed.
- Parameters
-
pipeline Pipeline whose bus to drain.
on_message Callback invoked for every message (may be null).
user_data Opaque pointer forwarded to on_message.
on_error Callback invoked once for the error line before throwing (may be null).
error_user_data Opaque pointer forwarded to on_error.
Definition at line 69 of file GstBusWatch.h.
to_string()
| inline |
Stable string label for a ValidationSeverity (for reports/logs).
Definition at line 36 of file ValidationReport.h.
upper_copy_ascii()
| inline |
ASCII upper-case copy of value (does not touch non-ASCII bytes).
Definition at line 115 of file FormatSpec.h.
Variables
kDecodedBoxColumns
| constexpr |
Number of columns in a decoded-boxes tensor: x1, y1, x2, y2, score, class_id.
Definition at line 91 of file DetectionTypes.h.
The documentation for this namespace was generated from the following files:
- ValidationReport.h
- GstBusWatch.h
- GstHelpers.h
- GstInit.h
- Model.h
- PreparedRuntimeBridge.h
- runtime.h
- Input.h
- Cast.h
- BoxDecodeType.h
- DetectionTypes.h
- EncodedSampleUtil.h
- FormatSpec.h
- GraphOptions.h
- PayloadType.h
- Run.h
- RunExport.h
- Tensor.h
- TensorAdapters.h
- TensorAudio.h
- TensorConversion.h
- TensorCore.h
- TessellatedTensor.h
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.