pyFDN.FDNPreset#

class pyFDN.FDNPreset(build, metadata, design=<factory>)[source]#

A baked vanilla FDN plus metadata and optional design information.

metadata is an open JSON object intended for catalog and attribution information. When used, tags should be a list of strings so callers can filter presets consistently without restricting other metadata fields.

design deliberately uses the same nested dictionaries as the JSON document. Unknown choices are represented by leaving out type or the entire component:

FDNPreset(
    build=build,
    metadata={"name": "small-room", "tags": ["room", "short"]},
    design={
        "delays": {"type": "uniform", "coprime": True},
        "feedback_matrix": {"type": "orthogonal"},
    },
)
__init__(build, metadata, design=<factory>)#

Methods

__init__(build, metadata[, design])

Attributes

build: FDNBuild#
design: dict[str, dict[str, Any]]#
metadata: dict[str, Any]#