PyPI - oscura - Versions diffs - 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl - Mend

oscura 0.0.1py3-none-any.whl → 0.1.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (465) hide show

oscura/__init__.py +813 -8
oscura/__main__.py +392 -0
oscura/analyzers/__init__.py +37 -0
oscura/analyzers/digital/__init__.py +177 -0
oscura/analyzers/digital/bus.py +691 -0
oscura/analyzers/digital/clock.py +805 -0
oscura/analyzers/digital/correlation.py +720 -0
oscura/analyzers/digital/edges.py +632 -0
oscura/analyzers/digital/extraction.py +413 -0
oscura/analyzers/digital/quality.py +878 -0
oscura/analyzers/digital/signal_quality.py +877 -0
oscura/analyzers/digital/thresholds.py +708 -0
oscura/analyzers/digital/timing.py +1104 -0
oscura/analyzers/eye/__init__.py +46 -0
oscura/analyzers/eye/diagram.py +434 -0
oscura/analyzers/eye/metrics.py +555 -0
oscura/analyzers/jitter/__init__.py +83 -0
oscura/analyzers/jitter/ber.py +333 -0
oscura/analyzers/jitter/decomposition.py +759 -0
oscura/analyzers/jitter/measurements.py +413 -0
oscura/analyzers/jitter/spectrum.py +220 -0
oscura/analyzers/measurements.py +40 -0
oscura/analyzers/packet/__init__.py +171 -0
oscura/analyzers/packet/daq.py +1077 -0
oscura/analyzers/packet/metrics.py +437 -0
oscura/analyzers/packet/parser.py +327 -0
oscura/analyzers/packet/payload.py +2156 -0
oscura/analyzers/packet/payload_analysis.py +1312 -0
oscura/analyzers/packet/payload_extraction.py +236 -0
oscura/analyzers/packet/payload_patterns.py +670 -0
oscura/analyzers/packet/stream.py +359 -0
oscura/analyzers/patterns/__init__.py +266 -0
oscura/analyzers/patterns/clustering.py +1036 -0
oscura/analyzers/patterns/discovery.py +539 -0
oscura/analyzers/patterns/learning.py +797 -0
oscura/analyzers/patterns/matching.py +1091 -0
oscura/analyzers/patterns/periodic.py +650 -0
oscura/analyzers/patterns/sequences.py +767 -0
oscura/analyzers/power/__init__.py +116 -0
oscura/analyzers/power/ac_power.py +391 -0
oscura/analyzers/power/basic.py +383 -0
oscura/analyzers/power/conduction.py +314 -0
oscura/analyzers/power/efficiency.py +297 -0
oscura/analyzers/power/ripple.py +356 -0
oscura/analyzers/power/soa.py +372 -0
oscura/analyzers/power/switching.py +479 -0
oscura/analyzers/protocol/__init__.py +150 -0
oscura/analyzers/protocols/__init__.py +150 -0
oscura/analyzers/protocols/base.py +500 -0
oscura/analyzers/protocols/can.py +620 -0
oscura/analyzers/protocols/can_fd.py +448 -0
oscura/analyzers/protocols/flexray.py +405 -0
oscura/analyzers/protocols/hdlc.py +399 -0
oscura/analyzers/protocols/i2c.py +368 -0
oscura/analyzers/protocols/i2s.py +296 -0
oscura/analyzers/protocols/jtag.py +393 -0
oscura/analyzers/protocols/lin.py +445 -0
oscura/analyzers/protocols/manchester.py +333 -0
oscura/analyzers/protocols/onewire.py +501 -0
oscura/analyzers/protocols/spi.py +334 -0
oscura/analyzers/protocols/swd.py +325 -0
oscura/analyzers/protocols/uart.py +393 -0
oscura/analyzers/protocols/usb.py +495 -0
oscura/analyzers/signal_integrity/__init__.py +63 -0
oscura/analyzers/signal_integrity/embedding.py +294 -0
oscura/analyzers/signal_integrity/equalization.py +370 -0
oscura/analyzers/signal_integrity/sparams.py +484 -0
oscura/analyzers/spectral/__init__.py +53 -0
oscura/analyzers/spectral/chunked.py +273 -0
oscura/analyzers/spectral/chunked_fft.py +571 -0
oscura/analyzers/spectral/chunked_wavelet.py +391 -0
oscura/analyzers/spectral/fft.py +92 -0
oscura/analyzers/statistical/__init__.py +250 -0
oscura/analyzers/statistical/checksum.py +923 -0
oscura/analyzers/statistical/chunked_corr.py +228 -0
oscura/analyzers/statistical/classification.py +778 -0
oscura/analyzers/statistical/entropy.py +1113 -0
oscura/analyzers/statistical/ngrams.py +614 -0
oscura/analyzers/statistics/__init__.py +119 -0
oscura/analyzers/statistics/advanced.py +885 -0
oscura/analyzers/statistics/basic.py +263 -0
oscura/analyzers/statistics/correlation.py +630 -0
oscura/analyzers/statistics/distribution.py +298 -0
oscura/analyzers/statistics/outliers.py +463 -0
oscura/analyzers/statistics/streaming.py +93 -0
oscura/analyzers/statistics/trend.py +520 -0
oscura/analyzers/validation.py +598 -0
oscura/analyzers/waveform/__init__.py +36 -0
oscura/analyzers/waveform/measurements.py +943 -0
oscura/analyzers/waveform/measurements_with_uncertainty.py +371 -0
oscura/analyzers/waveform/spectral.py +1689 -0
oscura/analyzers/waveform/wavelets.py +298 -0
oscura/api/__init__.py +62 -0
oscura/api/dsl.py +538 -0
oscura/api/fluent.py +571 -0
oscura/api/operators.py +498 -0
oscura/api/optimization.py +392 -0
oscura/api/profiling.py +396 -0
oscura/automotive/__init__.py +73 -0
oscura/automotive/can/__init__.py +52 -0
oscura/automotive/can/analysis.py +356 -0
oscura/automotive/can/checksum.py +250 -0
oscura/automotive/can/correlation.py +212 -0
oscura/automotive/can/discovery.py +355 -0
oscura/automotive/can/message_wrapper.py +375 -0
oscura/automotive/can/models.py +385 -0
oscura/automotive/can/patterns.py +381 -0
oscura/automotive/can/session.py +452 -0
oscura/automotive/can/state_machine.py +300 -0
oscura/automotive/can/stimulus_response.py +461 -0
oscura/automotive/dbc/__init__.py +15 -0
oscura/automotive/dbc/generator.py +156 -0
oscura/automotive/dbc/parser.py +146 -0
oscura/automotive/dtc/__init__.py +30 -0
oscura/automotive/dtc/database.py +3036 -0
oscura/automotive/j1939/__init__.py +14 -0
oscura/automotive/j1939/decoder.py +745 -0
oscura/automotive/loaders/__init__.py +35 -0
oscura/automotive/loaders/asc.py +98 -0
oscura/automotive/loaders/blf.py +77 -0
oscura/automotive/loaders/csv_can.py +136 -0
oscura/automotive/loaders/dispatcher.py +136 -0
oscura/automotive/loaders/mdf.py +331 -0
oscura/automotive/loaders/pcap.py +132 -0
oscura/automotive/obd/__init__.py +14 -0
oscura/automotive/obd/decoder.py +707 -0
oscura/automotive/uds/__init__.py +48 -0
oscura/automotive/uds/decoder.py +265 -0
oscura/automotive/uds/models.py +64 -0
oscura/automotive/visualization.py +369 -0
oscura/batch/__init__.py +55 -0
oscura/batch/advanced.py +627 -0
oscura/batch/aggregate.py +300 -0
oscura/batch/analyze.py +139 -0
oscura/batch/logging.py +487 -0
oscura/batch/metrics.py +556 -0
oscura/builders/__init__.py +41 -0
oscura/builders/signal_builder.py +1131 -0
oscura/cli/__init__.py +14 -0
oscura/cli/batch.py +339 -0
oscura/cli/characterize.py +273 -0
oscura/cli/compare.py +775 -0
oscura/cli/decode.py +551 -0
oscura/cli/main.py +247 -0
oscura/cli/shell.py +350 -0
oscura/comparison/__init__.py +66 -0
oscura/comparison/compare.py +397 -0
oscura/comparison/golden.py +487 -0
oscura/comparison/limits.py +391 -0
oscura/comparison/mask.py +434 -0
oscura/comparison/trace_diff.py +30 -0
oscura/comparison/visualization.py +481 -0
oscura/compliance/__init__.py +70 -0
oscura/compliance/advanced.py +756 -0
oscura/compliance/masks.py +363 -0
oscura/compliance/reporting.py +483 -0
oscura/compliance/testing.py +298 -0
oscura/component/__init__.py +38 -0
oscura/component/impedance.py +365 -0
oscura/component/reactive.py +598 -0
oscura/component/transmission_line.py +312 -0
oscura/config/__init__.py +191 -0
oscura/config/defaults.py +254 -0
oscura/config/loader.py +348 -0
oscura/config/memory.py +271 -0
oscura/config/migration.py +458 -0
oscura/config/pipeline.py +1077 -0
oscura/config/preferences.py +530 -0
oscura/config/protocol.py +875 -0
oscura/config/schema.py +713 -0
oscura/config/settings.py +420 -0
oscura/config/thresholds.py +599 -0
oscura/convenience.py +457 -0
oscura/core/__init__.py +299 -0
oscura/core/audit.py +457 -0
oscura/core/backend_selector.py +405 -0
oscura/core/cache.py +590 -0
oscura/core/cancellation.py +439 -0
oscura/core/confidence.py +225 -0
oscura/core/config.py +506 -0
oscura/core/correlation.py +216 -0
oscura/core/cross_domain.py +422 -0
oscura/core/debug.py +301 -0
oscura/core/edge_cases.py +541 -0
oscura/core/exceptions.py +535 -0
oscura/core/gpu_backend.py +523 -0
oscura/core/lazy.py +832 -0
oscura/core/log_query.py +540 -0
oscura/core/logging.py +931 -0
oscura/core/logging_advanced.py +952 -0
oscura/core/memoize.py +171 -0
oscura/core/memory_check.py +274 -0
oscura/core/memory_guard.py +290 -0
oscura/core/memory_limits.py +336 -0
oscura/core/memory_monitor.py +453 -0
oscura/core/memory_progress.py +465 -0
oscura/core/memory_warnings.py +315 -0
oscura/core/numba_backend.py +362 -0
oscura/core/performance.py +352 -0
oscura/core/progress.py +524 -0
oscura/core/provenance.py +358 -0
oscura/core/results.py +331 -0
oscura/core/types.py +504 -0
oscura/core/uncertainty.py +383 -0
oscura/discovery/__init__.py +52 -0
oscura/discovery/anomaly_detector.py +672 -0
oscura/discovery/auto_decoder.py +415 -0
oscura/discovery/comparison.py +497 -0
oscura/discovery/quality_validator.py +528 -0
oscura/discovery/signal_detector.py +769 -0
oscura/dsl/__init__.py +73 -0
oscura/dsl/commands.py +246 -0
oscura/dsl/interpreter.py +455 -0
oscura/dsl/parser.py +689 -0
oscura/dsl/repl.py +172 -0
oscura/exceptions.py +59 -0
oscura/exploratory/__init__.py +111 -0
oscura/exploratory/error_recovery.py +642 -0
oscura/exploratory/fuzzy.py +513 -0
oscura/exploratory/fuzzy_advanced.py +786 -0
oscura/exploratory/legacy.py +831 -0
oscura/exploratory/parse.py +358 -0
oscura/exploratory/recovery.py +275 -0
oscura/exploratory/sync.py +382 -0
oscura/exploratory/unknown.py +707 -0
oscura/export/__init__.py +25 -0
oscura/export/wireshark/README.md +265 -0
oscura/export/wireshark/__init__.py +47 -0
oscura/export/wireshark/generator.py +312 -0
oscura/export/wireshark/lua_builder.py +159 -0
oscura/export/wireshark/templates/dissector.lua.j2 +92 -0
oscura/export/wireshark/type_mapping.py +165 -0
oscura/export/wireshark/validator.py +105 -0
oscura/exporters/__init__.py +94 -0
oscura/exporters/csv.py +303 -0
oscura/exporters/exporters.py +44 -0
oscura/exporters/hdf5.py +219 -0
oscura/exporters/html_export.py +701 -0
oscura/exporters/json_export.py +291 -0
oscura/exporters/markdown_export.py +367 -0
oscura/exporters/matlab_export.py +354 -0
oscura/exporters/npz_export.py +219 -0
oscura/exporters/spice_export.py +210 -0
oscura/extensibility/__init__.py +131 -0
oscura/extensibility/docs.py +752 -0
oscura/extensibility/extensions.py +1125 -0
oscura/extensibility/logging.py +259 -0
oscura/extensibility/measurements.py +485 -0
oscura/extensibility/plugins.py +414 -0
oscura/extensibility/registry.py +346 -0
oscura/extensibility/templates.py +913 -0
oscura/extensibility/validation.py +651 -0
oscura/filtering/__init__.py +89 -0
oscura/filtering/base.py +563 -0
oscura/filtering/convenience.py +564 -0
oscura/filtering/design.py +725 -0
oscura/filtering/filters.py +32 -0
oscura/filtering/introspection.py +605 -0
oscura/guidance/__init__.py +24 -0
oscura/guidance/recommender.py +429 -0
oscura/guidance/wizard.py +518 -0
oscura/inference/__init__.py +251 -0
oscura/inference/active_learning/README.md +153 -0
oscura/inference/active_learning/__init__.py +38 -0
oscura/inference/active_learning/lstar.py +257 -0
oscura/inference/active_learning/observation_table.py +230 -0
oscura/inference/active_learning/oracle.py +78 -0
oscura/inference/active_learning/teachers/__init__.py +15 -0
oscura/inference/active_learning/teachers/simulator.py +192 -0
oscura/inference/adaptive_tuning.py +453 -0
oscura/inference/alignment.py +653 -0
oscura/inference/bayesian.py +943 -0
oscura/inference/binary.py +1016 -0
oscura/inference/crc_reverse.py +711 -0
oscura/inference/logic.py +288 -0
oscura/inference/message_format.py +1305 -0
oscura/inference/protocol.py +417 -0
oscura/inference/protocol_dsl.py +1084 -0
oscura/inference/protocol_library.py +1230 -0
oscura/inference/sequences.py +809 -0
oscura/inference/signal_intelligence.py +1509 -0
oscura/inference/spectral.py +215 -0
oscura/inference/state_machine.py +634 -0
oscura/inference/stream.py +918 -0
oscura/integrations/__init__.py +59 -0
oscura/integrations/llm.py +1827 -0
oscura/jupyter/__init__.py +32 -0
oscura/jupyter/display.py +268 -0
oscura/jupyter/magic.py +334 -0
oscura/loaders/__init__.py +526 -0
oscura/loaders/binary.py +69 -0
oscura/loaders/configurable.py +1255 -0
oscura/loaders/csv.py +26 -0
oscura/loaders/csv_loader.py +473 -0
oscura/loaders/hdf5.py +9 -0
oscura/loaders/hdf5_loader.py +510 -0
oscura/loaders/lazy.py +370 -0
oscura/loaders/mmap_loader.py +583 -0
oscura/loaders/numpy_loader.py +436 -0
oscura/loaders/pcap.py +432 -0
oscura/loaders/preprocessing.py +368 -0
oscura/loaders/rigol.py +287 -0
oscura/loaders/sigrok.py +321 -0
oscura/loaders/tdms.py +367 -0
oscura/loaders/tektronix.py +711 -0
oscura/loaders/validation.py +584 -0
oscura/loaders/vcd.py +464 -0
oscura/loaders/wav.py +233 -0
oscura/math/__init__.py +45 -0
oscura/math/arithmetic.py +824 -0
oscura/math/interpolation.py +413 -0
oscura/onboarding/__init__.py +39 -0
oscura/onboarding/help.py +498 -0
oscura/onboarding/tutorials.py +405 -0
oscura/onboarding/wizard.py +466 -0
oscura/optimization/__init__.py +19 -0
oscura/optimization/parallel.py +440 -0
oscura/optimization/search.py +532 -0
oscura/pipeline/__init__.py +43 -0
oscura/pipeline/base.py +338 -0
oscura/pipeline/composition.py +242 -0
oscura/pipeline/parallel.py +448 -0
oscura/pipeline/pipeline.py +375 -0
oscura/pipeline/reverse_engineering.py +1119 -0
oscura/plugins/__init__.py +122 -0
oscura/plugins/base.py +272 -0
oscura/plugins/cli.py +497 -0
oscura/plugins/discovery.py +411 -0
oscura/plugins/isolation.py +418 -0
oscura/plugins/lifecycle.py +959 -0
oscura/plugins/manager.py +493 -0
oscura/plugins/registry.py +421 -0
oscura/plugins/versioning.py +372 -0
oscura/py.typed +0 -0
oscura/quality/__init__.py +65 -0
oscura/quality/ensemble.py +740 -0
oscura/quality/explainer.py +338 -0
oscura/quality/scoring.py +616 -0
oscura/quality/warnings.py +456 -0
oscura/reporting/__init__.py +248 -0
oscura/reporting/advanced.py +1234 -0
oscura/reporting/analyze.py +448 -0
oscura/reporting/argument_preparer.py +596 -0
oscura/reporting/auto_report.py +507 -0
oscura/reporting/batch.py +615 -0
oscura/reporting/chart_selection.py +223 -0
oscura/reporting/comparison.py +330 -0
oscura/reporting/config.py +615 -0
oscura/reporting/content/__init__.py +39 -0
oscura/reporting/content/executive.py +127 -0
oscura/reporting/content/filtering.py +191 -0
oscura/reporting/content/minimal.py +257 -0
oscura/reporting/content/verbosity.py +162 -0
oscura/reporting/core.py +508 -0
oscura/reporting/core_formats/__init__.py +17 -0
oscura/reporting/core_formats/multi_format.py +210 -0
oscura/reporting/engine.py +836 -0
oscura/reporting/export.py +366 -0
oscura/reporting/formatting/__init__.py +129 -0
oscura/reporting/formatting/emphasis.py +81 -0
oscura/reporting/formatting/numbers.py +403 -0
oscura/reporting/formatting/standards.py +55 -0
oscura/reporting/formatting.py +466 -0
oscura/reporting/html.py +578 -0
oscura/reporting/index.py +590 -0
oscura/reporting/multichannel.py +296 -0
oscura/reporting/output.py +379 -0
oscura/reporting/pdf.py +373 -0
oscura/reporting/plots.py +731 -0
oscura/reporting/pptx_export.py +360 -0
oscura/reporting/renderers/__init__.py +11 -0
oscura/reporting/renderers/pdf.py +94 -0
oscura/reporting/sections.py +471 -0
oscura/reporting/standards.py +680 -0
oscura/reporting/summary_generator.py +368 -0
oscura/reporting/tables.py +397 -0
oscura/reporting/template_system.py +724 -0
oscura/reporting/templates/__init__.py +15 -0
oscura/reporting/templates/definition.py +205 -0
oscura/reporting/templates/index.html +649 -0
oscura/reporting/templates/index.md +173 -0
oscura/schemas/__init__.py +158 -0
oscura/schemas/bus_configuration.json +322 -0
oscura/schemas/device_mapping.json +182 -0
oscura/schemas/packet_format.json +418 -0
oscura/schemas/protocol_definition.json +363 -0
oscura/search/__init__.py +16 -0
oscura/search/anomaly.py +292 -0
oscura/search/context.py +149 -0
oscura/search/pattern.py +160 -0
oscura/session/__init__.py +34 -0
oscura/session/annotations.py +289 -0
oscura/session/history.py +313 -0
oscura/session/session.py +445 -0
oscura/streaming/__init__.py +43 -0
oscura/streaming/chunked.py +611 -0
oscura/streaming/progressive.py +393 -0
oscura/streaming/realtime.py +622 -0
oscura/testing/__init__.py +54 -0
oscura/testing/synthetic.py +808 -0
oscura/triggering/__init__.py +68 -0
oscura/triggering/base.py +229 -0
oscura/triggering/edge.py +353 -0
oscura/triggering/pattern.py +344 -0
oscura/triggering/pulse.py +581 -0
oscura/triggering/window.py +453 -0
oscura/ui/__init__.py +48 -0
oscura/ui/formatters.py +526 -0
oscura/ui/progressive_display.py +340 -0
oscura/utils/__init__.py +99 -0
oscura/utils/autodetect.py +338 -0
oscura/utils/buffer.py +389 -0
oscura/utils/lazy.py +407 -0
oscura/utils/lazy_imports.py +147 -0
oscura/utils/memory.py +836 -0
oscura/utils/memory_advanced.py +1326 -0
oscura/utils/memory_extensions.py +465 -0
oscura/utils/progressive.py +352 -0
oscura/utils/windowing.py +362 -0
oscura/visualization/__init__.py +321 -0
oscura/visualization/accessibility.py +526 -0
oscura/visualization/annotations.py +374 -0
oscura/visualization/axis_scaling.py +305 -0
oscura/visualization/colors.py +453 -0
oscura/visualization/digital.py +337 -0
oscura/visualization/eye.py +420 -0
oscura/visualization/histogram.py +281 -0
oscura/visualization/interactive.py +858 -0
oscura/visualization/jitter.py +702 -0
oscura/visualization/keyboard.py +394 -0
oscura/visualization/layout.py +365 -0
oscura/visualization/optimization.py +1028 -0
oscura/visualization/palettes.py +446 -0
oscura/visualization/plot.py +92 -0
oscura/visualization/power.py +290 -0
oscura/visualization/power_extended.py +626 -0
oscura/visualization/presets.py +467 -0
oscura/visualization/protocols.py +932 -0
oscura/visualization/render.py +207 -0
oscura/visualization/rendering.py +444 -0
oscura/visualization/reverse_engineering.py +791 -0
oscura/visualization/signal_integrity.py +808 -0
oscura/visualization/specialized.py +553 -0
oscura/visualization/spectral.py +811 -0
oscura/visualization/styles.py +381 -0
oscura/visualization/thumbnails.py +311 -0
oscura/visualization/time_axis.py +351 -0
oscura/visualization/waveform.py +367 -0
oscura/workflow/__init__.py +13 -0
oscura/workflow/dag.py +377 -0
oscura/workflows/__init__.py +58 -0
oscura/workflows/compliance.py +280 -0
oscura/workflows/digital.py +272 -0
oscura/workflows/multi_trace.py +502 -0
oscura/workflows/power.py +178 -0
oscura/workflows/protocol.py +492 -0
oscura/workflows/reverse_engineering.py +639 -0
oscura/workflows/signal_integrity.py +227 -0
oscura-0.1.0.dist-info/METADATA +300 -0
oscura-0.1.0.dist-info/RECORD +463 -0
oscura-0.1.0.dist-info/entry_points.txt +2 -0
{oscura-0.0.1.dist-info → oscura-0.1.0.dist-info}/licenses/LICENSE +1 -1
oscura-0.0.1.dist-info/METADATA +0 -63
oscura-0.0.1.dist-info/RECORD +0 -5
{oscura-0.0.1.dist-info → oscura-0.1.0.dist-info}/WHEEL +0 -0

oscura/reporting/auto_report.py ADDED Viewed

@@ -0,0 +1,507 @@
+"""Automatic executive report generation.
+This module provides one-click generation of comprehensive analysis reports
+in multiple formats (PDF, HTML, Markdown).
+Example:
+    >>> from oscura.reporting import generate_report
+    >>> trace = load("capture.wfm")
+    >>> report = generate_report(trace)
+    >>> report.save_pdf("analysis_report.pdf")
+References:
+    TraceKit Auto-Discovery Specification
+"""
+from __future__ import annotations
+from dataclasses import dataclass, field
+from datetime import datetime
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+import numpy as np
+if TYPE_CHECKING:
+    from oscura.core.types import WaveformTrace
+@dataclass
+class ReportMetadata:
+    """Report metadata.
+    Attributes:
+        title: Report title.
+        author: Report author.
+        date: Report date.
+        project: Project name.
+        tags: List of tags.
+    """
+    title: str = "Signal Analysis Report"
+    author: str = "TraceKit"
+    date: str = field(default_factory=lambda: datetime.now().strftime("%Y-%m-%d"))
+    project: str | None = None
+    tags: list[str] = field(default_factory=list)
+@dataclass
+class Report:
+    """Executive analysis report.
+    Attributes:
+        sections: List of section names included.
+        plots: List of plot types included.
+        page_count: Estimated page count.
+        metadata: Report metadata.
+        content: Dictionary of section content.
+        output_path: Path to saved report.
+        file_size_mb: File size in MB (if saved).
+    """
+    sections: list[str] = field(default_factory=list)
+    plots: list[str] = field(default_factory=list)
+    page_count: int = 0
+    metadata: ReportMetadata = field(default_factory=ReportMetadata)
+    content: dict[str, str] = field(default_factory=dict)
+    output_path: str | None = None
+    file_size_mb: float = 0.0
+    def save_pdf(self, path: str) -> None:
+        """Save report as PDF.
+        Args:
+            path: Output file path.
+        Note:
+            This is a placeholder implementation. Full PDF generation
+            would require reportlab or similar library.
+        """
+        self.output_path = path
+        # Placeholder: would generate actual PDF here
+        with open(path, "w") as f:
+            f.write("PDF Report - Placeholder\n")
+            f.write(f"Title: {self.metadata.title}\n")
+            f.write(f"Date: {self.metadata.date}\n\n")
+            for section in self.sections:
+                if section in self.content:
+                    f.write(f"\n{section.upper()}\n")
+                    f.write("=" * 60 + "\n")
+                    f.write(self.content[section] + "\n")
+        # Estimate file size
+        self.file_size_mb = Path(path).stat().st_size / (1024 * 1024)
+    def save_html(self, path: str) -> None:
+        """Save report as HTML.
+        Args:
+            path: Output file path.
+        """
+        self.output_path = path
+        html_content = f"""<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>{self.metadata.title}</title>
+    <style>
+        body {{
+            font-family: Arial, sans-serif;
+            max-width: 900px;
+            margin: 0 auto;
+            padding: 20px;
+            line-height: 1.6;
+        }}
+        h1 {{
+            color: #2c3e50;
+            border-bottom: 3px solid #3498db;
+            padding-bottom: 10px;
+        }}
+        h2 {{
+            color: #34495e;
+            margin-top: 30px;
+            border-bottom: 2px solid #ecf0f1;
+            padding-bottom: 5px;
+        }}
+        .metadata {{
+            background-color: #ecf0f1;
+            padding: 15px;
+            border-radius: 5px;
+            margin-bottom: 20px;
+        }}
+        .section {{
+            margin-bottom: 30px;
+        }}
+        .critical {{
+            color: #e74c3c;
+            font-weight: bold;
+        }}
+        .warning {{
+            color: #f39c12;
+            font-weight: bold;
+        }}
+        .info {{
+            color: #3498db;
+        }}
+    </style>
+</head>
+<body>
+    <h1>{self.metadata.title}</h1>
+    <div class="metadata">
+        <p><strong>Date:</strong> {self.metadata.date}</p>
+        <p><strong>Author:</strong> {self.metadata.author}</p>
+"""
+        if self.metadata.project:
+            html_content += f"        <p><strong>Project:</strong> {self.metadata.project}</p>\n"
+        if self.metadata.tags:
+            html_content += (
+                f"        <p><strong>Tags:</strong> {', '.join(self.metadata.tags)}</p>\n"
+            )
+        html_content += "    </div>\n\n"
+        for section in self.sections:
+            if section in self.content:
+                section_title = section.replace("_", " ").title()
+                html_content += f"""    <div class="section">
+        <h2>{section_title}</h2>
+        <p>{self.content[section]}</p>
+    </div>
+"""
+        html_content += """</body>
+</html>"""
+        with open(path, "w") as f:
+            f.write(html_content)
+        self.file_size_mb = Path(path).stat().st_size / (1024 * 1024)
+    def save_markdown(self, path: str) -> None:
+        """Save report as Markdown.
+        Args:
+            path: Output file path.
+        """
+        self.output_path = path
+        md_content = f"# {self.metadata.title}\n\n"
+        md_content += f"**Date:** {self.metadata.date}  \n"
+        md_content += f"**Author:** {self.metadata.author}  \n"
+        if self.metadata.project:
+            md_content += f"**Project:** {self.metadata.project}  \n"
+        if self.metadata.tags:
+            md_content += f"**Tags:** {', '.join(self.metadata.tags)}  \n"
+        md_content += "\n---\n\n"
+        for section in self.sections:
+            if section in self.content:
+                section_title = section.replace("_", " ").title()
+                md_content += f"## {section_title}\n\n"
+                md_content += self.content[section] + "\n\n"
+        with open(path, "w") as f:
+            f.write(md_content)
+        self.file_size_mb = Path(path).stat().st_size / (1024 * 1024)
+    def add_section(
+        self,
+        title: str,
+        content: str,
+        position: int | None = None,
+    ) -> None:
+        """Add custom section to report.
+        Args:
+            title: Section title.
+            content: Section content.
+            position: Insert position (None = append).
+        """
+        section_key = title.lower().replace(" ", "_")
+        if position is None:
+            self.sections.append(section_key)
+        else:
+            self.sections.insert(position, section_key)
+        self.content[section_key] = content
+    def include_plots(self, plot_types: list[str]) -> None:
+        """Select which plots to include in report.
+        Args:
+            plot_types: List of plot type names.
+        """
+        self.plots = plot_types
+    def set_metadata(
+        self,
+        title: str | None = None,
+        author: str | None = None,
+        date: str | None = None,
+        project: str | None = None,
+        tags: list[str] | None = None,
+    ) -> None:
+        """Set report metadata.
+        Args:
+            title: Report title.
+            author: Report author.
+            date: Report date.
+            project: Project name.
+            tags: List of tags.
+        """
+        if title:
+            self.metadata.title = title
+        if author:
+            self.metadata.author = author
+        if date:
+            self.metadata.date = date
+        if project:
+            self.metadata.project = project
+        if tags:
+            self.metadata.tags = tags
+def _generate_executive_summary(trace: WaveformTrace, context: dict) -> str:  # type: ignore[type-arg]
+    """Generate executive summary section.
+    Args:
+        trace: Waveform to analyze.
+        context: Analysis context.
+    Returns:
+        Executive summary text (≤200 words).
+    """
+    sample_rate = trace.metadata.sample_rate
+    duration_ms = len(trace.data) / sample_rate * 1000
+    v_min = float(np.min(trace.data))
+    v_max = float(np.max(trace.data))
+    summary = "This report presents analysis of a signal capture taken at "
+    summary += f"{sample_rate / 1e6:.1f} MS/s sample rate over {duration_ms:.2f} milliseconds. "
+    summary += f"The signal ranges from {v_min:.3f}V to {v_max:.3f}V. "
+    # Add context-specific information
+    if "characterization" in context:
+        char = context["characterization"]
+        if hasattr(char, "signal_type"):
+            summary += f"The signal was identified as {char.signal_type}. "
+    if "quality" in context:
+        quality = context["quality"]
+        if hasattr(quality, "status"):
+            summary += f"Data quality assessment: {quality.status}. "
+    summary += "Detailed findings and recommendations are provided in the sections below."
+    return summary
+def _generate_key_findings(trace: WaveformTrace, context: dict) -> str:  # type: ignore[type-arg]
+    """Generate key findings section.
+    Args:
+        trace: Waveform to analyze.
+        context: Analysis context.
+    Returns:
+        Key findings text.
+    """
+    findings = []
+    # Basic signal characteristics
+    v_range = np.ptp(trace.data)
+    findings.append(f"Signal swing: {v_range:.3f}V")
+    # Add context-specific findings
+    if "anomalies" in context:
+        anomalies = context["anomalies"]
+        if hasattr(anomalies, "__len__"):
+            findings.append(f"Detected {len(anomalies)} anomalies in signal")
+    if "decode" in context:
+        decode = context["decode"]
+        if hasattr(decode, "data") and hasattr(decode.data, "__len__"):
+            findings.append(f"Successfully decoded {len(decode.data)} bytes")
+    # Format findings
+    findings_text = "Key findings from signal analysis:\n\n"
+    for i, finding in enumerate(findings, 1):
+        findings_text += f"{i}. {finding}\n"
+    return findings_text
+def _generate_methodology(trace: WaveformTrace, context: dict[str, Any]) -> str:
+    """Generate methodology section.
+    Args:
+        trace: Waveform to analyze.
+        context: Analysis context.
+    Returns:
+        Methodology description.
+    """
+    methodology = "Analysis methodology:\n\n"
+    methodology += "Signal characterization: Automated signal type detection using "
+    methodology += "statistical analysis and pattern recognition algorithms.\n\n"
+    methodology += "Quality assessment: Signal-to-noise ratio, clipping detection, "
+    methodology += "and sample rate validation.\n\n"
+    if "anomalies" in context:
+        methodology += "Anomaly detection: Automated detection of glitches, dropouts, "
+        methodology += "noise spikes, and timing violations.\n\n"
+    if "decode" in context:
+        methodology += "Protocol decode: Automatic parameter detection and "
+        methodology += "frame extraction with confidence scoring.\n\n"
+    return methodology
+def _generate_detailed_results(trace: WaveformTrace, context: dict[str, Any]) -> str:
+    """Generate detailed results section.
+    Args:
+        trace: Waveform to analyze.
+        context: Analysis context.
+    Returns:
+        Detailed results text.
+    """
+    results = "Detailed measurement results:\n\n"
+    # Basic statistics
+    data = trace.data.astype(np.float64)
+    results += f"Minimum voltage: {np.min(data):.6f}V\n"
+    results += f"Maximum voltage: {np.max(data):.6f}V\n"
+    results += f"Mean voltage: {np.mean(data):.6f}V\n"
+    results += f"Standard deviation: {np.std(data):.6f}V\n"
+    results += f"Peak-to-peak: {np.ptp(data):.6f}V\n\n"
+    # Sample info
+    results += f"Sample count: {len(data):,}\n"
+    results += f"Sample rate: {trace.metadata.sample_rate / 1e6:.3f} MS/s\n"
+    results += f"Duration: {len(data) / trace.metadata.sample_rate * 1000:.3f} ms\n\n"
+    return results
+def generate_report(
+    trace: WaveformTrace,
+    *,
+    format: str = "pdf",
+    template: str | None = None,
+    context: dict[str, Any] | None = None,
+    options: dict[str, Any] | None = None,
+) -> Report:
+    """Generate comprehensive executive analysis report.
+    Creates a professional report with executive summary, key findings,
+    methodology, and detailed results. Auto-includes relevant plots.
+    Args:
+        trace: Waveform to analyze.
+        format: Output format ("pdf", "html", "markdown").
+        template: Optional template file path.
+        context: Pre-computed analysis results (characterization, anomalies, etc.).
+        options: Report customization options:
+            - select_sections: List of sections to include
+            - custom_header: Custom header text
+            - custom_footer: Custom footer text
+            - page_orientation: "portrait" or "landscape"
+            - include_raw_data: Include raw data table
+            - plot_dpi: Plot resolution (default 300)
+    Returns:
+        Report object with content and save methods.
+    Example:
+        >>> report = generate_report(trace)
+        >>> report.save_pdf("analysis.pdf")
+        >>> print(f"Generated {report.page_count} page report")
+    References:
+        DISC-005: Automatic Executive Report
+    """
+    context = context or {}
+    options = options or {}
+    # Determine sections to include
+    default_sections = [
+        "executive_summary",
+        "key_findings",
+        "methodology",
+        "detailed_results",
+    ]
+    sections = options.get("select_sections", default_sections)
+    # Generate content for each section
+    content = {}
+    if "executive_summary" in sections or "summary" in sections:
+        content["executive_summary"] = _generate_executive_summary(trace, context)
+    if "key_findings" in sections or "findings" in sections:
+        content["key_findings"] = _generate_key_findings(trace, context)
+    if "methodology" in sections:
+        content["methodology"] = _generate_methodology(trace, context)
+    if "detailed_results" in sections or "results" in sections:
+        content["detailed_results"] = _generate_detailed_results(trace, context)
+    if "recommendations" in sections:
+        content["recommendations"] = (
+            "Recommendations based on analysis:\n\n"
+            "1. Signal quality is acceptable for analysis\n"
+            "2. Consider additional captures for verification\n"
+            "3. Review anomalies if present\n"
+        )
+    # Determine plot types to include
+    plot_types = options.get("plot_types", [])
+    if not plot_types:
+        # Auto-select based on signal characteristics
+        plot_types = ["time_domain_waveform"]
+        # Add spectral if signal looks periodic
+        if len(trace.data) > 100:
+            plot_types.append("fft_spectrum")
+    # Estimate page count (rough estimate)
+    page_count = 1  # Title page
+    page_count += len(sections)  # One page per section
+    page_count += (len(plot_types) + 1) // 2  # 2 plots per page
+    # Create report object
+    report = Report(
+        sections=list(sections),
+        plots=plot_types,
+        page_count=page_count,
+        content=content,
+    )
+    # Set custom metadata if provided
+    if "custom_header" in options:
+        report.metadata.title = options["custom_header"]
+    return report
+__all__ = [
+    "Report",
+    "ReportMetadata",
+    "generate_report",
+]

oscura 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl

oscura 0.0.1py3-none-any.whl → 0.1.0py3-none-any.whl